Commit | Line | Data |
---|---|---|
4009494e GM |
1 | \input texinfo |
2 | @c %**start of header | |
db78a8cb | 3 | @setfilename ../../info/org |
a7808fba | 4 | @settitle The Org Manual |
4009494e | 5 | |
72d803ad | 6 | @set VERSION 6.33x |
a351880d | 7 | @set DATE November 2009 |
4009494e | 8 | |
4009494e | 9 | @c Version and Contact Info |
dbc28aaa | 10 | @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage} |
4009494e GM |
11 | @set AUTHOR Carsten Dominik |
12 | @set MAINTAINER Carsten Dominik | |
dbc28aaa CD |
13 | @set MAINTAINEREMAIL @email{carsten at orgmode dot org} |
14 | @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer} | |
4009494e GM |
15 | @c %**end of header |
16 | @finalout | |
17 | ||
18 | @c Macro definitions | |
c8d0cf5c CD |
19 | @iftex |
20 | @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed} | |
21 | @end iftex | |
22 | @macro Ie {} | |
23 | I.e., | |
24 | @end macro | |
25 | @macro ie {} | |
26 | i.e., | |
27 | @end macro | |
28 | @macro Eg {} | |
29 | E.g., | |
30 | @end macro | |
31 | @macro eg {} | |
32 | e.g., | |
33 | @end macro | |
4009494e GM |
34 | |
35 | @c Subheadings inside a table. | |
36 | @macro tsubheading{text} | |
37 | @ifinfo | |
38 | @subsubheading \text\ | |
39 | @end ifinfo | |
40 | @ifnotinfo | |
41 | @item @b{\text\} | |
42 | @end ifnotinfo | |
43 | @end macro | |
44 | ||
45 | @copying | |
c8d0cf5c | 46 | This manual is for Org version @value{VERSION}. |
4009494e | 47 | |
49f70d46 GM |
48 | Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 |
49 | Free Software Foundation, Inc. | |
4009494e GM |
50 | |
51 | @quotation | |
52 | Permission is granted to copy, distribute and/or modify this document | |
d60b1ba1 | 53 | under the terms of the GNU Free Documentation License, Version 1.3 or |
4009494e GM |
54 | any later version published by the Free Software Foundation; with no |
55 | Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' | |
47271179 GM |
56 | and with the Back-Cover Texts as in (a) below. A copy of the license |
57 | is included in the section entitled ``GNU Free Documentation License.'' | |
4009494e | 58 | |
6f093307 GM |
59 | (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and |
60 | modify this GNU manual. Buying copies from the FSF supports it in | |
61 | developing GNU and promoting software freedom.'' | |
5b14aca9 GM |
62 | |
63 | This document is part of a collection distributed under the GNU Free | |
64 | Documentation License. If you want to distribute this document | |
65 | separately from the collection, you can do so by adding a copy of the | |
66 | license to the document, as described in section 6 of the license. | |
4009494e GM |
67 | @end quotation |
68 | @end copying | |
69 | ||
0c973505 | 70 | @dircategory Emacs editing modes |
5dc584b5 | 71 | @direntry |
62e034c2 | 72 | * Org Mode: (org). Outline-based notes management and organizer. |
5dc584b5 KB |
73 | @end direntry |
74 | ||
4009494e | 75 | @titlepage |
a7808fba | 76 | @title The Org Manual |
4009494e GM |
77 | |
78 | @subtitle Release @value{VERSION} | |
79 | @author by Carsten Dominik | |
80 | ||
81 | @c The following two commands start the copyright page. | |
82 | @page | |
83 | @vskip 0pt plus 1filll | |
84 | @insertcopying | |
85 | @end titlepage | |
86 | ||
87 | @c Output the table of contents at the beginning. | |
88 | @contents | |
89 | ||
90 | @ifnottex | |
91 | @node Top, Introduction, (dir), (dir) | |
92 | @top Org Mode Manual | |
93 | ||
94 | @insertcopying | |
95 | @end ifnottex | |
96 | ||
97 | @menu | |
98 | * Introduction:: Getting started | |
a7808fba | 99 | * Document Structure:: A tree works like your brain |
4009494e GM |
100 | * Tables:: Pure magic for quick formatting |
101 | * Hyperlinks:: Notes in context | |
a7808fba | 102 | * TODO Items:: Every tree branch can be a TODO item |
4009494e | 103 | * Tags:: Tagging headlines and matching sets of tags |
a7808fba CD |
104 | * Properties and Columns:: Storing information about an entry |
105 | * Dates and Times:: Making items useful for planning | |
a351880d | 106 | * Capture - Refile - Archive:: The ins and outs for projects |
a7808fba | 107 | * Agenda Views:: Collecting information into views |
a351880d | 108 | * Markup:: Prepare text for rich export |
4009494e | 109 | * Exporting:: Sharing and publishing of notes |
a7808fba | 110 | * Publishing:: Create a web site of linked Org files |
4009494e | 111 | * Miscellaneous:: All the rest which did not fit elsewhere |
a50253cc | 112 | * Hacking:: How to hack your way around |
7006d207 | 113 | * MobileOrg:: Viewing and capture on a mobile device |
a7808fba CD |
114 | * History and Acknowledgments:: How Org came into being |
115 | * Main Index:: An index of Org's concepts and features | |
4009494e | 116 | * Key Index:: Key bindings and where they are described |
c8d0cf5c | 117 | * Variable Index:: Variables mentioned in the manual |
4009494e GM |
118 | |
119 | @detailmenu | |
120 | --- The Detailed Node Listing --- | |
121 | ||
122 | Introduction | |
123 | ||
a7808fba CD |
124 | * Summary:: Brief summary of what Org does |
125 | * Installation:: How to install a downloaded version of Org | |
126 | * Activation:: How to activate Org for certain buffers | |
4009494e | 127 | * Feedback:: Bug reports, ideas, patches etc. |
dbc28aaa | 128 | * Conventions:: Type-setting conventions in the manual |
4009494e GM |
129 | |
130 | Document Structure | |
131 | ||
a7808fba CD |
132 | * Outlines:: Org is based on Outline mode |
133 | * Headlines:: How to typeset Org tree headlines | |
4009494e GM |
134 | * Visibility cycling:: Show and hide, much simplified |
135 | * Motion:: Jumping to other headlines | |
136 | * Structure editing:: Changing sequence and level of headlines | |
4009494e GM |
137 | * Sparse trees:: Matches embedded in context |
138 | * Plain lists:: Additional structure within an entry | |
139 | * Drawers:: Tucking stuff away | |
c8d0cf5c | 140 | * Blocks:: Folding blocks |
55e0839d | 141 | * Footnotes:: How footnotes are defined in Org's syntax |
a7808fba | 142 | * Orgstruct mode:: Structure editing outside Org |
4009494e | 143 | |
4009494e GM |
144 | Tables |
145 | ||
146 | * Built-in table editor:: Simple tables | |
c8d0cf5c | 147 | * Column width and alignment:: Overrule the automatic settings |
4009494e | 148 | * Column groups:: Grouping to trigger vertical lines |
a7808fba CD |
149 | * Orgtbl mode:: The table editor as minor mode |
150 | * The spreadsheet:: The table editor has spreadsheet capabilities | |
c8d0cf5c | 151 | * Org-Plot:: Plotting from org tables |
4009494e GM |
152 | |
153 | The spreadsheet | |
154 | ||
155 | * References:: How to refer to another field or range | |
156 | * Formula syntax for Calc:: Using Calc to compute stuff | |
157 | * Formula syntax for Lisp:: Writing formulas in Emacs Lisp | |
158 | * Field formulas:: Formulas valid for a single field | |
159 | * Column formulas:: Formulas valid for an entire column | |
160 | * Editing and debugging formulas:: Fixing formulas | |
161 | * Updating the table:: Recomputing all dependent fields | |
162 | * Advanced features:: Field names, parameters and automatic recalc | |
163 | ||
164 | Hyperlinks | |
165 | ||
a7808fba | 166 | * Link format:: How links in Org are formatted |
4009494e GM |
167 | * Internal links:: Links to other places in the current file |
168 | * External links:: URL-like links to the world | |
169 | * Handling links:: Creating, inserting and following | |
a7808fba | 170 | * Using links outside Org:: Linking from my C source code? |
4009494e GM |
171 | * Link abbreviations:: Shortcuts for writing complex links |
172 | * Search options:: Linking to a specific location | |
173 | * Custom searches:: When the default search is not enough | |
4009494e GM |
174 | |
175 | Internal links | |
176 | ||
a7808fba | 177 | * Radio targets:: Make targets trigger links in plain text |
4009494e | 178 | |
a7808fba | 179 | TODO Items |
4009494e GM |
180 | |
181 | * TODO basics:: Marking and displaying TODO entries | |
182 | * TODO extensions:: Workflow and assignments | |
dbc28aaa | 183 | * Progress logging:: Dates and notes for progress |
4009494e GM |
184 | * Priorities:: Some things are more important than others |
185 | * Breaking down tasks:: Splitting a task into manageable pieces | |
186 | * Checkboxes:: Tick-off lists | |
187 | ||
188 | Extended use of TODO keywords | |
189 | ||
190 | * Workflow states:: From TODO to DONE in steps | |
dbc28aaa | 191 | * TODO types:: I do this, Fred does the rest |
4009494e | 192 | * Multiple sets in one file:: Mixing it all, and still finding your way |
dbc28aaa CD |
193 | * Fast access to TODO states:: Single letter selection of a state |
194 | * Per-file keywords:: Different files, different requirements | |
195 | * Faces for TODO keywords:: Highlighting states | |
ec712abb | 196 | * TODO dependencies:: When one task needs to wait for others |
dbc28aaa | 197 | |
a7808fba | 198 | Progress logging |
dbc28aaa CD |
199 | |
200 | * Closing items:: When was this entry marked DONE? | |
201 | * Tracking TODO state changes:: When did the status change? | |
a351880d | 202 | * Tracking your habits:: How consistent have you been? |
4009494e GM |
203 | |
204 | Tags | |
205 | ||
206 | * Tag inheritance:: Tags use the tree structure of the outline | |
207 | * Setting tags:: How to assign tags to a headline | |
208 | * Tag searches:: Searching for combinations of tags | |
209 | ||
210 | Properties and Columns | |
211 | ||
212 | * Property syntax:: How properties are spelled out | |
a7808fba | 213 | * Special properties:: Access to other Org mode features |
4009494e | 214 | * Property searches:: Matching property values |
dbc28aaa | 215 | * Property inheritance:: Passing values down the tree |
4009494e GM |
216 | * Column view:: Tabular viewing and editing |
217 | * Property API:: Properties for Lisp programmers | |
218 | ||
a7808fba | 219 | Column view |
4009494e GM |
220 | |
221 | * Defining columns:: The COLUMNS format property | |
222 | * Using column view:: How to create and use column view | |
a7808fba | 223 | * Capturing column view:: A dynamic block for column view |
4009494e | 224 | |
a7808fba | 225 | Defining columns |
4009494e GM |
226 | |
227 | * Scope of column definitions:: Where defined, where valid? | |
228 | * Column attributes:: Appearance and content of a column | |
229 | ||
dbc28aaa | 230 | Dates and Times |
4009494e | 231 | |
a7808fba | 232 | * Timestamps:: Assigning a time to a tree entry |
4009494e GM |
233 | * Creating timestamps:: Commands which insert timestamps |
234 | * Deadlines and scheduling:: Planning your work | |
a7808fba | 235 | * Clocking work time:: Tracking how long you spend on a task |
a351880d | 236 | * Resolving idle time:: Resolving time if you've been idle |
a7808fba | 237 | * Effort estimates:: Planning work effort in advance |
96c8522a | 238 | * Relative timer:: Notes with a running timer |
4009494e GM |
239 | |
240 | Creating timestamps | |
241 | ||
a7808fba CD |
242 | * The date/time prompt:: How Org mode helps you entering date and time |
243 | * Custom time format:: Making dates look different | |
4009494e | 244 | |
a7808fba | 245 | Deadlines and scheduling |
4009494e GM |
246 | |
247 | * Inserting deadline/schedule:: Planning items | |
248 | * Repeated tasks:: Items that show up again and again | |
249 | ||
a351880d | 250 | Capture - Refile - Archive |
864c9740 CD |
251 | |
252 | * Remember:: Capture new tasks/ideas with little interruption | |
253 | * Attachments:: Add files to tasks. | |
c8d0cf5c | 254 | * RSS Feeds:: Getting input from RSS feeds |
a351880d CD |
255 | * Protocols:: External (e.g. Browser) access to Emacs and Org |
256 | * Refiling notes:: Moving a tree from one place to another | |
257 | * Archiving:: What to do with finished projects | |
864c9740 | 258 | |
dbc28aaa | 259 | Remember |
4009494e | 260 | |
7006d207 | 261 | * Setting up Remember for Org:: Some code for .emacs to get things going |
dbc28aaa CD |
262 | * Remember templates:: Define the outline of different note types |
263 | * Storing notes:: Directly get the note to where it belongs | |
a351880d CD |
264 | |
265 | Archiving | |
266 | ||
267 | * Moving subtrees:: Moving a tree to an archive file | |
268 | * Internal archiving:: Switch off a tree but keep i in the file | |
4009494e GM |
269 | |
270 | Agenda Views | |
271 | ||
272 | * Agenda files:: Files being searched for agenda information | |
273 | * Agenda dispatcher:: Keyboard access to agenda views | |
274 | * Built-in agenda views:: What is available out of the box? | |
275 | * Presentation and sorting:: How agenda items are prepared for display | |
a7808fba | 276 | * Agenda commands:: Remote editing of Org trees |
4009494e | 277 | * Custom agenda views:: Defining special searches and views |
7006d207 | 278 | * Exporting Agenda Views:: Writing a view to a file |
a7808fba | 279 | * Agenda column view:: Using column view for collected entries |
4009494e GM |
280 | |
281 | The built-in agenda views | |
282 | ||
a7808fba | 283 | * Weekly/daily agenda:: The calendar page with current tasks |
4009494e GM |
284 | * Global TODO list:: All unfinished action items |
285 | * Matching tags and properties:: Structured information with fine-tuned search | |
286 | * Timeline:: Time-sorted view for single file | |
a351880d | 287 | * Search view:: Find entries by searching for text |
4009494e GM |
288 | * Stuck projects:: Find projects you need to review |
289 | ||
290 | Presentation and sorting | |
291 | ||
292 | * Categories:: Not all tasks are equal | |
293 | * Time-of-day specifications:: How the agenda knows the time | |
294 | * Sorting of agenda items:: The order of things | |
295 | ||
296 | Custom agenda views | |
297 | ||
298 | * Storing searches:: Type once, use often | |
299 | * Block agenda:: All the stuff you need in a single buffer | |
300 | * Setting Options:: Changing the rules | |
4009494e | 301 | |
a351880d CD |
302 | Markup for rich export |
303 | ||
304 | * Structural markup elements:: The basic structure as seen by the exporter | |
305 | * Images and tables:: Tables and Images will be included | |
306 | * Literal examples:: Source code examples with special formatting | |
307 | * Include files:: Include additional files into a document | |
308 | * Macro replacement:: Use macros to create complex output | |
309 | * Embedded LaTeX:: LaTeX can be freely used inside Org documents | |
310 | ||
311 | Structural markup elements | |
312 | ||
313 | * Document title:: Where the title is taken from | |
314 | * Headings and sections:: The document structure as seen by the exporter | |
315 | * Table of contents:: The if and where of the table of contents | |
316 | * Initial text:: Text before the first heading? | |
317 | * Lists:: Lists | |
318 | * Paragraphs:: Paragraphs | |
319 | * Footnote markup:: Footnotes | |
320 | * Emphasis and monospace:: Bold, italic, etc. | |
321 | * Horizontal rules:: Make a line | |
322 | * Comment lines:: What will *not* be exported | |
323 | ||
c8d0cf5c | 324 | Embedded La@TeX{} |
4009494e | 325 | |
a351880d | 326 | * Special symbols:: Greek letters and other symbols |
a7808fba | 327 | * Subscripts and superscripts:: Simple syntax for raising/lowering text |
4009494e | 328 | * LaTeX fragments:: Complex formulas made easy |
a351880d | 329 | * Previewing LaTeX fragments:: What will this snippet look like? |
4009494e GM |
330 | * CDLaTeX mode:: Speed up entering of formulas |
331 | ||
332 | Exporting | |
333 | ||
864c9740 | 334 | * Selective export:: Using tags to select and exclude trees |
b349f79f CD |
335 | * Export options:: Per-file export settings |
336 | * The export dispatcher:: How to access exporter commands | |
4009494e GM |
337 | * ASCII export:: Exporting to plain ASCII |
338 | * HTML export:: Exporting to HTML | |
c8d0cf5c CD |
339 | * LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF |
340 | * DocBook export:: Exporting to DocBook | |
a351880d | 341 | * Freemind export:: Exporting to Freemind mind maps |
4009494e GM |
342 | * XOXO export:: Exporting to XOXO |
343 | * iCalendar export:: Exporting in iCalendar format | |
b349f79f | 344 | |
4009494e GM |
345 | HTML export |
346 | ||
b349f79f | 347 | * HTML Export commands:: How to invoke HTML export |
a7808fba | 348 | * Quoting HTML tags:: Using direct HTML in Org mode |
a351880d | 349 | * Links in HTML export:: How links will be interpreted and formatted |
c8d0cf5c | 350 | * Tables in HTML export:: How to modify the formatting of tables |
55e0839d CD |
351 | * Images in HTML export:: How to insert figures into HTML output |
352 | * Text areas in HTML export:: An alternative way to show an example | |
a7808fba CD |
353 | * CSS support:: Changing the appearance of the output |
354 | * Javascript support:: Info and Folding in a web browser | |
4009494e | 355 | |
c8d0cf5c | 356 | La@TeX{} and PDF export |
4009494e | 357 | |
a50253cc | 358 | * LaTeX/PDF export commands:: Which key invokes which commands |
c8d0cf5c CD |
359 | * Quoting LaTeX code:: Incorporating literal La@TeX{} code |
360 | * Sectioning structure:: Changing sectioning in La@TeX{} output | |
361 | * Tables in LaTeX export:: Options for exporting tables to La@TeX{} | |
362 | * Images in LaTeX export:: How to insert figures into La@TeX{} output | |
363 | ||
364 | DocBook export | |
365 | ||
366 | * DocBook export commands:: How to invoke DocBook export | |
367 | * Quoting DocBook code:: Incorporating DocBook code in Org files | |
368 | * Recursive sections:: Recursive sections in DocBook | |
369 | * Tables in DocBook export:: Tables are exported as HTML tables | |
370 | * Images in DocBook export:: How to insert figures into DocBook output | |
371 | * Special characters:: How to handle special characters | |
4009494e | 372 | |
4009494e GM |
373 | Publishing |
374 | ||
375 | * Configuration:: Defining projects | |
c8d0cf5c | 376 | * Uploading files:: How to get files up on the server |
4009494e GM |
377 | * Sample configuration:: Example projects |
378 | * Triggering publication:: Publication commands | |
379 | ||
380 | Configuration | |
381 | ||
382 | * Project alist:: The central configuration variable | |
383 | * Sources and destinations:: From here to there | |
384 | * Selecting files:: What files are part of the project? | |
385 | * Publishing action:: Setting the function doing the publishing | |
386 | * Publishing options:: Tweaking HTML export | |
387 | * Publishing links:: Which links keep working after publishing? | |
388 | * Project page index:: Publishing a list of project files | |
389 | ||
390 | Sample configuration | |
391 | ||
392 | * Simple example:: One-component publishing | |
393 | * Complex example:: A multi-component publishing example | |
394 | ||
395 | Miscellaneous | |
396 | ||
397 | * Completion:: M-TAB knows what you need | |
17673adf | 398 | * Speed keys:: Electic commands at the beginning of a headline |
a7808fba | 399 | * Customization:: Adapting Org to your taste |
4009494e GM |
400 | * In-buffer settings:: Overview of the #+KEYWORDS |
401 | * The very busy C-c C-c key:: When in doubt, press C-c C-c | |
402 | * Clean view:: Getting rid of leading stars in the outline | |
a7808fba | 403 | * TTY keys:: Using Org on a tty |
4009494e | 404 | * Interaction:: Other Emacs packages |
4009494e GM |
405 | |
406 | Interaction with other packages | |
407 | ||
a7808fba | 408 | * Cooperation:: Packages Org cooperates with |
4009494e GM |
409 | * Conflicts:: Packages that lead to conflicts |
410 | ||
b349f79f | 411 | Hacking |
4009494e | 412 | |
c8d0cf5c CD |
413 | * Hooks:: Who to reach into Org's internals |
414 | * Add-on packages:: Available extensions | |
4009494e | 415 | * Adding hyperlink types:: New custom link types |
c8d0cf5c CD |
416 | * Context-sensitive commands:: How to add functionality to such commands |
417 | * Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs | |
4009494e GM |
418 | * Dynamic blocks:: Automatically filled blocks |
419 | * Special agenda views:: Customized views | |
c8d0cf5c | 420 | * Extracting agenda information:: Postprocessing of agenda information |
4009494e | 421 | * Using the property API:: Writing programs that use entry properties |
b349f79f | 422 | * Using the mapping API:: Mapping over all or selected entries |
4009494e | 423 | |
a7808fba | 424 | Tables and lists in arbitrary syntax |
4009494e | 425 | |
6eb02347 | 426 | * Radio tables:: Sending and receiving radio tables |
4009494e GM |
427 | * A LaTeX example:: Step by step, almost a tutorial |
428 | * Translator functions:: Copy and modify | |
a7808fba | 429 | * Radio lists:: Doing the same for lists |
4009494e | 430 | |
7006d207 CD |
431 | MobileOrg |
432 | ||
433 | * Setting up the staging area:: Where to interact with the mobile device | |
434 | * Pushing to MobileOrg:: Uploading Org files and agendas | |
435 | * Pulling from MobileOrg:: Integrating captured and flagged items | |
436 | ||
4009494e GM |
437 | @end detailmenu |
438 | @end menu | |
439 | ||
a7808fba | 440 | @node Introduction, Document Structure, Top, Top |
4009494e GM |
441 | @chapter Introduction |
442 | @cindex introduction | |
443 | ||
444 | @menu | |
a7808fba CD |
445 | * Summary:: Brief summary of what Org does |
446 | * Installation:: How to install a downloaded version of Org | |
447 | * Activation:: How to activate Org for certain buffers | |
4009494e | 448 | * Feedback:: Bug reports, ideas, patches etc. |
dbc28aaa | 449 | * Conventions:: Type-setting conventions in the manual |
4009494e GM |
450 | @end menu |
451 | ||
452 | @node Summary, Installation, Introduction, Introduction | |
453 | @section Summary | |
454 | @cindex summary | |
455 | ||
a7808fba | 456 | Org is a mode for keeping notes, maintaining TODO lists, and doing |
4009494e GM |
457 | project planning with a fast and effective plain-text system. |
458 | ||
a7808fba CD |
459 | Org develops organizational tasks around NOTES files that contain |
460 | lists or information about projects as plain text. Org is | |
461 | implemented on top of Outline mode, which makes it possible to keep the | |
4009494e GM |
462 | content of large files well structured. Visibility cycling and |
463 | structure editing help to work with the tree. Tables are easily created | |
a7808fba | 464 | with a built-in table editor. Org supports TODO items, deadlines, |
c8d0cf5c | 465 | timestamps, and scheduling. It dynamically compiles entries into an |
4009494e GM |
466 | agenda that utilizes and smoothly integrates much of the Emacs calendar |
467 | and diary. Plain text URL-like links connect to websites, emails, | |
468 | Usenet messages, BBDB entries, and any files related to the projects. | |
a7808fba | 469 | For printing and sharing of notes, an Org file can be exported as a |
dbc28aaa | 470 | structured ASCII file, as HTML, or (TODO and agenda items only) as an |
4009494e | 471 | iCalendar file. It can also serve as a publishing tool for a set of |
a7808fba | 472 | linked web pages. |
4009494e | 473 | |
c8d0cf5c CD |
474 | An important design aspect that distinguishes Org from, for example, |
475 | Planner/Muse is that it encourages you to store every piece of information | |
4009494e | 476 | only once. In Planner, you have project pages, day pages and possibly |
a7808fba | 477 | other files, duplicating some information such as tasks. In Org, |
c8d0cf5c CD |
478 | you only have notes files. In your notes you mark entries as tasks, and |
479 | label them with tags and timestamps. All necessary lists, like a | |
4009494e | 480 | schedule for the day, the agenda for a meeting, tasks lists selected by |
c8d0cf5c | 481 | tags, etc., are created dynamically when you need them. |
4009494e | 482 | |
a7808fba | 483 | Org keeps simple things simple. When first fired up, it should |
4009494e GM |
484 | feel like a straightforward, easy to use outliner. Complexity is not |
485 | imposed, but a large amount of functionality is available when you need | |
a7808fba | 486 | it. Org is a toolbox and can be used in different ways, for |
4009494e GM |
487 | example as: |
488 | ||
489 | @example | |
c8d0cf5c CD |
490 | @r{@bullet{} an outline extension with visibility cycling and structure editing} |
491 | @r{@bullet{} an ASCII system and table editor for taking structured notes} | |
492 | @r{@bullet{} an ASCII table editor with spreadsheet-like capabilities} | |
493 | @r{@bullet{} a TODO list editor} | |
494 | @r{@bullet{} a full agenda and planner with deadlines and work scheduling} | |
495 | @pindex GTD, Getting Things Done | |
496 | @r{@bullet{} an environment to implement David Allen's GTD system} | |
4009494e | 497 | @r{@bullet{} a basic database application} |
c8d0cf5c CD |
498 | @r{@bullet{} a simple hypertext system, with HTML and La@TeX{} export} |
499 | @r{@bullet{} a publishing tool to create a set of interlinked webpages} | |
4009494e GM |
500 | @end example |
501 | ||
c8d0cf5c | 502 | Org's automatic, context-sensitive table editor with spreadsheet |
4009494e | 503 | capabilities can be integrated into any major mode by activating the |
a7808fba | 504 | minor Orgtbl mode. Using a translation step, it can be used to maintain |
4009494e | 505 | tables in arbitrary file types, for example in La@TeX{}. The structure |
a7808fba CD |
506 | editing and list creation capabilities can be used outside Org with |
507 | the minor Orgstruct mode. | |
4009494e GM |
508 | |
509 | @cindex FAQ | |
a7808fba CD |
510 | There is a website for Org which provides links to the newest |
511 | version of Org, as well as additional information, frequently asked | |
c8d0cf5c | 512 | questions (FAQ), links to tutorials, etc@. This page is located at |
dbc28aaa | 513 | @uref{http://orgmode.org}. |
4009494e GM |
514 | |
515 | @page | |
516 | ||
517 | ||
518 | @node Installation, Activation, Summary, Introduction | |
519 | @section Installation | |
520 | @cindex installation | |
521 | @cindex XEmacs | |
522 | ||
7006d207 CD |
523 | @b{Important:} @i{If you are using a version of Org that is part of the Emacs |
524 | distribution or an XEmacs package, please skip this section and go directly | |
525 | to @ref{Activation}.} | |
4009494e | 526 | |
a7808fba | 527 | If you have downloaded Org from the Web, either as a distribution @file{.zip} |
c8d0cf5c CD |
528 | or @file{.tar} file, or as a Git archive, you must take the following steps |
529 | to install it: go into the unpacked Org distribution directory and edit the | |
a7808fba CD |
530 | top section of the file @file{Makefile}. You must set the name of the Emacs |
531 | binary (likely either @file{emacs} or @file{xemacs}), and the paths to the | |
532 | directories where local Lisp and Info files are kept. If you don't have | |
533 | access to the system-wide directories, you can simply run Org directly from | |
534 | the distribution directory by adding the @file{lisp} subdirectory to the | |
535 | Emacs load path. To do this, add the following line to @file{.emacs}: | |
4009494e GM |
536 | |
537 | @example | |
a7808fba CD |
538 | (setq load-path (cons "~/path/to/orgdir/lisp" load-path)) |
539 | @end example | |
540 | ||
541 | @noindent | |
542 | If you plan to use code from the @file{contrib} subdirectory, do a similar | |
543 | step for this directory: | |
544 | ||
545 | @example | |
546 | (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path)) | |
4009494e GM |
547 | @end example |
548 | ||
7006d207 CD |
549 | @sp 2 |
550 | @cartouche | |
551 | XEmacs users now need to install the file @file{noutline.el} from | |
a7808fba | 552 | the @file{xemacs} sub-directory of the Org distribution. Use the |
7006d207 | 553 | command: |
4009494e GM |
554 | |
555 | @example | |
7006d207 | 556 | make install-noutline |
4009494e | 557 | @end example |
7006d207 CD |
558 | @end cartouche |
559 | @sp 2 | |
4009494e | 560 | |
a7808fba | 561 | @noindent Now byte-compile the Lisp files with the shell command: |
4009494e GM |
562 | |
563 | @example | |
564 | make | |
4009494e GM |
565 | @end example |
566 | ||
a7808fba | 567 | @noindent If you are running Org from the distribution directory, this is |
c8d0cf5c CD |
568 | all. If you want to install Org into the system directories, use (as |
569 | administrator) | |
4009494e GM |
570 | |
571 | @example | |
a7808fba | 572 | make install |
c8d0cf5c CD |
573 | @end example |
574 | ||
575 | Installing Info files is system dependent, because of differences in the | |
576 | @file{install-info} program. In Debian it copies the info files into the | |
577 | correct directory and modifies the info directory file. In many other | |
578 | systems, the files need to be copied to the correct directory separately, and | |
579 | @file{install-info} then only modifies the directory file. Check your system | |
580 | documentation to find out which of the following commands you need: | |
581 | ||
582 | @example | |
4009494e | 583 | make install-info |
c8d0cf5c | 584 | make install-info-debian |
4009494e GM |
585 | @end example |
586 | ||
7006d207 CD |
587 | Then add the following line to @file{.emacs}. It is needed so that |
588 | Emacs can autoload functions that are located in files not immediately loaded | |
589 | when Org-mode starts. | |
4009494e | 590 | @lisp |
4009494e GM |
591 | (require 'org-install) |
592 | @end lisp | |
593 | ||
55e0839d | 594 | Do not forget to activate Org as described in the following section. |
7006d207 | 595 | @page |
a7808fba | 596 | |
4009494e GM |
597 | @node Activation, Feedback, Installation, Introduction |
598 | @section Activation | |
599 | @cindex activation | |
600 | @cindex autoload | |
a7808fba CD |
601 | @cindex global key bindings |
602 | @cindex key bindings, global | |
4009494e GM |
603 | |
604 | @iftex | |
c8d0cf5c CD |
605 | @b{Important:} @i{If you use copy-and-paste to copy Lisp code from the |
606 | PDF documentation as viewed by some PDF viewers to your @file{.emacs} file, the | |
607 | single-quote character comes out incorrectly and the code will not work. | |
608 | You need to fix the single-quotes by hand, or copy from Info | |
4009494e GM |
609 | documentation.} |
610 | @end iftex | |
611 | ||
71d35b24 | 612 | Add the following lines to your @file{.emacs} file. The last three lines |
a7808fba | 613 | define @emph{global} keys for the commands @command{org-store-link}, |
c8d0cf5c | 614 | @command{org-agenda}, and @command{org-iswitchb}---please choose suitable |
a7808fba | 615 | keys yourself. |
4009494e GM |
616 | |
617 | @lisp | |
618 | ;; The following lines are always needed. Choose your own keys. | |
619 | (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode)) | |
620 | (global-set-key "\C-cl" 'org-store-link) | |
621 | (global-set-key "\C-ca" 'org-agenda) | |
a7808fba | 622 | (global-set-key "\C-cb" 'org-iswitchb) |
4009494e GM |
623 | @end lisp |
624 | ||
a7808fba | 625 | Furthermore, you must activate @code{font-lock-mode} in Org |
4009494e GM |
626 | buffers, because significant functionality depends on font-locking being |
627 | active. You can do this with either one of the following two lines | |
c8d0cf5c | 628 | (XEmacs users must use the second option): |
4009494e GM |
629 | @lisp |
630 | (global-font-lock-mode 1) ; for all buffers | |
a7808fba | 631 | (add-hook 'org-mode-hook 'turn-on-font-lock) ; Org buffers only |
4009494e GM |
632 | @end lisp |
633 | ||
a7808fba | 634 | @cindex Org mode, turning on |
4009494e | 635 | With this setup, all files with extension @samp{.org} will be put |
a7808fba | 636 | into Org mode. As an alternative, make the first line of a file look |
4009494e GM |
637 | like this: |
638 | ||
639 | @example | |
640 | MY PROJECTS -*- mode: org; -*- | |
641 | @end example | |
642 | ||
c8d0cf5c | 643 | @vindex org-insert-mode-line-in-empty-file |
a7808fba | 644 | @noindent which will select Org mode for this buffer no matter what |
4009494e GM |
645 | the file's name is. See also the variable |
646 | @code{org-insert-mode-line-in-empty-file}. | |
647 | ||
c8d0cf5c CD |
648 | Many commands in Org work on the region if the region is @i{active}. To make |
649 | use of this, you need to have @code{transient-mark-mode} | |
650 | (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default, | |
651 | in Emacs 22 you need to do this yourself with | |
b6cb4cd5 CD |
652 | @lisp |
653 | (transient-mark-mode 1) | |
654 | @end lisp | |
c8d0cf5c CD |
655 | @noindent If you do not like @code{transient-mark-mode}, you can create an |
656 | active region by using the mouse to select a region, or pressing | |
657 | @kbd{C-@key{SPC}} twice before moving the cursor. | |
b6cb4cd5 | 658 | |
dbc28aaa | 659 | @node Feedback, Conventions, Activation, Introduction |
4009494e GM |
660 | @section Feedback |
661 | @cindex feedback | |
662 | @cindex bug reports | |
663 | @cindex maintainer | |
664 | @cindex author | |
665 | ||
b349f79f | 666 | If you find problems with Org, or if you have questions, remarks, or ideas |
c8d0cf5c | 667 | about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}. |
6eb02347 CD |
668 | If you are not a member of the mailing list, your mail will be passed to the |
669 | list after a moderator has approved it. | |
4009494e | 670 | |
6eb02347 CD |
671 | For bug reports, please provide as much information as possible, including |
672 | the version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org | |
673 | (@kbd{M-x org-version @key{RET}}), as well as the Org related setup in | |
674 | @file{.emacs}. The easiest way to do this is to use the command | |
675 | @example | |
676 | @kbd{M-x org-submit-bug-report} | |
677 | @end example | |
678 | @noindent which will put all this information into an Emacs mail buffer so | |
679 | that you only need to add your description. If you re not sending the Email | |
680 | from within Emacs, please copy and paste the content into your Email program. | |
681 | ||
682 | If an error occurs, a backtrace can be very useful (see below on how to | |
683 | create one). Often a small example file helps, along with clear information | |
684 | about: | |
4009494e GM |
685 | |
686 | @enumerate | |
687 | @item What exactly did you do? | |
688 | @item What did you expect to happen? | |
689 | @item What happened instead? | |
690 | @end enumerate | |
691 | @noindent Thank you for helping to improve this mode. | |
692 | ||
693 | @subsubheading How to create a useful backtrace | |
694 | ||
695 | @cindex backtrace of an error | |
a7808fba | 696 | If working with Org produces an error with a message you don't |
4009494e | 697 | understand, you may have hit a bug. The best way to report this is by |
c8d0cf5c | 698 | providing, in addition to what was mentioned above, a @emph{backtrace}. |
4009494e GM |
699 | This is information from the built-in debugger about where and how the |
700 | error occurred. Here is how to produce a useful backtrace: | |
701 | ||
702 | @enumerate | |
703 | @item | |
c8d0cf5c CD |
704 | Reload uncompiled versions of all Org-mode Lisp files. The backtrace |
705 | contains much more information if it is produced with uncompiled code. | |
706 | To do this, use | |
4009494e | 707 | @example |
c8d0cf5c | 708 | C-u M-x org-reload RET |
4009494e | 709 | @end example |
c8d0cf5c CD |
710 | @noindent |
711 | or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the | |
712 | menu. | |
4009494e GM |
713 | @item |
714 | Go to the @code{Options} menu and select @code{Enter Debugger on Error} | |
715 | (XEmacs has this option in the @code{Troubleshooting} sub-menu). | |
716 | @item | |
717 | Do whatever you have to do to hit the error. Don't forget to | |
718 | document the steps you take. | |
719 | @item | |
720 | When you hit the error, a @file{*Backtrace*} buffer will appear on the | |
721 | screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and | |
722 | attach it to your bug report. | |
723 | @end enumerate | |
724 | ||
dbc28aaa CD |
725 | @node Conventions, , Feedback, Introduction |
726 | @section Typesetting conventions used in this manual | |
727 | ||
a7808fba | 728 | Org uses three types of keywords: TODO keywords, tags, and property |
dbc28aaa CD |
729 | names. In this manual we use the following conventions: |
730 | ||
731 | @table @code | |
732 | @item TODO | |
733 | @itemx WAITING | |
734 | TODO keywords are written with all capitals, even if they are | |
735 | user-defined. | |
736 | @item boss | |
737 | @itemx ARCHIVE | |
738 | User-defined tags are written in lowercase; built-in tags with special | |
739 | meaning are written with all capitals. | |
740 | @item Release | |
741 | @itemx PRIORITY | |
742 | User-defined properties are capitalized; built-in properties with | |
743 | special meaning are written with all capitals. | |
744 | @end table | |
745 | ||
a7808fba | 746 | @node Document Structure, Tables, Introduction, Top |
4009494e GM |
747 | @chapter Document Structure |
748 | @cindex document structure | |
749 | @cindex structure of document | |
750 | ||
c8d0cf5c | 751 | Org is based on Outline mode and provides flexible commands to |
4009494e GM |
752 | edit the structure of the document. |
753 | ||
754 | @menu | |
a7808fba CD |
755 | * Outlines:: Org is based on Outline mode |
756 | * Headlines:: How to typeset Org tree headlines | |
4009494e GM |
757 | * Visibility cycling:: Show and hide, much simplified |
758 | * Motion:: Jumping to other headlines | |
759 | * Structure editing:: Changing sequence and level of headlines | |
4009494e GM |
760 | * Sparse trees:: Matches embedded in context |
761 | * Plain lists:: Additional structure within an entry | |
762 | * Drawers:: Tucking stuff away | |
c8d0cf5c | 763 | * Blocks:: Folding blocks |
55e0839d | 764 | * Footnotes:: How footnotes are defined in Org's syntax |
a7808fba | 765 | * Orgstruct mode:: Structure editing outside Org |
4009494e GM |
766 | @end menu |
767 | ||
a7808fba | 768 | @node Outlines, Headlines, Document Structure, Document Structure |
4009494e GM |
769 | @section Outlines |
770 | @cindex outlines | |
a7808fba | 771 | @cindex Outline mode |
4009494e | 772 | |
a7808fba | 773 | Org is implemented on top of Outline mode. Outlines allow a |
4009494e GM |
774 | document to be organized in a hierarchical structure, which (at least |
775 | for me) is the best representation of notes and thoughts. An overview | |
776 | of this structure is achieved by folding (hiding) large parts of the | |
777 | document to show only the general document structure and the parts | |
a7808fba | 778 | currently being worked on. Org greatly simplifies the use of |
4009494e | 779 | outlines by compressing the entire show/hide functionality into a single |
c8d0cf5c | 780 | command, @command{org-cycle}, which is bound to the @key{TAB} key. |
4009494e | 781 | |
a7808fba | 782 | @node Headlines, Visibility cycling, Outlines, Document Structure |
4009494e GM |
783 | @section Headlines |
784 | @cindex headlines | |
785 | @cindex outline tree | |
c8d0cf5c | 786 | @vindex org-special-ctrl-a/e |
4009494e GM |
787 | |
788 | Headlines define the structure of an outline tree. The headlines in | |
a7808fba | 789 | Org start with one or more stars, on the left margin@footnote{See |
4009494e GM |
790 | the variable @code{org-special-ctrl-a/e} to configure special behavior |
791 | of @kbd{C-a} and @kbd{C-e} in headlines.}. For example: | |
792 | ||
793 | @example | |
794 | * Top level headline | |
795 | ** Second level | |
796 | *** 3rd level | |
797 | some text | |
798 | *** 3rd level | |
799 | more text | |
800 | ||
801 | * Another top level headline | |
802 | @end example | |
803 | ||
804 | @noindent Some people find the many stars too noisy and would prefer an | |
805 | outline that has whitespace followed by a single star as headline | |
c8d0cf5c | 806 | starters. @ref{Clean view}, describes a setup to realize this. |
4009494e | 807 | |
c8d0cf5c | 808 | @vindex org-cycle-separator-lines |
4009494e GM |
809 | An empty line after the end of a subtree is considered part of it and |
810 | will be hidden when the subtree is folded. However, if you leave at | |
811 | least two empty lines, one empty line will remain visible after folding | |
812 | the subtree, in order to structure the collapsed view. See the | |
813 | variable @code{org-cycle-separator-lines} to modify this behavior. | |
814 | ||
a7808fba | 815 | @node Visibility cycling, Motion, Headlines, Document Structure |
4009494e GM |
816 | @section Visibility cycling |
817 | @cindex cycling, visibility | |
818 | @cindex visibility cycling | |
819 | @cindex trees, visibility | |
820 | @cindex show hidden text | |
821 | @cindex hide text | |
822 | ||
823 | Outlines make it possible to hide parts of the text in the buffer. | |
a7808fba | 824 | Org uses just two commands, bound to @key{TAB} and |
4009494e GM |
825 | @kbd{S-@key{TAB}} to change the visibility in the buffer. |
826 | ||
827 | @cindex subtree visibility states | |
828 | @cindex subtree cycling | |
829 | @cindex folded, subtree visibility state | |
830 | @cindex children, subtree visibility state | |
831 | @cindex subtree, subtree visibility state | |
832 | @table @kbd | |
833 | @kindex @key{TAB} | |
834 | @item @key{TAB} | |
835 | @emph{Subtree cycling}: Rotate current subtree among the states | |
836 | ||
837 | @example | |
838 | ,-> FOLDED -> CHILDREN -> SUBTREE --. | |
839 | '-----------------------------------' | |
840 | @end example | |
841 | ||
c8d0cf5c CD |
842 | @vindex org-cycle-emulate-tab |
843 | @vindex org-cycle-global-at-bob | |
4009494e GM |
844 | The cursor must be on a headline for this to work@footnote{see, however, |
845 | the option @code{org-cycle-emulate-tab}.}. When the cursor is at the | |
846 | beginning of the buffer and the first line is not a headline, then | |
847 | @key{TAB} actually runs global cycling (see below)@footnote{see the | |
848 | option @code{org-cycle-global-at-bob}.}. Also when called with a prefix | |
849 | argument (@kbd{C-u @key{TAB}}), global cycling is invoked. | |
850 | ||
851 | @cindex global visibility states | |
852 | @cindex global cycling | |
853 | @cindex overview, global visibility state | |
854 | @cindex contents, global visibility state | |
855 | @cindex show all, global visibility state | |
856 | @kindex S-@key{TAB} | |
857 | @item S-@key{TAB} | |
858 | @itemx C-u @key{TAB} | |
859 | @emph{Global cycling}: Rotate the entire buffer among the states | |
860 | ||
861 | @example | |
862 | ,-> OVERVIEW -> CONTENTS -> SHOW ALL --. | |
863 | '--------------------------------------' | |
864 | @end example | |
865 | ||
a7808fba CD |
866 | When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the |
867 | CONTENTS view up to headlines of level N will be shown. Note that inside | |
868 | tables, @kbd{S-@key{TAB}} jumps to the previous field. | |
4009494e GM |
869 | |
870 | @cindex show all, command | |
864c9740 CD |
871 | @kindex C-u C-u C-u @key{TAB} |
872 | @item C-u C-u C-u @key{TAB} | |
873 | Show all, including drawers. | |
4009494e GM |
874 | @kindex C-c C-r |
875 | @item C-c C-r | |
a7808fba CD |
876 | Reveal context around point, showing the current entry, the following heading |
877 | and the hierarchy above. Useful for working near a location that has been | |
878 | exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command | |
879 | (@pxref{Agenda commands}). With a prefix argument show, on each | |
4009494e GM |
880 | level, all sibling headings. |
881 | @kindex C-c C-x b | |
882 | @item C-c C-x b | |
883 | Show the current subtree in an indirect buffer@footnote{The indirect | |
884 | buffer | |
885 | @ifinfo | |
886 | (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual}) | |
887 | @end ifinfo | |
888 | @ifnotinfo | |
889 | (see the Emacs manual for more information about indirect buffers) | |
890 | @end ifnotinfo | |
891 | will contain the entire buffer, but will be narrowed to the current | |
892 | tree. Editing the indirect buffer will also change the original buffer, | |
a7808fba CD |
893 | but without affecting visibility in that buffer.}. With a numeric |
894 | prefix argument N, go up to level N and then take that tree. If N is | |
895 | negative then go up that many levels. With a @kbd{C-u} prefix, do not remove | |
4009494e GM |
896 | the previously used indirect buffer. |
897 | @end table | |
898 | ||
c8d0cf5c CD |
899 | @vindex org-startup-folded |
900 | @cindex @code{overview}, STARTUP keyword | |
901 | @cindex @code{content}, STARTUP keyword | |
902 | @cindex @code{showall}, STARTUP keyword | |
7006d207 | 903 | @cindex @code{showeverything}, STARTUP keyword |
c8d0cf5c | 904 | |
a7808fba | 905 | When Emacs first visits an Org file, the global state is set to |
a351880d | 906 | OVERVIEW, i.e. only the top level headlines are visible. This can be |
4009494e GM |
907 | configured through the variable @code{org-startup-folded}, or on a |
908 | per-file basis by adding one of the following lines anywhere in the | |
909 | buffer: | |
910 | ||
911 | @example | |
912 | #+STARTUP: overview | |
913 | #+STARTUP: content | |
914 | #+STARTUP: showall | |
7006d207 | 915 | #+STARTUP: showeverything |
4009494e GM |
916 | @end example |
917 | ||
c8d0cf5c | 918 | @cindex property, VISIBILITY |
b349f79f | 919 | @noindent |
a50253cc | 920 | Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties |
b349f79f CD |
921 | and Columns}) will get their visibility adapted accordingly. Allowed values |
922 | for this property are @code{folded}, @code{children}, @code{content}, and | |
923 | @code{all}. | |
924 | @table @kbd | |
925 | @kindex C-u C-u @key{TAB} | |
926 | @item C-u C-u @key{TAB} | |
a351880d | 927 | Switch back to the startup visibility of the buffer, i.e. whatever is |
b349f79f CD |
928 | requested by startup options and @samp{VISIBILITY} properties in individual |
929 | entries. | |
930 | @end table | |
931 | ||
a7808fba | 932 | @node Motion, Structure editing, Visibility cycling, Document Structure |
4009494e GM |
933 | @section Motion |
934 | @cindex motion, between headlines | |
935 | @cindex jumping, to headlines | |
936 | @cindex headline navigation | |
937 | The following commands jump to other headlines in the buffer. | |
938 | ||
939 | @table @kbd | |
940 | @kindex C-c C-n | |
941 | @item C-c C-n | |
942 | Next heading. | |
943 | @kindex C-c C-p | |
944 | @item C-c C-p | |
945 | Previous heading. | |
946 | @kindex C-c C-f | |
947 | @item C-c C-f | |
948 | Next heading same level. | |
949 | @kindex C-c C-b | |
950 | @item C-c C-b | |
951 | Previous heading same level. | |
952 | @kindex C-c C-u | |
953 | @item C-c C-u | |
954 | Backward to higher level heading. | |
955 | @kindex C-c C-j | |
956 | @item C-c C-j | |
957 | Jump to a different place without changing the current outline | |
958 | visibility. Shows the document structure in a temporary buffer, where | |
959 | you can use the following keys to find your destination: | |
c8d0cf5c | 960 | @vindex org-goto-auto-isearch |
4009494e GM |
961 | @example |
962 | @key{TAB} @r{Cycle visibility.} | |
963 | @key{down} / @key{up} @r{Next/previous visible headline.} | |
71d35b24 CD |
964 | @key{RET} @r{Select this location.} |
965 | @kbd{/} @r{Do a Sparse-tree search} | |
966 | @r{The following keys work if you turn off @code{org-goto-auto-isearch}} | |
4009494e GM |
967 | n / p @r{Next/previous visible headline.} |
968 | f / b @r{Next/previous headline same level.} | |
969 | u @r{One level up.} | |
970 | 0-9 @r{Digit argument.} | |
71d35b24 | 971 | q @r{Quit} |
4009494e | 972 | @end example |
c8d0cf5c CD |
973 | @vindex org-goto-interface |
974 | @noindent | |
975 | See also the variable @code{org-goto-interface}. | |
4009494e GM |
976 | @end table |
977 | ||
a351880d | 978 | @node Structure editing, Sparse trees, Motion, Document Structure |
4009494e GM |
979 | @section Structure editing |
980 | @cindex structure editing | |
981 | @cindex headline, promotion and demotion | |
982 | @cindex promotion, of subtrees | |
983 | @cindex demotion, of subtrees | |
984 | @cindex subtree, cut and paste | |
985 | @cindex pasting, of subtrees | |
986 | @cindex cutting, of subtrees | |
987 | @cindex copying, of subtrees | |
6eb02347 | 988 | @cindex sorting, of subtrees |
4009494e GM |
989 | @cindex subtrees, cut and paste |
990 | ||
991 | @table @kbd | |
992 | @kindex M-@key{RET} | |
993 | @item M-@key{RET} | |
c8d0cf5c | 994 | @vindex org-M-RET-may-split-line |
4009494e GM |
995 | Insert new heading with same level as current. If the cursor is in a |
996 | plain list item, a new item is created (@pxref{Plain lists}). To force | |
a7808fba | 997 | creation of a new headline, use a prefix argument, or first press @key{RET} |
4009494e GM |
998 | to get to the beginning of the next line. When this command is used in |
999 | the middle of a line, the line is split and the rest of the line becomes | |
28a16a1b CD |
1000 | the new headline@footnote{If you do not want the line to be split, |
1001 | customize the variable @code{org-M-RET-may-split-line}.}. If the | |
1002 | command is used at the beginning of a headline, the new headline is | |
1003 | created before the current line. If at the beginning of any other line, | |
1004 | the content of that line is made the new heading. If the command is | |
a351880d | 1005 | used at the end of a folded subtree (i.e. behind the ellipses at the end |
28a16a1b CD |
1006 | of a headline), then a headline like the current one will be inserted |
1007 | after the end of the subtree. | |
dbc28aaa CD |
1008 | @kindex C-@key{RET} |
1009 | @item C-@key{RET} | |
71d35b24 CD |
1010 | Just like @kbd{M-@key{RET}}, except when adding a new heading below the |
1011 | current heading, the new heading is placed after the body instead of before | |
1012 | it. This command works from anywhere in the entry. | |
4009494e GM |
1013 | @kindex M-S-@key{RET} |
1014 | @item M-S-@key{RET} | |
c8d0cf5c CD |
1015 | @vindex org-treat-insert-todo-heading-as-state-change |
1016 | Insert new TODO entry with same level as current heading. See also the | |
1017 | variable @code{org-treat-insert-todo-heading-as-state-change}. | |
864c9740 CD |
1018 | @kindex C-S-@key{RET} |
1019 | @item C-S-@key{RET} | |
1020 | Insert new TODO entry with same level as current heading. Like | |
1021 | @kbd{C-@key{RET}}, the new headline will be inserted after the current | |
1022 | subtree. | |
a351880d CD |
1023 | @kindex @key{TAB} |
1024 | @item @key{TAB} @r{in new, empty entry} | |
1025 | In a new entry with no text yet, the first @key{TAB} demotes the entry to | |
1026 | become a child of the previous one. The next @key{TAB} makes it a parent, | |
1027 | and so on, all the way to top level. Yet another @key{TAB}, and you are back | |
1028 | to the initial level. | |
4009494e GM |
1029 | @kindex M-@key{left} |
1030 | @item M-@key{left} | |
1031 | Promote current heading by one level. | |
1032 | @kindex M-@key{right} | |
1033 | @item M-@key{right} | |
1034 | Demote current heading by one level. | |
1035 | @kindex M-S-@key{left} | |
1036 | @item M-S-@key{left} | |
1037 | Promote the current subtree by one level. | |
1038 | @kindex M-S-@key{right} | |
1039 | @item M-S-@key{right} | |
1040 | Demote the current subtree by one level. | |
1041 | @kindex M-S-@key{up} | |
1042 | @item M-S-@key{up} | |
1043 | Move subtree up (swap with previous subtree of same | |
1044 | level). | |
1045 | @kindex M-S-@key{down} | |
1046 | @item M-S-@key{down} | |
1047 | Move subtree down (swap with next subtree of same level). | |
1048 | @kindex C-c C-x C-w | |
4009494e | 1049 | @item C-c C-x C-w |
a351880d | 1050 | Kill subtree, i.e. remove it from buffer but save in kill ring. |
a7808fba | 1051 | With a numeric prefix argument N, kill N sequential subtrees. |
4009494e GM |
1052 | @kindex C-c C-x M-w |
1053 | @item C-c C-x M-w | |
a7808fba CD |
1054 | Copy subtree to kill ring. With a numeric prefix argument N, copy the N |
1055 | sequential subtrees. | |
4009494e GM |
1056 | @kindex C-c C-x C-y |
1057 | @item C-c C-x C-y | |
1058 | Yank subtree from kill ring. This does modify the level of the subtree to | |
a7808fba CD |
1059 | make sure the tree fits in nicely at the yank position. The yank level can |
1060 | also be specified with a numeric prefix argument, or by yanking after a | |
4009494e | 1061 | headline marker like @samp{****}. |
96c8522a | 1062 | @kindex C-y |
e45e3595 | 1063 | @item C-y |
c8d0cf5c CD |
1064 | @vindex org-yank-adjusted-subtrees |
1065 | @vindex org-yank-folded-subtrees | |
e45e3595 CD |
1066 | Depending on the variables @code{org-yank-adjusted-subtrees} and |
1067 | @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will | |
1068 | paste subtrees folded and in a clever way, using the same command as @kbd{C-c | |
55033558 CD |
1069 | C-x C-y}. With the default settings, no level adjustment will take place, |
1070 | but the yanked tree will be folded unless doing so would swallow text | |
1071 | previously visible. Any prefix argument to this command will force a normal | |
1072 | @code{yank} to be executed, with the prefix passed along. A good way to | |
1073 | force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a | |
1074 | yank, it will yank previous kill items plainly, without adjustment and | |
1075 | folding. | |
c8d0cf5c CD |
1076 | @kindex C-c C-x c |
1077 | @item C-c C-x c | |
1078 | Clone a subtree by making a number of sibling copies of it. You will be | |
1079 | prompted for the number of copies to make, and you can also specify if any | |
1080 | timestamps in the entry should be shifted. This can be useful, for example, | |
1081 | to create a number of tasks related to a series of lectures to prepare. For | |
1082 | more details, see the docstring of the command | |
1083 | @code{org-clone-subtree-with-time-shift}. | |
dbc28aaa CD |
1084 | @kindex C-c C-w |
1085 | @item C-c C-w | |
e45e3595 | 1086 | Refile entry or region to a different location. @xref{Refiling notes}. |
4009494e GM |
1087 | @kindex C-c ^ |
1088 | @item C-c ^ | |
a7808fba CD |
1089 | Sort same-level entries. When there is an active region, all entries in the |
1090 | region will be sorted. Otherwise the children of the current headline are | |
1091 | sorted. The command prompts for the sorting method, which can be | |
c8d0cf5c CD |
1092 | alphabetically, numerically, by time (first timestamp with active preferred, |
1093 | creation time, scheduled time, deadline time), by priority, by TODO keyword | |
1094 | (in the sequence the keywords have been defined in the setup) or by the value | |
1095 | of a property. Reverse sorting is possible as well. You can also supply | |
1096 | your own function to extract the sorting key. With a @kbd{C-u} prefix, | |
1097 | sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes, duplicate | |
1098 | entries will also be removed. | |
b349f79f CD |
1099 | @kindex C-x n s |
1100 | @item C-x n s | |
1101 | Narrow buffer to current subtree. | |
1102 | @kindex C-x n w | |
1103 | @item C-x n w | |
c8d0cf5c | 1104 | Widen buffer to remove narrowing. |
28a16a1b CD |
1105 | @kindex C-c * |
1106 | @item C-c * | |
55e0839d CD |
1107 | Turn a normal line or plain list item into a headline (so that it becomes a |
1108 | subheading at its location). Also turn a headline into a normal line by | |
1109 | removing the stars. If there is an active region, turn all lines in the | |
1110 | region into headlines. If the first line in the region was an item, turn | |
1111 | only the item lines into headlines. Finally, if the first line is a | |
28a16a1b | 1112 | headline, remove the stars from all headlines in the region. |
4009494e GM |
1113 | @end table |
1114 | ||
1115 | @cindex region, active | |
1116 | @cindex active region | |
c8d0cf5c CD |
1117 | @cindex transient mark mode |
1118 | When there is an active region (Transient Mark mode), promotion and | |
4009494e GM |
1119 | demotion work on all headlines in the region. To select a region of |
1120 | headlines, it is best to place both point and mark at the beginning of a | |
1121 | line, mark at the beginning of the first headline, and point at the line | |
1122 | just after the last headline to change. Note that when the cursor is | |
1123 | inside a table (@pxref{Tables}), the Meta-Cursor keys have different | |
1124 | functionality. | |
1125 | ||
28a16a1b | 1126 | |
a351880d | 1127 | @node Sparse trees, Plain lists, Structure editing, Document Structure |
4009494e GM |
1128 | @section Sparse trees |
1129 | @cindex sparse trees | |
1130 | @cindex trees, sparse | |
1131 | @cindex folding, sparse trees | |
1132 | @cindex occur, command | |
1133 | ||
c8d0cf5c CD |
1134 | @vindex org-show-hierarchy-above |
1135 | @vindex org-show-following-heading | |
1136 | @vindex org-show-siblings | |
1137 | @vindex org-show-entry-below | |
b349f79f CD |
1138 | An important feature of Org mode is the ability to construct @emph{sparse |
1139 | trees} for selected information in an outline tree, so that the entire | |
1140 | document is folded as much as possible, but the selected information is made | |
1141 | visible along with the headline structure above it@footnote{See also the | |
1142 | variables @code{org-show-hierarchy-above}, @code{org-show-following-heading}, | |
1143 | @code{org-show-siblings}, and @code{org-show-entry-below} for detailed | |
1144 | control on how much context is shown around each match.}. Just try it out | |
1145 | and you will see immediately how it works. | |
dbc28aaa | 1146 | |
a7808fba | 1147 | Org mode contains several commands creating such trees, all these |
dbc28aaa | 1148 | commands can be accessed through a dispatcher: |
4009494e GM |
1149 | |
1150 | @table @kbd | |
1151 | @kindex C-c / | |
1152 | @item C-c / | |
dbc28aaa CD |
1153 | This prompts for an extra key to select a sparse-tree creating command. |
1154 | @kindex C-c / r | |
1155 | @item C-c / r | |
c8d0cf5c | 1156 | @vindex org-remove-highlights-with-change |
b349f79f CD |
1157 | Occur. Prompts for a regexp and shows a sparse tree with all matches. If |
1158 | the match is in a headline, the headline is made visible. If the match is in | |
1159 | the body of an entry, headline and body are made visible. In order to | |
1160 | provide minimal context, also the full hierarchy of headlines above the match | |
1161 | is shown, as well as the headline following the match. Each match is also | |
1162 | highlighted; the highlights disappear when the buffer is changed by an | |
c8d0cf5c | 1163 | editing command@footnote{This depends on the option |
b349f79f CD |
1164 | @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}. |
1165 | When called with a @kbd{C-u} prefix argument, previous highlights are kept, | |
1166 | so several calls to this command can be stacked. | |
4009494e | 1167 | @end table |
dbc28aaa | 1168 | |
4009494e | 1169 | @noindent |
c8d0cf5c | 1170 | @vindex org-agenda-custom-commands |
4009494e GM |
1171 | For frequently used sparse trees of specific search strings, you can |
1172 | use the variable @code{org-agenda-custom-commands} to define fast | |
1173 | keyboard access to specific sparse trees. These commands will then be | |
1174 | accessible through the agenda dispatcher (@pxref{Agenda dispatcher}). | |
1175 | For example: | |
1176 | ||
1177 | @lisp | |
1178 | (setq org-agenda-custom-commands | |
1179 | '(("f" occur-tree "FIXME"))) | |
1180 | @end lisp | |
1181 | ||
1182 | @noindent will define the key @kbd{C-c a f} as a shortcut for creating | |
1183 | a sparse tree matching the string @samp{FIXME}. | |
1184 | ||
dbc28aaa CD |
1185 | The other sparse tree commands select headings based on TODO keywords, |
1186 | tags, or properties and will be discussed later in this manual. | |
4009494e GM |
1187 | |
1188 | @kindex C-c C-e v | |
1189 | @cindex printing sparse trees | |
1190 | @cindex visible text, printing | |
1191 | To print a sparse tree, you can use the Emacs command | |
1192 | @code{ps-print-buffer-with-faces} which does not print invisible parts | |
1193 | of the document @footnote{This does not work under XEmacs, because | |
1194 | XEmacs uses selective display for outlining, not text properties.}. | |
1195 | Or you can use the command @kbd{C-c C-e v} to export only the visible | |
1196 | part of the document and print the resulting file. | |
1197 | ||
a7808fba | 1198 | @node Plain lists, Drawers, Sparse trees, Document Structure |
4009494e GM |
1199 | @section Plain lists |
1200 | @cindex plain lists | |
1201 | @cindex lists, plain | |
1202 | @cindex lists, ordered | |
1203 | @cindex ordered lists | |
1204 | ||
1205 | Within an entry of the outline tree, hand-formatted lists can provide | |
1206 | additional structure. They also provide a way to create lists of | |
a7808fba | 1207 | checkboxes (@pxref{Checkboxes}). Org supports editing such lists, |
dbc28aaa | 1208 | and the HTML exporter (@pxref{Exporting}) parses and formats them. |
4009494e | 1209 | |
b349f79f CD |
1210 | Org knows ordered lists, unordered lists, and description lists. |
1211 | @itemize @bullet | |
1212 | @item | |
1213 | @emph{Unordered} list items start with @samp{-}, @samp{+}, or | |
1214 | @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or | |
1215 | they will be seen as top-level headlines. Also, when you are hiding leading | |
1216 | stars to get a clean outline view, plain list items starting with a star are | |
1217 | visually indistinguishable from true headlines. In short: even though | |
1218 | @samp{*} is supported, it may be better to not use it for plain list items.} | |
1219 | as bullets. | |
1220 | @item | |
1221 | @emph{Ordered} list items start with a numeral followed by either a period or | |
1222 | a right parenthesis, such as @samp{1.} or @samp{1)}. | |
1223 | @item | |
a351880d | 1224 | @emph{Description} list items are unordered list items, and contain the |
b349f79f | 1225 | separator @samp{ :: } to separate the description @emph{term} from the |
a50253cc | 1226 | description. |
b349f79f CD |
1227 | @end itemize |
1228 | ||
c8d0cf5c | 1229 | @vindex org-empty-line-terminates-plain-lists |
b349f79f CD |
1230 | Items belonging to the same list must have the same indentation on the first |
1231 | line. In particular, if an ordered list reaches number @samp{10.}, then the | |
1232 | 2--digit numbers must be written left-aligned with the other numbers in the | |
1233 | list. Indentation also determines the end of a list item. It ends before | |
1234 | the next line that is indented like the bullet/number, or less. Empty lines | |
1235 | are part of the previous item, so you can have several paragraphs in one | |
1236 | item. If you would like an empty line to terminate all currently open plain | |
1237 | lists, configure the variable @code{org-empty-line-terminates-plain-lists}. | |
1238 | Here is an example: | |
4009494e GM |
1239 | |
1240 | @example | |
1241 | @group | |
1242 | ** Lord of the Rings | |
1243 | My favorite scenes are (in this order) | |
1244 | 1. The attack of the Rohirrim | |
a50253cc | 1245 | 2. Eowyn's fight with the witch king |
4009494e GM |
1246 | + this was already my favorite scene in the book |
1247 | + I really like Miranda Otto. | |
1248 | 3. Peter Jackson being shot by Legolas | |
1249 | - on DVD only | |
1250 | He makes a really funny face when it happens. | |
a50253cc | 1251 | But in the end, no individual scenes matter but the film as a whole. |
b349f79f | 1252 | Important actors in this film are: |
a50253cc | 1253 | - @b{Elijah Wood} :: He plays Frodo |
ac20fddf | 1254 | - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember |
c8d0cf5c | 1255 | him very well from his role as Mikey Walsh in @i{The Goonies}. |
4009494e GM |
1256 | @end group |
1257 | @end example | |
1258 | ||
c8d0cf5c CD |
1259 | Org supports these lists by tuning filling and wrapping commands to deal with |
1260 | them correctly@footnote{Org only changes the filling settings for Emacs. For | |
1261 | XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on, | |
1262 | put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them | |
1263 | properly (@pxref{Exporting}). Since indentation is what governs the | |
1264 | structure of these lists, many structural constructs like @code{#+BEGIN_...} | |
1265 | blocks can be indented to signal that they should be part of a list item. | |
4009494e GM |
1266 | |
1267 | The following commands act on items when the cursor is in the first line | |
1268 | of an item (the line with the bullet or number). | |
1269 | ||
1270 | @table @kbd | |
1271 | @kindex @key{TAB} | |
1272 | @item @key{TAB} | |
c8d0cf5c CD |
1273 | @vindex org-cycle-include-plain-lists |
1274 | Items can be folded just like headline levels. Normally this works only if | |
1275 | the cursor is on a plain list item. For more details, see the variable | |
1276 | @code{org-cycle-include-plain-lists}. to @code{integrate}, plain list items | |
1277 | will be treated like low-level. The level of an item is then given by the | |
1278 | indentation of the bullet/number. Items are always subordinate to real | |
1279 | headlines, however; the hierarchies remain completely separated. | |
4009494e GM |
1280 | |
1281 | If @code{org-cycle-include-plain-lists} has not been set, @key{TAB} | |
a7808fba | 1282 | fixes the indentation of the current line in a heuristic way. |
4009494e GM |
1283 | @kindex M-@key{RET} |
1284 | @item M-@key{RET} | |
c8d0cf5c | 1285 | @vindex org-M-RET-may-split-line |
a7808fba CD |
1286 | Insert new item at current level. With a prefix argument, force a new |
1287 | heading (@pxref{Structure editing}). If this command is used in the middle | |
1288 | of a line, the line is @emph{split} and the rest of the line becomes the new | |
1289 | item@footnote{If you do not want the line to be split, customize the variable | |
1290 | @code{org-M-RET-may-split-line}.}. If this command is executed in the | |
1291 | @emph{whitespace before a bullet or number}, the new item is created | |
1292 | @emph{before} the current item. If the command is executed in the white | |
1293 | space before the text that is part of an item but does not contain the | |
1294 | bullet, a bullet is added to the current line. | |
4009494e GM |
1295 | @kindex M-S-@key{RET} |
1296 | @item M-S-@key{RET} | |
1297 | Insert a new item with a checkbox (@pxref{Checkboxes}). | |
a351880d CD |
1298 | @kindex @key{TAB} |
1299 | @item @key{TAB} @r{in new, empty item} | |
1300 | In a new item with no text yet, the first @key{TAB} demotes the item to | |
1301 | become a child of the previous one. The next @key{TAB} makes it a parent, | |
1302 | and so on, all the way to the left margin. Yet another @key{TAB}, and you | |
1303 | are back to the initial level. | |
4009494e GM |
1304 | @kindex S-@key{up} |
1305 | @kindex S-@key{down} | |
1306 | @item S-@key{up} | |
1307 | @itemx S-@key{down} | |
3da3282e | 1308 | @cindex shift-selection-mode |
c8d0cf5c | 1309 | @vindex org-support-shift-select |
3da3282e CD |
1310 | Jump to the previous/next item in the current list, but only if |
1311 | @code{org-support-shift-select} is off. If not, you can still use paragraph | |
1312 | jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite | |
1313 | similar effect. | |
4009494e GM |
1314 | @kindex M-S-@key{up} |
1315 | @kindex M-S-@key{down} | |
1316 | @item M-S-@key{up} | |
1317 | @itemx M-S-@key{down} | |
1318 | Move the item including subitems up/down (swap with previous/next item | |
1319 | of same indentation). If the list is ordered, renumbering is | |
1320 | automatic. | |
1321 | @kindex M-S-@key{left} | |
1322 | @kindex M-S-@key{right} | |
1323 | @item M-S-@key{left} | |
1324 | @itemx M-S-@key{right} | |
1325 | Decrease/increase the indentation of the item, including subitems. | |
1326 | Initially, the item tree is selected based on current indentation. | |
1327 | When these commands are executed several times in direct succession, | |
1328 | the initially selected region is used, even if the new indentation | |
1329 | would imply a different hierarchy. To use the new hierarchy, break | |
1330 | the command chain with a cursor motion or so. | |
1331 | @kindex C-c C-c | |
1332 | @item C-c C-c | |
1333 | If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the | |
dbc28aaa CD |
1334 | state of the checkbox. If not, this command makes sure that all the |
1335 | items on this list level use the same bullet. Furthermore, if this is | |
a7808fba | 1336 | an ordered list, make sure the numbering is OK. |
4009494e GM |
1337 | @kindex C-c - |
1338 | @item C-c - | |
a7808fba CD |
1339 | Cycle the entire list level through the different itemize/enumerate bullets |
1340 | (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}). With a numeric prefix | |
1341 | argument N, select the Nth bullet from this list. If there is an active | |
1342 | region when calling this, all lines will be converted to list items. If the | |
1343 | first line already was a list item, any item markers will be removed from the | |
1344 | list. Finally, even without an active region, a normal line will be | |
1345 | converted into a list item. | |
c8d0cf5c CD |
1346 | @kindex C-c * |
1347 | @item C-c * | |
1348 | Turn a plain list item into a headline (so that it becomes a subheading at | |
1349 | its location). @xref{Structure editing}, for a detailed explanation. | |
64fb801f CD |
1350 | @kindex S-@key{left} |
1351 | @kindex S-@key{right} | |
1352 | @item S-@key{left}/@key{right} | |
c8d0cf5c | 1353 | @vindex org-support-shift-select |
3da3282e CD |
1354 | This command also cycles bullet styles when the cursor in on the bullet or |
1355 | anywhere in an item line, details depending on | |
1356 | @code{org-support-shift-select}. | |
c8d0cf5c CD |
1357 | @kindex C-c ^ |
1358 | @item C-c ^ | |
1359 | Sort the plain list. You will be prompted for the sorting method: | |
1360 | numerically, alphabetically, by time, or by custom function. | |
4009494e GM |
1361 | @end table |
1362 | ||
c8d0cf5c | 1363 | @node Drawers, Blocks, Plain lists, Document Structure |
4009494e GM |
1364 | @section Drawers |
1365 | @cindex drawers | |
c8d0cf5c | 1366 | @cindex #+DRAWERS |
4009494e GM |
1367 | @cindex visibility cycling, drawers |
1368 | ||
c8d0cf5c | 1369 | @vindex org-drawers |
4009494e | 1370 | Sometimes you want to keep information associated with an entry, but you |
a7808fba | 1371 | normally don't want to see it. For this, Org mode has @emph{drawers}. |
dbc28aaa CD |
1372 | Drawers need to be configured with the variable |
1373 | @code{org-drawers}@footnote{You can define drawers on a per-file basis | |
1374 | with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers | |
4009494e GM |
1375 | look like this: |
1376 | ||
1377 | @example | |
1378 | ** This is a headline | |
1379 | Still outside the drawer | |
1380 | :DRAWERNAME: | |
1381 | This is inside the drawer. | |
1382 | :END: | |
1383 | After the drawer. | |
1384 | @end example | |
1385 | ||
c8d0cf5c CD |
1386 | Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and |
1387 | show the entry, but keep the drawer collapsed to a single line. In order to | |
1388 | look inside the drawer, you need to move the cursor to the drawer line and | |
1389 | press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for | |
1390 | storing properties (@pxref{Properties and Columns}), and you can also arrange | |
1391 | for state change notes (@pxref{Tracking TODO state changes}) and clock times | |
1392 | (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. | |
1393 | ||
1394 | @node Blocks, Footnotes, Drawers, Document Structure | |
1395 | @section Blocks | |
1396 | ||
1397 | @vindex org-hide-block-startup | |
1398 | @cindex blocks, folding | |
1399 | Org-mode uses begin...end blocks for various purposes from including source | |
1400 | code examples (@pxref{Literal examples}) to capturing time logging | |
1401 | information (@pxref{Clocking work time}). These blocks can be folded and | |
1402 | unfolded by pressing TAB in the begin line. You can also get all blocks | |
1403 | folded at startup by configuring the variable @code{org-hide-block-startup} | |
1404 | or on a per-file basis by using | |
4009494e | 1405 | |
c8d0cf5c CD |
1406 | @cindex @code{hideblocks}, STARTUP keyword |
1407 | @cindex @code{nohideblocks}, STARTUP keyword | |
1408 | @example | |
1409 | #+STARTUP: hideblocks | |
1410 | #+STARTUP: nohideblocks | |
1411 | @end example | |
1412 | ||
1413 | @node Footnotes, Orgstruct mode, Blocks, Document Structure | |
55e0839d CD |
1414 | @section Footnotes |
1415 | @cindex footnotes | |
1416 | ||
c8d0cf5c CD |
1417 | Org mode supports the creation of footnotes. In contrast to the |
1418 | @file{footnote.el} package, Org mode's footnotes are designed for work on a | |
55e0839d | 1419 | larger document, not only for one-off documents like emails. The basic |
a351880d | 1420 | syntax is similar to the one used by @file{footnote.el}, i.e. a footnote is |
55e0839d CD |
1421 | defined in a paragraph that is started by a footnote marker in square |
1422 | brackets in column 0, no indentation allowed. If you need a paragraph break | |
c8d0cf5c | 1423 | inside a footnote, use the La@TeX{} idiom @samp{\par}. The footnote reference |
55e0839d CD |
1424 | is simply the marker in square brackets, inside text. For example: |
1425 | ||
1426 | @example | |
1427 | The Org homepage[fn:1] now looks a lot better than it used to. | |
1428 | ... | |
1429 | [fn:1] The link is: http://orgmode.org | |
1430 | @end example | |
1431 | ||
c8d0cf5c | 1432 | Org mode extends the number-based syntax to @emph{named} footnotes and |
55e0839d CD |
1433 | optional inline definition. Using plain numbers as markers (as |
1434 | @file{footnote.el} does) is supported for backward compatibility, but not | |
c8d0cf5c CD |
1435 | encouraged because of possible conflicts with La@TeX{} snippets (@pxref{Embedded |
1436 | LaTeX}). Here are the valid references: | |
55e0839d CD |
1437 | |
1438 | @table @code | |
1439 | @item [1] | |
c8d0cf5c | 1440 | A plain numeric footnote marker. Compatible with @file{footnote.el}, but not |
e1d294ab | 1441 | recommended because something like @samp{[1]} could easily be part of a code |
c8d0cf5c | 1442 | snippet. |
55e0839d CD |
1443 | @item [fn:name] |
1444 | A named footnote reference, where @code{name} is a unique label word, or, for | |
1445 | simplicity of automatic creation, a number. | |
1446 | @item [fn:: This is the inline definition of this footnote] | |
c8d0cf5c | 1447 | A La@TeX{}-like anonymous footnote where the definition is given directly at the |
55e0839d CD |
1448 | reference point. |
1449 | @item [fn:name: a definition] | |
1450 | An inline definition of a footnote, which also specifies a name for the note. | |
867d4bb3 | 1451 | Since Org allows multiple references to the same note, you can then use |
55e0839d CD |
1452 | @code{[fn:name]} to create additional references. |
1453 | @end table | |
1454 | ||
c8d0cf5c CD |
1455 | @vindex org-footnote-auto-label |
1456 | Footnote labels can be created automatically, or you can create names yourself. | |
55e0839d CD |
1457 | This is handled by the variable @code{org-footnote-auto-label} and its |
1458 | corresponding @code{#+STARTUP} keywords, see the docstring of that variable | |
1459 | for details. | |
1460 | ||
1461 | @noindent The following command handles footnotes: | |
1462 | ||
1463 | @table @kbd | |
1464 | @kindex C-c C-x f | |
1465 | @item C-c C-x f | |
1466 | The footnote action command. | |
1467 | ||
1468 | When the cursor is on a footnote reference, jump to the definition. When it | |
1469 | is at a definition, jump to the (first) reference. | |
1470 | ||
c8d0cf5c CD |
1471 | @vindex org-footnote-define-inline |
1472 | @vindex org-footnote-section | |
1473 | @vindex org-footnote-auto-adjust | |
55e0839d CD |
1474 | Otherwise, create a new footnote. Depending on the variable |
1475 | @code{org-footnote-define-inline}@footnote{The corresponding in-buffer | |
1476 | setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the | |
1477 | definition will be placed right into the text as part of the reference, or | |
1478 | separately into the location determined by the variable | |
1479 | @code{org-footnote-section}. | |
1480 | ||
1481 | When this command is called with a prefix argument, a menu of additional | |
1482 | options is offered: | |
1483 | @example | |
1484 | s @r{Sort the footnote definitions by reference sequence. During editing,} | |
1485 | @r{Org makes no effort to sort footnote definitions into a particular} | |
1486 | @r{sequence. If you want them sorted, use this command, which will} | |
c8d0cf5c CD |
1487 | @r{also move entries according to @code{org-footnote-section}. Automatic} |
1488 | @r{sorting after each insertion/deletion can be configured using the} | |
1489 | @r{variable @code{org-footnote-auto-adjust}.} | |
1490 | r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering} | |
1491 | @r{after each insertion/deletion can be configured using the variable} | |
1492 | @r{@code{org-footnote-auto-adjust}.} | |
1493 | S @r{Short for first @code{r}, then @code{s} action.} | |
55e0839d CD |
1494 | n @r{Normalize the footnotes by collecting all definitions (including} |
1495 | @r{inline definitions) into a special section, and then numbering them} | |
1496 | @r{in sequence. The references will then also be numbers. This is} | |
1497 | @r{meant to be the final step before finishing a document (e.g. sending} | |
1498 | @r{off an email). The exporters do this automatically, and so could} | |
1499 | @r{something like @code{message-send-hook}.} | |
1500 | d @r{Delete the footnote at point, and all definitions of and references} | |
1501 | @r{to it.} | |
1502 | @end example | |
c8d0cf5c CD |
1503 | Depending on the variable @code{org-footnote-auto-adjust}@footnote{the |
1504 | corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.}, | |
1505 | renumbering and sorting footnotes can be automatic after each insertion or | |
1506 | deletion. | |
1507 | ||
55e0839d CD |
1508 | @kindex C-c C-c |
1509 | @item C-c C-c | |
1510 | If the cursor is on a footnote reference, jump to the definition. If it is a | |
1511 | the definition, jump back to the reference. When called at a footnote | |
1512 | location with a prefix argument, offer the same menu as @kbd{C-c C-x f}. | |
1513 | @kindex C-c C-o | |
1514 | @kindex mouse-1 | |
1515 | @kindex mouse-2 | |
c8d0cf5c | 1516 | @item C-c C-o @r{or} mouse-1/2 |
55e0839d CD |
1517 | Footnote labels are also links to the corresponding definition/reference, and |
1518 | you can use the usual commands to follow these links. | |
1519 | @end table | |
1520 | ||
1521 | @node Orgstruct mode, , Footnotes, Document Structure | |
4009494e | 1522 | @section The Orgstruct minor mode |
a7808fba | 1523 | @cindex Orgstruct mode |
4009494e GM |
1524 | @cindex minor mode for structure editing |
1525 | ||
a7808fba | 1526 | If you like the intuitive way the Org mode structure editing and list |
c8d0cf5c CD |
1527 | formatting works, you might want to use these commands in other modes like |
1528 | Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes | |
1529 | this possible. Toggle the mode with @kbd{M-x orgstruct-mode}, or | |
1530 | turn it on by default, for example in Mail mode, with one of: | |
4009494e GM |
1531 | |
1532 | @lisp | |
1533 | (add-hook 'mail-mode-hook 'turn-on-orgstruct) | |
c8d0cf5c | 1534 | (add-hook 'mail-mode-hook 'turn-on-orgstruct++) |
4009494e GM |
1535 | @end lisp |
1536 | ||
c8d0cf5c CD |
1537 | When this mode is active and the cursor is on a line that looks to Org like a |
1538 | headline or the first line of a list item, most structure editing commands | |
1539 | will work, even if the same keys normally have different functionality in the | |
1540 | major mode you are using. If the cursor is not in one of those special | |
1541 | lines, Orgstruct mode lurks silently in the shadow. When you use | |
1542 | @code{orgstruct++-mode}, Org will also export indentation and autofill | |
1543 | settings into that mode, and detect item context after the first line of an | |
1544 | item. | |
4009494e | 1545 | |
a7808fba | 1546 | @node Tables, Hyperlinks, Document Structure, Top |
4009494e GM |
1547 | @chapter Tables |
1548 | @cindex tables | |
1549 | @cindex editing tables | |
1550 | ||
a7808fba | 1551 | Org comes with a fast and intuitive table editor. Spreadsheet-like |
dbc28aaa | 1552 | calculations are supported in connection with the Emacs @file{calc} |
28a16a1b | 1553 | package |
dbc28aaa | 1554 | @ifinfo |
a7808fba | 1555 | (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}). |
dbc28aaa CD |
1556 | @end ifinfo |
1557 | @ifnotinfo | |
1558 | (see the Emacs Calculator manual for more information about the Emacs | |
1559 | calculator). | |
1560 | @end ifnotinfo | |
4009494e GM |
1561 | |
1562 | @menu | |
1563 | * Built-in table editor:: Simple tables | |
c8d0cf5c | 1564 | * Column width and alignment:: Overrule the automatic settings |
4009494e | 1565 | * Column groups:: Grouping to trigger vertical lines |
a7808fba CD |
1566 | * Orgtbl mode:: The table editor as minor mode |
1567 | * The spreadsheet:: The table editor has spreadsheet capabilities | |
c8d0cf5c | 1568 | * Org-Plot:: Plotting from org tables |
4009494e GM |
1569 | @end menu |
1570 | ||
c8d0cf5c | 1571 | @node Built-in table editor, Column width and alignment, Tables, Tables |
4009494e GM |
1572 | @section The built-in table editor |
1573 | @cindex table editor, built-in | |
1574 | ||
a7808fba | 1575 | Org makes it easy to format tables in plain ASCII. Any line with |
4009494e GM |
1576 | @samp{|} as the first non-whitespace character is considered part of a |
1577 | table. @samp{|} is also the column separator. A table might look like | |
1578 | this: | |
1579 | ||
1580 | @example | |
1581 | | Name | Phone | Age | | |
1582 | |-------+-------+-----| | |
1583 | | Peter | 1234 | 17 | | |
1584 | | Anna | 4321 | 25 | | |
1585 | @end example | |
1586 | ||
1587 | A table is re-aligned automatically each time you press @key{TAB} or | |
1588 | @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to | |
1589 | the next field (@key{RET} to the next row) and creates new table rows | |
1590 | at the end of the table or before horizontal lines. The indentation | |
1591 | of the table is set by the first line. Any line starting with | |
1592 | @samp{|-} is considered as a horizontal separator line and will be | |
1593 | expanded on the next re-align to span the whole table width. So, to | |
1594 | create the above table, you would only type | |
1595 | ||
1596 | @example | |
1597 | |Name|Phone|Age| | |
1598 | |- | |
1599 | @end example | |
1600 | ||
1601 | @noindent and then press @key{TAB} to align the table and start filling in | |
55e0839d CD |
1602 | fields. Even faster would be to type @code{|Name|Phone|Age} followed by |
1603 | @kbd{C-c @key{RET}}. | |
4009494e | 1604 | |
c8d0cf5c CD |
1605 | @vindex org-enable-table-editor |
1606 | @vindex org-table-auto-blank-field | |
a7808fba | 1607 | When typing text into a field, Org treats @key{DEL}, |
4009494e GM |
1608 | @key{Backspace}, and all character keys in a special way, so that |
1609 | inserting and deleting avoids shifting other fields. Also, when | |
1610 | typing @emph{immediately after the cursor was moved into a new field | |
1611 | with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the | |
1612 | field is automatically made blank. If this behavior is too | |
1613 | unpredictable for you, configure the variables | |
1614 | @code{org-enable-table-editor} and @code{org-table-auto-blank-field}. | |
1615 | ||
1616 | @table @kbd | |
1617 | @tsubheading{Creation and conversion} | |
1618 | @kindex C-c | | |
1619 | @item C-c | | |
1620 | Convert the active region to table. If every line contains at least one | |
1621 | TAB character, the function assumes that the material is tab separated. | |
dbc28aaa | 1622 | If every line contains a comma, comma-separated values (CSV) are assumed. |
4009494e | 1623 | If not, lines are split at whitespace into fields. You can use a prefix |
dbc28aaa CD |
1624 | argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u |
1625 | C-u} forces TAB, and a numeric argument N indicates that at least N | |
a7808fba | 1626 | consecutive spaces, or alternatively a TAB will be the separator. |
28a16a1b | 1627 | @* |
a7808fba | 1628 | If there is no active region, this command creates an empty Org |
4009494e GM |
1629 | table. But it's easier just to start typing, like |
1630 | @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}. | |
1631 | ||
1632 | @tsubheading{Re-aligning and field motion} | |
1633 | @kindex C-c C-c | |
1634 | @item C-c C-c | |
1635 | Re-align the table without moving the cursor. | |
1636 | @c | |
1637 | @kindex @key{TAB} | |
1638 | @item @key{TAB} | |
1639 | Re-align the table, move to the next field. Creates a new row if | |
1640 | necessary. | |
1641 | @c | |
1642 | @kindex S-@key{TAB} | |
1643 | @item S-@key{TAB} | |
1644 | Re-align, move to previous field. | |
1645 | @c | |
1646 | @kindex @key{RET} | |
1647 | @item @key{RET} | |
1648 | Re-align the table and move down to next row. Creates a new row if | |
1649 | necessary. At the beginning or end of a line, @key{RET} still does | |
1650 | NEWLINE, so it can be used to split a table. | |
c8d0cf5c CD |
1651 | @c |
1652 | @kindex M-a | |
1653 | @item M-a | |
1654 | Move to beginning of the current table field, or on to the previous field. | |
1655 | @kindex M-e | |
1656 | @item M-e | |
1657 | Move to end of the current table field, or on to the next field. | |
4009494e GM |
1658 | |
1659 | @tsubheading{Column and row editing} | |
1660 | @kindex M-@key{left} | |
1661 | @kindex M-@key{right} | |
1662 | @item M-@key{left} | |
1663 | @itemx M-@key{right} | |
1664 | Move the current column left/right. | |
1665 | @c | |
1666 | @kindex M-S-@key{left} | |
1667 | @item M-S-@key{left} | |
1668 | Kill the current column. | |
1669 | @c | |
1670 | @kindex M-S-@key{right} | |
1671 | @item M-S-@key{right} | |
1672 | Insert a new column to the left of the cursor position. | |
1673 | @c | |
1674 | @kindex M-@key{up} | |
1675 | @kindex M-@key{down} | |
1676 | @item M-@key{up} | |
1677 | @itemx M-@key{down} | |
1678 | Move the current row up/down. | |
1679 | @c | |
1680 | @kindex M-S-@key{up} | |
1681 | @item M-S-@key{up} | |
1682 | Kill the current row or horizontal line. | |
1683 | @c | |
1684 | @kindex M-S-@key{down} | |
1685 | @item M-S-@key{down} | |
a7808fba CD |
1686 | Insert a new row above the current row. With a prefix argument, the line is |
1687 | created below the current one. | |
4009494e GM |
1688 | @c |
1689 | @kindex C-c - | |
1690 | @item C-c - | |
2096a1b6 | 1691 | Insert a horizontal line below current row. With a prefix argument, the line |
4009494e GM |
1692 | is created above the current line. |
1693 | @c | |
55e0839d CD |
1694 | @kindex C-c @key{RET} |
1695 | @item C-c @key{RET} | |
2096a1b6 | 1696 | Insert a horizontal line below current row, and move the cursor into the row |
55e0839d CD |
1697 | below that line. |
1698 | @c | |
4009494e GM |
1699 | @kindex C-c ^ |
1700 | @item C-c ^ | |
1701 | Sort the table lines in the region. The position of point indicates the | |
1702 | column to be used for sorting, and the range of lines is the range | |
1703 | between the nearest horizontal separator lines, or the entire table. If | |
1704 | point is before the first column, you will be prompted for the sorting | |
1705 | column. If there is an active region, the mark specifies the first line | |
1706 | and the sorting column, while point should be in the last line to be | |
1707 | included into the sorting. The command prompts for the sorting type | |
1708 | (alphabetically, numerically, or by time). When called with a prefix | |
1709 | argument, alphabetic sorting will be case-sensitive. | |
1710 | ||
1711 | @tsubheading{Regions} | |
1712 | @kindex C-c C-x M-w | |
1713 | @item C-c C-x M-w | |
c8d0cf5c CD |
1714 | Copy a rectangular region from a table to a special clipboard. Point and |
1715 | mark determine edge fields of the rectangle. If there is no active region, | |
1716 | copy just the current field. The process ignores horizontal separator lines. | |
4009494e GM |
1717 | @c |
1718 | @kindex C-c C-x C-w | |
1719 | @item C-c C-x C-w | |
1720 | Copy a rectangular region from a table to a special clipboard, and | |
1721 | blank all fields in the rectangle. So this is the ``cut'' operation. | |
1722 | @c | |
1723 | @kindex C-c C-x C-y | |
1724 | @item C-c C-x C-y | |
1725 | Paste a rectangular region into a table. | |
864c9740 | 1726 | The upper left corner ends up in the current field. All involved fields |
4009494e GM |
1727 | will be overwritten. If the rectangle does not fit into the present table, |
1728 | the table is enlarged as needed. The process ignores horizontal separator | |
1729 | lines. | |
1730 | @c | |
28a16a1b | 1731 | @kindex M-@key{RET} |
28a16a1b | 1732 | @itemx M-@kbd{RET} |
4009494e GM |
1733 | Wrap several fields in a column like a paragraph. If there is an active |
1734 | region, and both point and mark are in the same column, the text in the | |
a7808fba CD |
1735 | column is wrapped to minimum width for the given number of lines. A numeric |
1736 | prefix argument may be used to change the number of desired lines. If there | |
1737 | is no region, the current field is split at the cursor position and the text | |
1738 | fragment to the right of the cursor is prepended to the field one line | |
1739 | down. If there is no region, but you specify a prefix argument, the current | |
1740 | field is made blank, and the content is appended to the field above. | |
4009494e GM |
1741 | |
1742 | @tsubheading{Calculations} | |
1743 | @cindex formula, in tables | |
1744 | @cindex calculations, in tables | |
1745 | @cindex region, active | |
1746 | @cindex active region | |
c8d0cf5c | 1747 | @cindex transient mark mode |
4009494e GM |
1748 | @kindex C-c + |
1749 | @item C-c + | |
1750 | Sum the numbers in the current column, or in the rectangle defined by | |
1751 | the active region. The result is shown in the echo area and can | |
1752 | be inserted with @kbd{C-y}. | |
1753 | @c | |
1754 | @kindex S-@key{RET} | |
1755 | @item S-@key{RET} | |
c8d0cf5c | 1756 | @vindex org-table-copy-increment |
864c9740 CD |
1757 | When current field is empty, copy from first non-empty field above. When not |
1758 | empty, copy current field down to next row and move cursor along with it. | |
1759 | Depending on the variable @code{org-table-copy-increment}, integer field | |
1760 | values will be incremented during copy. Integers that are too large will not | |
a50253cc | 1761 | be incremented. Also, a @code{0} prefix argument temporarily disables the |
c8d0cf5c CD |
1762 | increment. This key is also used by shift-selection and related modes |
1763 | (@pxref{Conflicts}). | |
4009494e GM |
1764 | |
1765 | @tsubheading{Miscellaneous} | |
1766 | @kindex C-c ` | |
1767 | @item C-c ` | |
c8d0cf5c CD |
1768 | Edit the current field in a separate window. This is useful for fields that |
1769 | are not fully visible (@pxref{Column width and alignment}). When called with | |
1770 | a @kbd{C-u} prefix, just make the full field visible, so that it can be | |
4009494e GM |
1771 | edited in place. |
1772 | @c | |
4009494e | 1773 | @item M-x org-table-import |
c8d0cf5c CD |
1774 | Import a file as a table. The table should be TAB or whitespace |
1775 | separated. Use, for example, to import a spreadsheet table or data | |
dbc28aaa CD |
1776 | from a database, because these programs generally can write |
1777 | TAB-separated text files. This command works by inserting the file into | |
1778 | the buffer and then converting the region to a table. Any prefix | |
1779 | argument is passed on to the converter, which uses it to determine the | |
1780 | separator. | |
4009494e | 1781 | @item C-c | |
a7808fba | 1782 | Tables can also be imported by pasting tabular text into the Org |
4009494e | 1783 | buffer, selecting the pasted text with @kbd{C-x C-x} and then using the |
44ce9197 | 1784 | @kbd{C-c |} command (see above under @i{Creation and conversion}). |
4009494e GM |
1785 | @c |
1786 | @item M-x org-table-export | |
c8d0cf5c CD |
1787 | @vindex org-table-export-default-format |
1788 | Export the table, by default as a TAB-separated file. Use for data | |
a7808fba CD |
1789 | exchange with, for example, spreadsheet or database programs. The format |
1790 | used to export the file can be configured in the variable | |
1791 | @code{org-table-export-default-format}. You may also use properties | |
1792 | @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file | |
b349f79f CD |
1793 | name and the format for table export in a subtree. Org supports quite |
1794 | general formats for exported tables. The exporter format is the same as the | |
c8d0cf5c | 1795 | format used by Orgtbl radio tables, see @ref{Translator functions}, for a |
b349f79f | 1796 | detailed description. |
4009494e GM |
1797 | @end table |
1798 | ||
1799 | If you don't like the automatic table editor because it gets in your | |
1800 | way on lines which you would like to start with @samp{|}, you can turn | |
1801 | it off with | |
1802 | ||
1803 | @lisp | |
1804 | (setq org-enable-table-editor nil) | |
1805 | @end lisp | |
1806 | ||
1807 | @noindent Then the only table command that still works is | |
1808 | @kbd{C-c C-c} to do a manual re-align. | |
1809 | ||
c8d0cf5c CD |
1810 | @node Column width and alignment, Column groups, Built-in table editor, Tables |
1811 | @section Column width and alignment | |
4009494e | 1812 | @cindex narrow columns in tables |
c8d0cf5c CD |
1813 | @cindex alignment in tables |
1814 | ||
1815 | The width of columns is automatically determined by the table editor. And | |
1816 | also the alignment of a column is determined automatically from the fraction | |
1817 | of number-like versus non-number fields in the column. | |
4009494e | 1818 | |
4009494e GM |
1819 | Sometimes a single field or a few fields need to carry more text, |
1820 | leading to inconveniently wide columns. To limit@footnote{This feature | |
1821 | does not work on XEmacs.} the width of a column, one field anywhere in | |
1822 | the column may contain just the string @samp{<N>} where @samp{N} is an | |
1823 | integer specifying the width of the column in characters. The next | |
1824 | re-align will then set the width of this column to no more than this | |
1825 | value. | |
1826 | ||
1827 | @example | |
1828 | @group | |
1829 | |---+------------------------------| |---+--------| | |
1830 | | | | | | <6> | | |
1831 | | 1 | one | | 1 | one | | |
1832 | | 2 | two | ----\ | 2 | two | | |
1833 | | 3 | This is a long chunk of text | ----/ | 3 | This=> | | |
1834 | | 4 | four | | 4 | four | | |
1835 | |---+------------------------------| |---+--------| | |
1836 | @end group | |
1837 | @end example | |
1838 | ||
1839 | @noindent | |
1840 | Fields that are wider become clipped and end in the string @samp{=>}. | |
1841 | Note that the full text is still in the buffer, it is only invisible. | |
c8d0cf5c | 1842 | To see the full text, hold the mouse over the field---a tool-tip window |
4009494e GM |
1843 | will show the full content. To edit such a field, use the command |
1844 | @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will | |
1845 | open a new window with the full field. Edit it and finish with @kbd{C-c | |
1846 | C-c}. | |
1847 | ||
c8d0cf5c | 1848 | @vindex org-startup-align-all-tables |
4009494e GM |
1849 | When visiting a file containing a table with narrowed columns, the |
1850 | necessary character hiding has not yet happened, and the table needs to | |
1851 | be aligned before it looks nice. Setting the option | |
1852 | @code{org-startup-align-all-tables} will realign all tables in a file | |
1853 | upon visiting, but also slow down startup. You can also set this option | |
1854 | on a per-file basis with: | |
1855 | ||
1856 | @example | |
1857 | #+STARTUP: align | |
1858 | #+STARTUP: noalign | |
1859 | @end example | |
1860 | ||
c8d0cf5c CD |
1861 | If you would like to overrule the automatic alignment of number-rich columns |
1862 | to the right and of string-rich column to the left, you and use @samp{<r>} or | |
1863 | @samp{<l>} in a similar fashion. You may also combine alignment and field | |
1864 | width like this: @samp{<l10>}. | |
1865 | ||
1866 | @node Column groups, Orgtbl mode, Column width and alignment, Tables | |
4009494e GM |
1867 | @section Column groups |
1868 | @cindex grouping columns in tables | |
1869 | ||
a7808fba | 1870 | When Org exports tables, it does so by default without vertical |
4009494e GM |
1871 | lines because that is visually more satisfying in general. Occasionally |
1872 | however, vertical lines can be useful to structure a table into groups | |
1873 | of columns, much like horizontal lines can do for groups of rows. In | |
1874 | order to specify column groups, you can use a special row where the | |
1875 | first field contains only @samp{/}. The further fields can either | |
1876 | contain @samp{<} to indicate that this column should start a group, | |
1877 | @samp{>} to indicate the end of a column, or @samp{<>} to make a column | |
a7808fba | 1878 | a group of its own. Boundaries between column groups will upon export be |
4009494e GM |
1879 | marked with vertical lines. Here is an example: |
1880 | ||
1881 | @example | |
1882 | | | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) | | |
1883 | |---+----+-----+-----+-----+---------+------------| | |
1884 | | / | <> | < | | > | < | > | | |
1885 | | # | 1 | 1 | 1 | 1 | 1 | 1 | | |
1886 | | # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 | | |
1887 | | # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 | | |
1888 | |---+----+-----+-----+-----+---------+------------| | |
44ce9197 | 1889 | #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2))) |
4009494e GM |
1890 | @end example |
1891 | ||
a7808fba | 1892 | It is also sufficient to just insert the column group starters after |
4009494e GM |
1893 | every vertical line you'd like to have: |
1894 | ||
1895 | @example | |
1896 | | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) | | |
1897 | |----+-----+-----+-----+---------+------------| | |
1898 | | / | < | | | < | | | |
1899 | @end example | |
1900 | ||
a7808fba | 1901 | @node Orgtbl mode, The spreadsheet, Column groups, Tables |
4009494e | 1902 | @section The Orgtbl minor mode |
a7808fba | 1903 | @cindex Orgtbl mode |
4009494e GM |
1904 | @cindex minor mode for tables |
1905 | ||
a7808fba CD |
1906 | If you like the intuitive way the Org table editor works, you |
1907 | might also want to use it in other modes like Text mode or Mail mode. | |
1908 | The minor mode Orgtbl mode makes this possible. You can always toggle | |
4009494e GM |
1909 | the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for |
1910 | example in mail mode, use | |
1911 | ||
1912 | @lisp | |
1913 | (add-hook 'mail-mode-hook 'turn-on-orgtbl) | |
1914 | @end lisp | |
1915 | ||
1916 | Furthermore, with some special setup, it is possible to maintain tables | |
a7808fba | 1917 | in arbitrary syntax with Orgtbl mode. For example, it is possible to |
4009494e | 1918 | construct La@TeX{} tables with the underlying ease and power of |
a7808fba | 1919 | Orgtbl mode, including spreadsheet capabilities. For details, see |
4009494e GM |
1920 | @ref{Tables in arbitrary syntax}. |
1921 | ||
c8d0cf5c | 1922 | @node The spreadsheet, Org-Plot, Orgtbl mode, Tables |
4009494e GM |
1923 | @section The spreadsheet |
1924 | @cindex calculations, in tables | |
1925 | @cindex spreadsheet capabilities | |
1926 | @cindex @file{calc} package | |
1927 | ||
1928 | The table editor makes use of the Emacs @file{calc} package to implement | |
1929 | spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to | |
a7808fba | 1930 | derive fields from other fields. While fully featured, Org's |
4009494e | 1931 | implementation is not identical to other spreadsheets. For example, |
a7808fba | 1932 | Org knows the concept of a @emph{column formula} that will be |
4009494e GM |
1933 | applied to all non-header fields in a column without having to copy the |
1934 | formula to each relevant field. | |
1935 | ||
1936 | @menu | |
1937 | * References:: How to refer to another field or range | |
1938 | * Formula syntax for Calc:: Using Calc to compute stuff | |
1939 | * Formula syntax for Lisp:: Writing formulas in Emacs Lisp | |
1940 | * Field formulas:: Formulas valid for a single field | |
1941 | * Column formulas:: Formulas valid for an entire column | |
1942 | * Editing and debugging formulas:: Fixing formulas | |
1943 | * Updating the table:: Recomputing all dependent fields | |
1944 | * Advanced features:: Field names, parameters and automatic recalc | |
1945 | @end menu | |
1946 | ||
1947 | @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet | |
1948 | @subsection References | |
1949 | @cindex references | |
1950 | ||
1951 | To compute fields in the table from other fields, formulas must | |
a7808fba | 1952 | reference other fields or ranges. In Org, fields can be referenced |
4009494e GM |
1953 | by name, by absolute coordinates, and by relative coordinates. To find |
1954 | out what the coordinates of a field are, press @kbd{C-c ?} in that | |
1955 | field, or press @kbd{C-c @}} to toggle the display of a grid. | |
1956 | ||
1957 | @subsubheading Field references | |
1958 | @cindex field references | |
1959 | @cindex references, to fields | |
1960 | ||
1961 | Formulas can reference the value of another field in two ways. Like in | |
1962 | any other spreadsheet, you may reference fields with a letter/number | |
1963 | combination like @code{B3}, meaning the 2nd field in the 3rd row. | |
1964 | @c Such references are always fixed to that field, they don't change | |
1965 | @c when you copy and paste a formula to a different field. So | |
a7808fba | 1966 | @c Org's @code{B3} behaves like @code{$B$3} in other spreadsheets. |
4009494e GM |
1967 | |
1968 | @noindent | |
a7808fba | 1969 | Org also uses another, more general operator that looks like this: |
4009494e | 1970 | @example |
c8d0cf5c | 1971 | @@@var{row}$@var{column} |
4009494e GM |
1972 | @end example |
1973 | ||
1974 | @noindent | |
c8d0cf5c | 1975 | Column references can be absolute like @samp{1}, @samp{2},...@samp{@var{N}}, |
73ef3bde | 1976 | or relative to the current column like @samp{+1} or @samp{-2}. |
4009494e GM |
1977 | |
1978 | The row specification only counts data lines and ignores horizontal | |
1979 | separator lines (hlines). You can use absolute row numbers | |
c8d0cf5c | 1980 | @samp{1}...@samp{@var{N}}, and row numbers relative to the current row like |
4009494e | 1981 | @samp{+3} or @samp{-1}. Or specify the row relative to one of the |
dbc28aaa CD |
1982 | hlines: @samp{I} refers to the first hline@footnote{Note that only |
1983 | hlines are counted that @emph{separate} table lines. If the table | |
1984 | starts with a hline above the header, it does not count.}, @samp{II} to | |
c8d0cf5c | 1985 | the second, etc@. @samp{-I} refers to the first such line above the |
dbc28aaa CD |
1986 | current line, @samp{+I} to the first such line below the current line. |
1987 | You can also write @samp{III+2} which is the second data line after the | |
c8d0cf5c | 1988 | third hline in the table. |
4009494e GM |
1989 | |
1990 | @samp{0} refers to the current row and column. Also, if you omit | |
1991 | either the column or the row part of the reference, the current | |
28a16a1b | 1992 | row/column is implied. |
4009494e | 1993 | |
a7808fba | 1994 | Org's references with @emph{unsigned} numbers are fixed references |
4009494e GM |
1995 | in the sense that if you use the same reference in the formula for two |
1996 | different fields, the same field will be referenced each time. | |
a7808fba | 1997 | Org's references with @emph{signed} numbers are floating |
4009494e GM |
1998 | references because the same reference operator can reference different |
1999 | fields depending on the field being calculated by the formula. | |
2000 | ||
c8d0cf5c CD |
2001 | As a special case, references like @samp{$LR5} and @samp{$LR12} can be used |
2002 | to refer in a stable way to the 5th and 12th field in the last row of the | |
55e0839d | 2003 | table. |
b6cb4cd5 | 2004 | |
4009494e GM |
2005 | Here are a few examples: |
2006 | ||
2007 | @example | |
2008 | @@2$3 @r{2nd row, 3rd column} | |
2009 | C2 @r{same as previous} | |
2010 | $5 @r{column 5 in the current row} | |
2011 | E& @r{same as previous} | |
2012 | @@2 @r{current column, row 2} | |
2013 | @@-1$-3 @r{the field one row up, three columns to the left} | |
2014 | @@-I$2 @r{field just under hline above current row, column 2} | |
2015 | @end example | |
2016 | ||
2017 | @subsubheading Range references | |
2018 | @cindex range references | |
2019 | @cindex references, to ranges | |
2020 | ||
2021 | You may reference a rectangular range of fields by specifying two field | |
2022 | references connected by two dots @samp{..}. If both fields are in the | |
2023 | current row, you may simply use @samp{$2..$7}, but if at least one field | |
2024 | is in a different row, you need to use the general @code{@@row$column} | |
2025 | format at least for the first field (i.e the reference must start with | |
2026 | @samp{@@} in order to be interpreted correctly). Examples: | |
2027 | ||
2028 | @example | |
2029 | $1..$3 @r{First three fields in the current row.} | |
2030 | $P..$Q @r{Range, using column names (see under Advanced)} | |
2031 | @@2$1..@@4$3 @r{6 fields between these two fields.} | |
2032 | A2..C4 @r{Same as above.} | |
2033 | @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row} | |
2034 | @end example | |
2035 | ||
2036 | @noindent Range references return a vector of values that can be fed | |
2037 | into Calc vector functions. Empty fields in ranges are normally | |
2038 | suppressed, so that the vector contains only the non-empty fields (but | |
2039 | see the @samp{E} mode switch below). If there are no non-empty fields, | |
2040 | @samp{[0]} is returned to avoid syntax errors in formulas. | |
2041 | ||
2042 | @subsubheading Named references | |
2043 | @cindex named references | |
2044 | @cindex references, named | |
2045 | @cindex name, of column or field | |
2046 | @cindex constants, in calculations | |
c8d0cf5c | 2047 | @cindex #+CONSTANTS |
4009494e | 2048 | |
c8d0cf5c | 2049 | @vindex org-table-formula-constants |
4009494e GM |
2050 | @samp{$name} is interpreted as the name of a column, parameter or |
2051 | constant. Constants are defined globally through the variable | |
2052 | @code{org-table-formula-constants}, and locally (for the file) through a | |
2053 | line like | |
2054 | ||
2055 | @example | |
2056 | #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6 | |
2057 | @end example | |
2058 | ||
2059 | @noindent | |
c8d0cf5c CD |
2060 | @vindex constants-unit-system |
2061 | @pindex constants.el | |
a7808fba | 2062 | Also properties (@pxref{Properties and Columns}) can be used as |
c8d0cf5c | 2063 | constants in table formulas: for a property @samp{:Xyz:} use the name |
dbc28aaa | 2064 | @samp{$PROP_Xyz}, and the property will be searched in the current |
4009494e GM |
2065 | outline entry and in the hierarchy above it. If you have the |
2066 | @file{constants.el} package, it will also be used to resolve constants, | |
2067 | including natural constants like @samp{$h} for Planck's constant, and | |
c8d0cf5c | 2068 | units like @samp{$km} for kilometers@footnote{@file{constants.el} can |
4009494e GM |
2069 | supply the values of constants in two different unit systems, @code{SI} |
2070 | and @code{cgs}. Which one is used depends on the value of the variable | |
2071 | @code{constants-unit-system}. You can use the @code{#+STARTUP} options | |
2072 | @code{constSI} and @code{constcgs} to set this value for the current | |
2073 | buffer.}. Column names and parameters can be specified in special table | |
2074 | lines. These are described below, see @ref{Advanced features}. All | |
2075 | names must start with a letter, and further consist of letters and | |
2076 | numbers. | |
2077 | ||
55e0839d CD |
2078 | @subsubheading Remote references |
2079 | @cindex remote references | |
2080 | @cindex references, remote | |
2081 | @cindex references, to a different table | |
2082 | @cindex name, of column or field | |
2083 | @cindex constants, in calculations | |
c8d0cf5c | 2084 | @cindex #+TBLNAME |
55e0839d CD |
2085 | |
2086 | You may also reference constants, fields and ranges from a different table, | |
2087 | either in the current file or even in a different file. The syntax is | |
2088 | ||
2089 | @example | |
2090 | remote(NAME-OR-ID,REF) | |
2091 | @end example | |
2092 | ||
2093 | @noindent | |
2094 | where NAME can be the name of a table in the current file as set by a | |
2095 | @code{#+TBLNAME: NAME} line before the table. It can also be the ID of an | |
2096 | entry, even in a different file, and the reference then refers to the first | |
2097 | table in that entry. REF is an absolute field or range reference as | |
c8d0cf5c CD |
2098 | described above for example @code{@@3$3} or @code{$somename}, valid in the |
2099 | referenced table. | |
55e0839d | 2100 | |
4009494e GM |
2101 | @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet |
2102 | @subsection Formula syntax for Calc | |
2103 | @cindex formula syntax, Calc | |
2104 | @cindex syntax, of formulas | |
2105 | ||
2106 | A formula can be any algebraic expression understood by the Emacs | |
2107 | @file{Calc} package. @b{Note that @file{calc} has the | |
2108 | non-standard convention that @samp{/} has lower precedence than | |
2109 | @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before | |
2110 | evaluation by @code{calc-eval} (@pxref{Calling Calc from | |
a7808fba | 2111 | Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU |
4009494e | 2112 | Emacs Calc Manual}), |
a7808fba | 2113 | @c FIXME: The link to the Calc manual in HTML does not work. |
4009494e GM |
2114 | variable substitution takes place according to the rules described above. |
2115 | @cindex vectors, in table calculations | |
a7808fba | 2116 | The range vectors can be directly fed into the Calc vector functions |
4009494e GM |
2117 | like @samp{vmean} and @samp{vsum}. |
2118 | ||
2119 | @cindex format specifier | |
2120 | @cindex mode, for @file{calc} | |
c8d0cf5c | 2121 | @vindex org-calc-default-modes |
4009494e GM |
2122 | A formula can contain an optional mode string after a semicolon. This |
2123 | string consists of flags to influence Calc and other modes during | |
a7808fba | 2124 | execution. By default, Org uses the standard Calc modes (precision |
44ce9197 | 2125 | 12, angular units degrees, fraction and symbolic modes off). The display |
c8d0cf5c | 2126 | format, however, has been changed to @code{(float 8)} to keep tables |
4009494e GM |
2127 | compact. The default settings can be configured using the variable |
2128 | @code{org-calc-default-modes}. | |
2129 | ||
2130 | @example | |
2131 | p20 @r{switch the internal precision to 20 digits} | |
2132 | n3 s3 e2 f4 @r{normal, scientific, engineering, or fixed display format} | |
2133 | D R @r{angle modes: degrees, radians} | |
2134 | F S @r{fraction and symbolic modes} | |
2135 | N @r{interpret all fields as numbers, use 0 for non-numbers} | |
2136 | T @r{force text interpretation} | |
2137 | E @r{keep empty fields in ranges} | |
c8d0cf5c | 2138 | L @r{literal} |
4009494e GM |
2139 | @end example |
2140 | ||
2141 | @noindent | |
2142 | In addition, you may provide a @code{printf} format specifier to | |
2143 | reformat the final result. A few examples: | |
2144 | ||
2145 | @example | |
2146 | $1+$2 @r{Sum of first and second field} | |
2147 | $1+$2;%.2f @r{Same, format result to two decimals} | |
2148 | exp($2)+exp($1) @r{Math functions can be used} | |
2149 | $0;%.1f @r{Reformat current cell to 1 decimal} | |
2150 | ($3-32)*5/9 @r{Degrees F -> C conversion} | |
2151 | $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}} | |
2152 | tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1} | |
2153 | sin($1);Dp3%.1e @r{Same, but use printf specifier for display} | |
2154 | vmean($2..$7) @r{Compute column range mean, using vector function} | |
2155 | vmean($2..$7);EN @r{Same, but treat empty fields as 0} | |
2156 | taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree} | |
2157 | @end example | |
2158 | ||
2159 | Calc also contains a complete set of logical operations. For example | |
2160 | ||
2161 | @example | |
2162 | if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty} | |
2163 | @end example | |
2164 | ||
2165 | @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet | |
2166 | @subsection Emacs Lisp forms as formulas | |
2167 | @cindex Lisp forms, as table formulas | |
2168 | ||
2169 | It is also possible to write a formula in Emacs Lisp; this can be useful | |
a50253cc | 2170 | for string manipulation and control structures, if Calc's |
c8d0cf5c CD |
2171 | functionality is not enough. If a formula starts with a single-quote |
2172 | followed by an opening parenthesis, then it is evaluated as a Lisp form. | |
4009494e GM |
2173 | The evaluation should return either a string or a number. Just as with |
2174 | @file{calc} formulas, you can specify modes and a printf format after a | |
a7808fba | 2175 | semicolon. With Emacs Lisp forms, you need to be conscious about the way |
4009494e | 2176 | field references are interpolated into the form. By default, a |
c8d0cf5c | 2177 | reference will be interpolated as a Lisp string (in double-quotes) |
4009494e GM |
2178 | containing the field. If you provide the @samp{N} mode switch, all |
2179 | referenced elements will be numbers (non-number fields will be zero) and | |
2180 | interpolated as Lisp numbers, without quotes. If you provide the | |
2181 | @samp{L} flag, all fields will be interpolated literally, without quotes. | |
a351880d | 2182 | I.e., if you want a reference to be interpreted as a string by the Lisp |
c8d0cf5c | 2183 | form, enclose the reference operator itself in double-quotes, like |
4009494e GM |
2184 | @code{"$3"}. Ranges are inserted as space-separated fields, so you can |
2185 | embed them in list or vector syntax. A few examples, note how the | |
c8d0cf5c | 2186 | @samp{N} mode is used when we do computations in Lisp. |
4009494e GM |
2187 | |
2188 | @example | |
2189 | @r{Swap the first two characters of the content of column 1} | |
2190 | '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2)) | |
2096a1b6 | 2191 | @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}} |
4009494e GM |
2192 | '(+ $1 $2);N |
2193 | @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}} | |
2194 | '(apply '+ '($1..$4));N | |
2195 | @end example | |
2196 | ||
2197 | @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet | |
2198 | @subsection Field formulas | |
2199 | @cindex field formula | |
2200 | @cindex formula, for individual table field | |
2201 | ||
2202 | To assign a formula to a particular field, type it directly into the | |
2203 | field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you | |
2204 | press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in | |
2205 | the field, the formula will be stored as the formula for this field, | |
2206 | evaluated, and the current field replaced with the result. | |
2207 | ||
c8d0cf5c | 2208 | @cindex #+TBLFM |
4009494e GM |
2209 | Formulas are stored in a special line starting with @samp{#+TBLFM:} |
2210 | directly below the table. If you typed the equation in the 4th field of | |
2211 | the 3rd data line in the table, the formula will look like | |
2212 | @samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows | |
2213 | with the appropriate commands, @i{absolute references} (but not relative | |
2214 | ones) in stored formulas are modified in order to still reference the | |
c8d0cf5c CD |
2215 | same field. Of course this is not true if you edit the table structure |
2216 | with normal editing commands---then you must fix the equations yourself. | |
2217 | The left-hand side of a formula may also be a named field (@pxref{Advanced | |
b6cb4cd5 | 2218 | features}), or a last-row reference like @samp{$LR3}. |
4009494e GM |
2219 | |
2220 | Instead of typing an equation into the field, you may also use the | |
2221 | following command | |
2222 | ||
2223 | @table @kbd | |
2224 | @kindex C-u C-c = | |
2225 | @item C-u C-c = | |
2226 | Install a new formula for the current field. The command prompts for a | |
c8d0cf5c CD |
2227 | formula with default taken from the @samp{#+TBLFM:} line, applies |
2228 | it to the current field, and stores it. | |
4009494e GM |
2229 | @end table |
2230 | ||
2231 | @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet | |
2232 | @subsection Column formulas | |
2233 | @cindex column formula | |
2234 | @cindex formula, for table column | |
2235 | ||
2236 | Often in a table, the same formula should be used for all fields in a | |
2237 | particular column. Instead of having to copy the formula to all fields | |
c8d0cf5c | 2238 | in that column, Org allows you to assign a single formula to an entire |
4009494e GM |
2239 | column. If the table contains horizontal separator hlines, everything |
2240 | before the first such line is considered part of the table @emph{header} | |
2241 | and will not be modified by column formulas. | |
2242 | ||
2243 | To assign a formula to a column, type it directly into any field in the | |
2244 | column, preceded by an equal sign, like @samp{=$1+$2}. When you press | |
c8d0cf5c CD |
2245 | @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field, |
2246 | the formula will be stored as the formula for the current column, evaluated | |
2247 | and the current field replaced with the result. If the field contains only | |
2248 | @samp{=}, the previously stored formula for this column is used. For each | |
2249 | column, Org will only remember the most recently used formula. In the | |
2250 | @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The left-hand | |
2251 | side of a column formula cannot currently be the name of column, it | |
2252 | must be the numeric column reference. | |
4009494e GM |
2253 | |
2254 | Instead of typing an equation into the field, you may also use the | |
2255 | following command: | |
2256 | ||
2257 | @table @kbd | |
2258 | @kindex C-c = | |
2259 | @item C-c = | |
a7808fba CD |
2260 | Install a new formula for the current column and replace current field with |
2261 | the result of the formula. The command prompts for a formula, with default | |
2262 | taken from the @samp{#+TBLFM} line, applies it to the current field and | |
a351880d | 2263 | stores it. With a numeric prefix argument(e.g. @kbd{C-5 C-c =}) the command |
4009494e GM |
2264 | will apply it to that many consecutive fields in the current column. |
2265 | @end table | |
2266 | ||
4009494e | 2267 | @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet |
a7808fba | 2268 | @subsection Editing and debugging formulas |
4009494e GM |
2269 | @cindex formula editing |
2270 | @cindex editing, of table formulas | |
2271 | ||
c8d0cf5c | 2272 | @vindex org-table-use-standard-references |
4009494e | 2273 | You can edit individual formulas in the minibuffer or directly in the |
a7808fba CD |
2274 | field. Org can also prepare a special buffer with all active |
2275 | formulas of a table. When offering a formula for editing, Org | |
4009494e GM |
2276 | converts references to the standard format (like @code{B3} or @code{D&}) |
2277 | if possible. If you prefer to only work with the internal format (like | |
2278 | @code{@@3$2} or @code{$4}), configure the variable | |
2279 | @code{org-table-use-standard-references}. | |
2280 | ||
2281 | @table @kbd | |
2282 | @kindex C-c = | |
2283 | @kindex C-u C-c = | |
2284 | @item C-c = | |
2285 | @itemx C-u C-c = | |
2286 | Edit the formula associated with the current column/field in the | |
c8d0cf5c | 2287 | minibuffer. See @ref{Column formulas}, and @ref{Field formulas}. |
4009494e GM |
2288 | @kindex C-u C-u C-c = |
2289 | @item C-u C-u C-c = | |
2290 | Re-insert the active formula (either a | |
2291 | field formula, or a column formula) into the current field, so that you | |
2292 | can edit it directly in the field. The advantage over editing in the | |
2293 | minibuffer is that you can use the command @kbd{C-c ?}. | |
2294 | @kindex C-c ? | |
2295 | @item C-c ? | |
2296 | While editing a formula in a table field, highlight the field(s) | |
2297 | referenced by the reference at the cursor position in the formula. | |
2298 | @kindex C-c @} | |
2299 | @item C-c @} | |
2300 | Toggle the display of row and column numbers for a table, using | |
c8d0cf5c | 2301 | overlays. These are updated each time the table is aligned; you can |
4009494e GM |
2302 | force it with @kbd{C-c C-c}. |
2303 | @kindex C-c @{ | |
2304 | @item C-c @{ | |
2305 | Toggle the formula debugger on and off. See below. | |
2306 | @kindex C-c ' | |
2307 | @item C-c ' | |
2308 | Edit all formulas for the current table in a special buffer, where the | |
2309 | formulas will be displayed one per line. If the current field has an | |
2310 | active formula, the cursor in the formula editor will mark it. | |
a7808fba | 2311 | While inside the special buffer, Org will automatically highlight |
4009494e GM |
2312 | any field or range reference at the cursor position. You may edit, |
2313 | remove and add formulas, and use the following commands: | |
2314 | @table @kbd | |
2315 | @kindex C-c C-c | |
2316 | @kindex C-x C-s | |
2317 | @item C-c C-c | |
2318 | @itemx C-x C-s | |
2319 | Exit the formula editor and store the modified formulas. With @kbd{C-u} | |
2320 | prefix, also apply the new formulas to the entire table. | |
2321 | @kindex C-c C-q | |
2322 | @item C-c C-q | |
2323 | Exit the formula editor without installing changes. | |
2324 | @kindex C-c C-r | |
2325 | @item C-c C-r | |
2326 | Toggle all references in the formula editor between standard (like | |
2327 | @code{B3}) and internal (like @code{@@3$2}). | |
2328 | @kindex @key{TAB} | |
2329 | @item @key{TAB} | |
c8d0cf5c CD |
2330 | Pretty-print or indent Lisp formula at point. When in a line containing |
2331 | a Lisp formula, format the formula according to Emacs Lisp rules. | |
4009494e | 2332 | Another @key{TAB} collapses the formula back again. In the open |
c8d0cf5c | 2333 | formula, @key{TAB} re-indents just like in Emacs Lisp mode. |
4009494e GM |
2334 | @kindex M-@key{TAB} |
2335 | @item M-@key{TAB} | |
c8d0cf5c | 2336 | Complete Lisp symbols, just like in Emacs Lisp mode. |
4009494e GM |
2337 | @kindex S-@key{up} |
2338 | @kindex S-@key{down} | |
2339 | @kindex S-@key{left} | |
2340 | @kindex S-@key{right} | |
2341 | @item S-@key{up}/@key{down}/@key{left}/@key{right} | |
2342 | Shift the reference at point. For example, if the reference is | |
2343 | @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}. | |
c8d0cf5c | 2344 | This also works for relative references and for hline references. |
4009494e GM |
2345 | @kindex M-S-@key{up} |
2346 | @kindex M-S-@key{down} | |
2347 | @item M-S-@key{up}/@key{down} | |
a7808fba | 2348 | Move the test line for column formulas in the Org buffer up and |
4009494e GM |
2349 | down. |
2350 | @kindex M-@key{up} | |
2351 | @kindex M-@key{down} | |
2352 | @item M-@key{up}/@key{down} | |
2353 | Scroll the window displaying the table. | |
2354 | @kindex C-c @} | |
2355 | @item C-c @} | |
2356 | Turn the coordinate grid in the table on and off. | |
2357 | @end table | |
2358 | @end table | |
2359 | ||
2360 | Making a table field blank does not remove the formula associated with | |
c8d0cf5c CD |
2361 | the field, because that is stored in a different line (the @samp{#+TBLFM} |
2362 | line)---during the next recalculation the field will be filled again. | |
4009494e GM |
2363 | To remove a formula from a field, you have to give an empty reply when |
2364 | prompted for the formula, or to edit the @samp{#+TBLFM} line. | |
2365 | ||
2366 | @kindex C-c C-c | |
2367 | You may edit the @samp{#+TBLFM} directly and re-apply the changed | |
c8d0cf5c | 2368 | equations with @kbd{C-c C-c} in that line or with the normal |
4009494e GM |
2369 | recalculation commands in the table. |
2370 | ||
2371 | @subsubheading Debugging formulas | |
2372 | @cindex formula debugging | |
2373 | @cindex debugging, of table formulas | |
2374 | When the evaluation of a formula leads to an error, the field content | |
2375 | becomes the string @samp{#ERROR}. If you would like see what is going | |
2376 | on during variable substitution and calculation in order to find a bug, | |
2377 | turn on formula debugging in the @code{Tbl} menu and repeat the | |
2378 | calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a | |
2379 | field. Detailed information will be displayed. | |
2380 | ||
2381 | @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet | |
a7808fba | 2382 | @subsection Updating the table |
4009494e GM |
2383 | @cindex recomputing table fields |
2384 | @cindex updating, table | |
2385 | ||
2386 | Recalculation of a table is normally not automatic, but needs to be | |
c8d0cf5c CD |
2387 | triggered by a command. See @ref{Advanced features}, for a way to make |
2388 | recalculation at least semi-automatic. | |
4009494e GM |
2389 | |
2390 | In order to recalculate a line of a table or the entire table, use the | |
2391 | following commands: | |
2392 | ||
2393 | @table @kbd | |
2394 | @kindex C-c * | |
2395 | @item C-c * | |
2396 | Recalculate the current row by first applying the stored column formulas | |
2397 | from left to right, and all field formulas in the current row. | |
2398 | @c | |
2399 | @kindex C-u C-c * | |
2400 | @item C-u C-c * | |
2401 | @kindex C-u C-c C-c | |
2402 | @itemx C-u C-c C-c | |
2403 | Recompute the entire table, line by line. Any lines before the first | |
2404 | hline are left alone, assuming that these are part of the table header. | |
2405 | @c | |
2406 | @kindex C-u C-u C-c * | |
2407 | @kindex C-u C-u C-c C-c | |
2408 | @item C-u C-u C-c * | |
2409 | @itemx C-u C-u C-c C-c | |
2410 | Iterate the table by recomputing it until no further changes occur. | |
2411 | This may be necessary if some computed fields use the value of other | |
2412 | fields that are computed @i{later} in the calculation sequence. | |
2413 | @end table | |
2414 | ||
2415 | @node Advanced features, , Updating the table, The spreadsheet | |
2416 | @subsection Advanced features | |
2417 | ||
2418 | If you want the recalculation of fields to happen automatically, or if | |
2419 | you want to be able to assign @i{names} to fields and columns, you need | |
2420 | to reserve the first column of the table for special marking characters. | |
2421 | @table @kbd | |
2422 | @kindex C-# | |
2423 | @item C-# | |
a351880d | 2424 | Rotate the calculation mark in first column through the states @samp{ }, |
864c9740 CD |
2425 | @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region, |
2426 | change all marks in the region. | |
4009494e GM |
2427 | @end table |
2428 | ||
2429 | Here is an example of a table that collects exam results of students and | |
2430 | makes use of these features: | |
2431 | ||
2432 | @example | |
2433 | @group | |
2434 | |---+---------+--------+--------+--------+-------+------| | |
2435 | | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note | | |
2436 | |---+---------+--------+--------+--------+-------+------| | |
2437 | | ! | | P1 | P2 | P3 | Tot | | | |
2438 | | # | Maximum | 10 | 15 | 25 | 50 | 10.0 | | |
2439 | | ^ | | m1 | m2 | m3 | mt | | | |
2440 | |---+---------+--------+--------+--------+-------+------| | |
2441 | | # | Peter | 10 | 8 | 23 | 41 | 8.2 | | |
4009494e GM |
2442 | | # | Sam | 2 | 4 | 3 | 9 | 1.8 | |
2443 | |---+---------+--------+--------+--------+-------+------| | |
2444 | | | Average | | | | 29.7 | | | |
2445 | | ^ | | | | | at | | | |
2446 | | $ | max=50 | | | | | | | |
2447 | |---+---------+--------+--------+--------+-------+------| | |
2448 | #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f | |
2449 | @end group | |
2450 | @end example | |
2451 | ||
c8d0cf5c | 2452 | @noindent @b{Important}: please note that for these special tables, |
4009494e GM |
2453 | recalculating the table with @kbd{C-u C-c *} will only affect rows that |
2454 | are marked @samp{#} or @samp{*}, and fields that have a formula assigned | |
2455 | to the field itself. The column formulas are not applied in rows with | |
2456 | empty first field. | |
2457 | ||
2458 | @cindex marking characters, tables | |
2459 | The marking characters have the following meaning: | |
2460 | @table @samp | |
2461 | @item ! | |
2462 | The fields in this line define names for the columns, so that you may | |
2463 | refer to a column as @samp{$Tot} instead of @samp{$6}. | |
2464 | @item ^ | |
2465 | This row defines names for the fields @emph{above} the row. With such | |
2466 | a definition, any formula in the table may use @samp{$m1} to refer to | |
2467 | the value @samp{10}. Also, if you assign a formula to a names field, it | |
2468 | will be stored as @samp{$name=...}. | |
2469 | @item _ | |
2470 | Similar to @samp{^}, but defines names for the fields in the row | |
2471 | @emph{below}. | |
2472 | @item $ | |
2473 | Fields in this row can define @emph{parameters} for formulas. For | |
2474 | example, if a field in a @samp{$} row contains @samp{max=50}, then | |
2475 | formulas in this table can refer to the value 50 using @samp{$max}. | |
2476 | Parameters work exactly like constants, only that they can be defined on | |
2477 | a per-table basis. | |
2478 | @item # | |
2479 | Fields in this row are automatically recalculated when pressing | |
2480 | @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row | |
2481 | is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked | |
2482 | lines will be left alone by this command. | |
2483 | @item * | |
2484 | Selects this line for global recalculation with @kbd{C-u C-c *}, but | |
2485 | not for automatic recalculation. Use this when automatic | |
2486 | recalculation slows down editing too much. | |
2487 | @item | |
2488 | Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}. | |
2489 | All lines that should be recalculated should be marked with @samp{#} | |
2490 | or @samp{*}. | |
2491 | @item / | |
2492 | Do not export this line. Useful for lines that contain the narrowing | |
6eb02347 | 2493 | @samp{<N>} markers or column group markers. |
4009494e GM |
2494 | @end table |
2495 | ||
c8d0cf5c CD |
2496 | Finally, just to whet your appetite for what can be done with the |
2497 | fantastic @file{calc.el} package, here is a table that computes the Taylor | |
28a16a1b CD |
2498 | series of degree @code{n} at location @code{x} for a couple of |
2499 | functions. | |
4009494e GM |
2500 | |
2501 | @example | |
2502 | @group | |
2503 | |---+-------------+---+-----+--------------------------------------| | |
2504 | | | Func | n | x | Result | | |
2505 | |---+-------------+---+-----+--------------------------------------| | |
2506 | | # | exp(x) | 1 | x | 1 + x | | |
2507 | | # | exp(x) | 2 | x | 1 + x + x^2 / 2 | | |
2508 | | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 | | |
2509 | | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 | | |
2510 | | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 | | |
2511 | | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 | | |
2512 | |---+-------------+---+-----+--------------------------------------| | |
2513 | #+TBLFM: $5=taylor($2,$4,$3);n3 | |
2514 | @end group | |
2515 | @end example | |
2516 | ||
c8d0cf5c CD |
2517 | @node Org-Plot, , The spreadsheet, Tables |
2518 | @section Org-Plot | |
864c9740 CD |
2519 | @cindex graph, in tables |
2520 | @cindex plot tables using gnuplot | |
c8d0cf5c | 2521 | @cindex #+PLOT |
864c9740 | 2522 | |
c8d0cf5c | 2523 | Org-Plot can produce 2D and 3D graphs of information stored in org tables |
71d35b24 CD |
2524 | using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode} |
2525 | @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}. To see | |
c8d0cf5c | 2526 | this in action, ensure that you have both Gnuplot and Gnuplot mode installed |
71d35b24 | 2527 | on your system, then call @code{org-plot/gnuplot} on the following table. |
864c9740 CD |
2528 | |
2529 | @example | |
2530 | @group | |
2531 | #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]" | |
2532 | | Sede | Max cites | H-index | | |
2533 | |-----------+-----------+---------| | |
2534 | | Chile | 257.72 | 21.39 | | |
2535 | | Leeds | 165.77 | 19.68 | | |
2536 | | Sao Paolo | 71.00 | 11.50 | | |
2537 | | Stockholm | 134.19 | 14.33 | | |
2538 | | Morelia | 257.56 | 17.67 | | |
2539 | @end group | |
2540 | @end example | |
2541 | ||
c8d0cf5c | 2542 | Notice that Org Plot is smart enough to apply the table's headers as labels. |
864c9740 | 2543 | Further control over the labels, type, content, and appearance of plots can |
c8d0cf5c CD |
2544 | be exercised through the @code{#+PLOT:} lines preceding a table. See below |
2545 | for a complete list of Org-plot options. For more information and examples | |
2546 | see the Org-plot tutorial at | |
d324fa76 | 2547 | @uref{http://orgmode.org/worg/org-tutorials/org-plot.php}. |
864c9740 CD |
2548 | |
2549 | @subsubheading Plot Options | |
2550 | ||
2551 | @table @code | |
2552 | @item set | |
c8d0cf5c | 2553 | Specify any @command{gnuplot} option to be set when graphing. |
864c9740 CD |
2554 | |
2555 | @item title | |
2556 | Specify the title of the plot. | |
2557 | ||
2558 | @item ind | |
2559 | Specify which column of the table to use as the @code{x} axis. | |
2560 | ||
2561 | @item deps | |
c8d0cf5c | 2562 | Specify the columns to graph as a Lisp style list, surrounded by parentheses |
71d35b24 | 2563 | and separated by spaces for example @code{dep:(3 4)} to graph the third and |
c8d0cf5c | 2564 | fourth columns (defaults to graphing all other columns aside from the @code{ind} |
71d35b24 | 2565 | column). |
864c9740 CD |
2566 | |
2567 | @item type | |
2568 | Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}. | |
2569 | ||
2570 | @item with | |
2571 | Specify a @code{with} option to be inserted for every col being plotted | |
a351880d | 2572 | (e.g. @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...). |
223b43fa | 2573 | Defaults to @code{lines}. |
864c9740 CD |
2574 | |
2575 | @item file | |
c8d0cf5c | 2576 | If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}. |
864c9740 CD |
2577 | |
2578 | @item labels | |
c8d0cf5c CD |
2579 | List of labels to be used for the deps (defaults to the column headers if |
2580 | they exist). | |
864c9740 CD |
2581 | |
2582 | @item line | |
c8d0cf5c | 2583 | Specify an entire line to be inserted in the Gnuplot script. |
864c9740 CD |
2584 | |
2585 | @item map | |
2586 | When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a | |
2587 | flat mapping rather than a @code{3d} slope. | |
2588 | ||
e45e3595 | 2589 | @item timefmt |
c8d0cf5c | 2590 | Specify format of Org-mode timestamps as they will be parsed by Gnuplot. |
223b43fa | 2591 | Defaults to @samp{%Y-%m-%d-%H:%M:%S}. |
e45e3595 | 2592 | |
864c9740 | 2593 | @item script |
c8d0cf5c CD |
2594 | If you want total control, you can specify a script file (place the file name |
2595 | between double-quotes) which will be used to plot. Before plotting, every | |
864c9740 | 2596 | instance of @code{$datafile} in the specified script will be replaced with |
c8d0cf5c | 2597 | the path to the generated data file. Note: even if you set this option, you |
864c9740 CD |
2598 | may still want to specify the plot type, as that can impact the content of |
2599 | the data file. | |
2600 | @end table | |
2601 | ||
a7808fba | 2602 | @node Hyperlinks, TODO Items, Tables, Top |
4009494e GM |
2603 | @chapter Hyperlinks |
2604 | @cindex hyperlinks | |
2605 | ||
a7808fba | 2606 | Like HTML, Org provides links inside a file, external links to |
dbc28aaa | 2607 | other files, Usenet articles, emails, and much more. |
4009494e GM |
2608 | |
2609 | @menu | |
a7808fba | 2610 | * Link format:: How links in Org are formatted |
4009494e GM |
2611 | * Internal links:: Links to other places in the current file |
2612 | * External links:: URL-like links to the world | |
2613 | * Handling links:: Creating, inserting and following | |
a7808fba | 2614 | * Using links outside Org:: Linking from my C source code? |
4009494e GM |
2615 | * Link abbreviations:: Shortcuts for writing complex links |
2616 | * Search options:: Linking to a specific location | |
2617 | * Custom searches:: When the default search is not enough | |
4009494e GM |
2618 | @end menu |
2619 | ||
2620 | @node Link format, Internal links, Hyperlinks, Hyperlinks | |
2621 | @section Link format | |
2622 | @cindex link format | |
2623 | @cindex format, of links | |
2624 | ||
a7808fba | 2625 | Org will recognize plain URL-like links and activate them as |
4009494e GM |
2626 | clickable links. The general link format, however, looks like this: |
2627 | ||
2628 | @example | |
28a16a1b | 2629 | [[link][description]] @r{or alternatively} [[link]] |
4009494e GM |
2630 | @end example |
2631 | ||
c8d0cf5c | 2632 | @noindent |
a7808fba | 2633 | Once a link in the buffer is complete (all brackets present), Org |
4009494e GM |
2634 | will change the display so that @samp{description} is displayed instead |
2635 | of @samp{[[link][description]]} and @samp{link} is displayed instead of | |
2636 | @samp{[[link]]}. Links will be highlighted in the face @code{org-link}, | |
2637 | which by default is an underlined face. You can directly edit the | |
2638 | visible part of a link. Note that this can be either the @samp{link} | |
2639 | part (if there is no description) or the @samp{description} part. To | |
2640 | edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the | |
2641 | cursor on the link. | |
2642 | ||
2643 | If you place the cursor at the beginning or just behind the end of the | |
2644 | displayed text and press @key{BACKSPACE}, you will remove the | |
2645 | (invisible) bracket at that location. This makes the link incomplete | |
2646 | and the internals are again displayed as plain text. Inserting the | |
2647 | missing bracket hides the link internals again. To show the | |
2648 | internal structure of all links, use the menu entry | |
2649 | @code{Org->Hyperlinks->Literal links}. | |
2650 | ||
2651 | @node Internal links, External links, Link format, Hyperlinks | |
2652 | @section Internal links | |
2653 | @cindex internal links | |
2654 | @cindex links, internal | |
2655 | @cindex targets, for links | |
2656 | ||
c8d0cf5c CD |
2657 | @cindex property, CUSTOM_ID |
2658 | If the link does not look like a URL, it is considered to be internal in the | |
2659 | current file. The most important case is a link like | |
2660 | @samp{[[#my-custom-id]]} which will link to the entry with the | |
2661 | @code{CUSTOM_ID} property @samp{my-custom-id}. Such custom IDs are very good | |
2662 | for HTML export (@pxref{HTML export}) where they produce pretty section | |
2663 | links. You are responsible yourself to make sure these custom IDs are unique | |
2664 | in a file. | |
2665 | ||
2666 | Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]} | |
2667 | lead to a text search in the current file. | |
2668 | ||
2669 | The link can be followed with @kbd{C-c C-o} when the cursor is on the link, | |
2670 | or with a mouse click (@pxref{Handling links}). Links to custom IDs will | |
2671 | point to the corresponding headline. The preferred match for a text link is | |
2672 | a @i{dedicated target}: the same string in double angular brackets. Targets | |
2673 | may be located anywhere; sometimes it is convenient to put them into a | |
2674 | comment line. For example | |
4009494e GM |
2675 | |
2676 | @example | |
2677 | # <<My Target>> | |
2678 | @end example | |
2679 | ||
2680 | @noindent In HTML export (@pxref{HTML export}), such targets will become | |
64fb801f CD |
2681 | named anchors for direct access through @samp{http} links@footnote{Note that |
2682 | text before the first headline is usually not exported, so the first such | |
2683 | target should be after the first headline, or in the line directly before the | |
2684 | first headline.}. | |
4009494e | 2685 | |
c8d0cf5c CD |
2686 | If no dedicated target exists, Org will search for the words in the link. In |
2687 | the above example the search would be for @samp{my target}. Links starting | |
2688 | with a star like @samp{*My Target} restrict the search to | |
2689 | headlines@footnote{To insert a link targeting a headline, in-buffer | |
2690 | completion can be used. Just type a star followed by a few optional letters | |
2691 | into the buffer and press @kbd{M-@key{TAB}}. All headlines in the current | |
2692 | buffer will be offered as completions. @xref{Handling links}, for more | |
2693 | commands creating links.}. When searching, Org mode will first try an | |
2694 | exact match, but then move on to more and more lenient searches. For | |
2695 | example, the link @samp{[[*My Targets]]} will find any of the following: | |
4009494e GM |
2696 | |
2697 | @example | |
2698 | ** My targets | |
2699 | ** TODO my targets are bright | |
2700 | ** my 20 targets are | |
2701 | @end example | |
2702 | ||
4009494e | 2703 | |
a7808fba | 2704 | Following a link pushes a mark onto Org's own mark ring. You can |
4009494e GM |
2705 | return to the previous position with @kbd{C-c &}. Using this command |
2706 | several times in direct succession goes back to positions recorded | |
2707 | earlier. | |
2708 | ||
2709 | @menu | |
a7808fba | 2710 | * Radio targets:: Make targets trigger links in plain text |
4009494e GM |
2711 | @end menu |
2712 | ||
2713 | @node Radio targets, , Internal links, Internal links | |
2714 | @subsection Radio targets | |
2715 | @cindex radio targets | |
2716 | @cindex targets, radio | |
2717 | @cindex links, radio targets | |
2718 | ||
a7808fba | 2719 | Org can automatically turn any occurrences of certain target names |
4009494e GM |
2720 | in normal text into a link. So without explicitly creating a link, the |
2721 | text connects to the target radioing its position. Radio targets are | |
2722 | enclosed by triple angular brackets. For example, a target @samp{<<<My | |
2723 | Target>>>} causes each occurrence of @samp{my target} in normal text to | |
a7808fba | 2724 | become activated as a link. The Org file is scanned automatically |
4009494e GM |
2725 | for radio targets only when the file is first loaded into Emacs. To |
2726 | update the target list during editing, press @kbd{C-c C-c} with the | |
2727 | cursor on or at a target. | |
2728 | ||
2729 | @node External links, Handling links, Internal links, Hyperlinks | |
2730 | @section External links | |
2731 | @cindex links, external | |
2732 | @cindex external links | |
2733 | @cindex links, external | |
a7808fba | 2734 | @cindex Gnus links |
4009494e | 2735 | @cindex BBDB links |
28a16a1b | 2736 | @cindex IRC links |
4009494e GM |
2737 | @cindex URL links |
2738 | @cindex file links | |
2739 | @cindex VM links | |
2740 | @cindex RMAIL links | |
2741 | @cindex WANDERLUST links | |
2742 | @cindex MH-E links | |
2743 | @cindex USENET links | |
2744 | @cindex SHELL links | |
2745 | @cindex Info links | |
c8d0cf5c | 2746 | @cindex Elisp links |
4009494e | 2747 | |
a7808fba | 2748 | Org supports links to files, websites, Usenet and email messages, |
28a16a1b CD |
2749 | BBDB database entries and links to both IRC conversations and their |
2750 | logs. External links are URL-like locators. They start with a short | |
2751 | identifying string followed by a colon. There can be no space after | |
2752 | the colon. The following list shows examples for each link type. | |
4009494e GM |
2753 | |
2754 | @example | |
a7808fba | 2755 | http://www.astro.uva.nl/~dominik @r{on the web} |
4009494e | 2756 | file:/home/dominik/images/jupiter.jpg @r{file, absolute path} |
44ce9197 | 2757 | /home/dominik/images/jupiter.jpg @r{same as above} |
4009494e | 2758 | file:papers/last.pdf @r{file, relative path} |
44ce9197 | 2759 | ./papers/last.pdf @r{same as above} |
a351880d | 2760 | file:sometextfile::NNN @r{file with line number to jump to} |
c8d0cf5c CD |
2761 | file:projects.org @r{another Org file} |
2762 | file:projects.org::some words @r{text search in Org file} | |
2763 | file:projects.org::*task title @r{heading search in Org file} | |
55e0839d | 2764 | id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID} |
4009494e | 2765 | news:comp.emacs @r{Usenet link} |
55e0839d | 2766 | mailto:adent@@galaxy.net @r{Mail link} |
4009494e GM |
2767 | vm:folder @r{VM folder link} |
2768 | vm:folder#id @r{VM message link} | |
55e0839d | 2769 | vm://myself@@some.where.org/folder#id @r{VM on remote machine} |
4009494e GM |
2770 | wl:folder @r{WANDERLUST folder link} |
2771 | wl:folder#id @r{WANDERLUST message link} | |
2772 | mhe:folder @r{MH-E folder link} | |
2773 | mhe:folder#id @r{MH-E message link} | |
2774 | rmail:folder @r{RMAIL folder link} | |
2775 | rmail:folder#id @r{RMAIL message link} | |
a7808fba CD |
2776 | gnus:group @r{Gnus group link} |
2777 | gnus:group#id @r{Gnus article link} | |
64fb801f | 2778 | bbdb:R.*Stallman @r{BBDB link (with regexp)} |
28a16a1b | 2779 | irc:/irc.com/#emacs/bob @r{IRC link} |
4009494e | 2780 | shell:ls *.org @r{A shell command} |
c8d0cf5c | 2781 | elisp:org-agenda @r{Interactive Elisp command} |
64fb801f | 2782 | elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate} |
4009494e GM |
2783 | @end example |
2784 | ||
2785 | A link should be enclosed in double brackets and may contain a | |
a7808fba | 2786 | descriptive text to be displayed instead of the URL (@pxref{Link |
4009494e GM |
2787 | format}), for example: |
2788 | ||
2789 | @example | |
2790 | [[http://www.gnu.org/software/emacs/][GNU Emacs]] | |
2791 | @end example | |
2792 | ||
2793 | @noindent | |
2794 | If the description is a file name or URL that points to an image, HTML | |
2795 | export (@pxref{HTML export}) will inline the image as a clickable | |
2796 | button. If there is no description at all and the link points to an | |
2797 | image, | |
2798 | that image will be inlined into the exported HTML file. | |
2799 | ||
c8d0cf5c | 2800 | @cindex square brackets, around links |
4009494e | 2801 | @cindex plain text external links |
a7808fba | 2802 | Org also finds external links in the normal text and activates them |
4009494e GM |
2803 | as links. If spaces must be part of the link (for example in |
2804 | @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities | |
c8d0cf5c | 2805 | about the end of the link, enclose them in square brackets. |
4009494e | 2806 | |
a7808fba | 2807 | @node Handling links, Using links outside Org, External links, Hyperlinks |
4009494e GM |
2808 | @section Handling links |
2809 | @cindex links, handling | |
2810 | ||
a7808fba CD |
2811 | Org provides methods to create a link in the correct syntax, to |
2812 | insert it into an Org file, and to follow the link. | |
4009494e GM |
2813 | |
2814 | @table @kbd | |
2815 | @kindex C-c l | |
2816 | @cindex storing links | |
2817 | @item C-c l | |
55e0839d CD |
2818 | Store a link to the current location. This is a @emph{global} command (you |
2819 | must create the key binding yourself) which can be used in any buffer to | |
2820 | create a link. The link will be stored for later insertion into an Org | |
c8d0cf5c CD |
2821 | buffer (see below). What kind of link will be created depends on the current |
2822 | buffer: | |
55e0839d | 2823 | |
c8d0cf5c | 2824 | @b{Org-mode buffers}@* |
55e0839d | 2825 | For Org files, if there is a @samp{<<target>>} at the cursor, the link points |
c8d0cf5c CD |
2826 | to the target. Otherwise it points to the current headline, which will also |
2827 | be the description. | |
2828 | ||
2829 | @vindex org-link-to-org-use-id | |
2830 | @cindex property, CUSTOM_ID | |
2831 | @cindex property, ID | |
2832 | If the headline has a @code{CUSTOM_ID} property, a link to this custom ID | |
2833 | will be stored. In addition or alternatively (depending on the value of | |
2834 | @code{org-link-to-org-use-id}), a globally unique @code{ID} property will be | |
2835 | created and/or used to construct a link. So using this command in Org | |
2836 | buffers will potentially create two links: a human-readable from the custom | |
2837 | ID, and one that is globally unique and works even if the entry is moved from | |
2838 | file to file. Later, when inserting the link, you need to decide which one | |
2839 | to use. | |
2840 | ||
2841 | @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@* | |
2842 | Pretty much all Emacs mail clients are supported. The link will point to the | |
2843 | current article, or, in some GNUS buffers, to the group. The description is | |
2844 | constructed from the author and the subject. | |
2845 | ||
2846 | @b{Web browsers: W3 and W3M}@* | |
2847 | Here the link will be the current URL, with the page title as description. | |
2848 | ||
2849 | @b{Contacts: BBDB}@* | |
2850 | Links created in a BBDB buffer will point to the current entry. | |
2851 | ||
2852 | @b{Chat: IRC}@* | |
2853 | @vindex org-irc-link-to-logs | |
2854 | For IRC links, if you set the variable @code{org-irc-link-to-logs} to | |
2855 | @code{t}, a @samp{file:/} style link to the relevant point in the logs for | |
2856 | the current conversation is created. Otherwise an @samp{irc:/} style link to | |
2857 | the user/channel/server under the point will be stored. | |
2858 | ||
2859 | @b{Other files}@* | |
55e0839d CD |
2860 | For any other files, the link will point to the file, with a search string |
2861 | (@pxref{Search options}) pointing to the contents of the current line. If | |
2862 | there is an active region, the selected words will form the basis of the | |
2863 | search string. If the automatically created link is not working correctly or | |
2864 | accurately enough, you can write custom functions to select the search string | |
c8d0cf5c CD |
2865 | and to do the search for particular file types---see @ref{Custom searches}. |
2866 | The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}. | |
7006d207 CD |
2867 | |
2868 | @b{Agenda view}@* | |
2869 | When the cursor is in an agenda view, the created link points to the | |
2870 | entry referenced by the current line. | |
2871 | ||
4009494e GM |
2872 | @c |
2873 | @kindex C-c C-l | |
2874 | @cindex link completion | |
2875 | @cindex completion, of links | |
2876 | @cindex inserting links | |
2877 | @item C-c C-l | |
c8d0cf5c CD |
2878 | @vindex org-keep-stored-link-after-insertion |
2879 | Insert a link@footnote{ Note that you don't have to use this command to | |
2880 | insert a link. Links in Org are plain text, and you can type or paste them | |
2881 | straight into the buffer. By using this command, the links are automatically | |
2882 | enclosed in double brackets, and you will be asked for the optional | |
2883 | descriptive text.}. This prompts for a link to be inserted into the buffer. | |
2884 | You can just type a link, using text for an internal link, or one of the link | |
2885 | type prefixes mentioned in the examples above. The link will be inserted | |
2886 | into the buffer@footnote{After insertion of a stored link, the link will be | |
2887 | removed from the list of stored links. To keep it in the list later use, use | |
2888 | a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option | |
a7808fba CD |
2889 | @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text. |
2890 | If some text was selected when this command is called, the selected text | |
c8d0cf5c CD |
2891 | becomes the default description. |
2892 | ||
2893 | @b{Inserting stored links}@* | |
2894 | All links stored during the | |
2895 | current session are part of the history for this prompt, so you can access | |
2896 | them with @key{up} and @key{down} (or @kbd{M-p/n}). | |
2897 | ||
2898 | @b{Completion support}@* Completion with @key{TAB} will help you to insert | |
2899 | valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes | |
2900 | defined through link abbreviations (@pxref{Link abbreviations}). If you | |
2901 | press @key{RET} after inserting only the @var{prefix}, Org will offer | |
2902 | specific completion support for some link types@footnote{This works by | |
2903 | calling a special function @code{org-PREFIX-complete-link}.} For | |
2904 | example, if you type @kbd{file @key{RET}}, file name completion (alternative | |
2905 | access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb | |
2906 | @key{RET}} you can complete contact names. | |
4009494e GM |
2907 | @kindex C-u C-c C-l |
2908 | @cindex file name completion | |
2909 | @cindex completion, of file names | |
2910 | @item C-u C-c C-l | |
2911 | When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to | |
2912 | a file will be inserted and you may use file name completion to select | |
2913 | the name of the file. The path to the file is inserted relative to the | |
c8d0cf5c | 2914 | directory of the current Org file, if the linked file is in the current |
a7808fba | 2915 | directory or in a sub-directory of it, or if the path is written relative |
4009494e GM |
2916 | to the current directory using @samp{../}. Otherwise an absolute path |
2917 | is used, if possible with @samp{~/} for your home directory. You can | |
2918 | force an absolute path with two @kbd{C-u} prefixes. | |
2919 | @c | |
2920 | @item C-c C-l @r{(with cursor on existing link)} | |
2921 | When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the | |
2922 | link and description parts of the link. | |
2923 | @c | |
2924 | @cindex following links | |
2925 | @kindex C-c C-o | |
55033558 | 2926 | @kindex RET |
c8d0cf5c CD |
2927 | @item C-c C-o @r{or} @key{RET} |
2928 | @vindex org-file-apps | |
4009494e | 2929 | Open link at point. This will launch a web browser for URLs (using |
864c9740 CD |
2930 | @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for |
2931 | the corresponding links, and execute the command in a shell link. When the | |
04d3bb6c | 2932 | cursor is on an internal link, this command runs the corresponding search. |
864c9740 | 2933 | When the cursor is on a TAG list in a headline, it creates the corresponding |
c8d0cf5c | 2934 | TAGS view. If the cursor is on a timestamp, it compiles the agenda for that |
864c9740 CD |
2935 | date. Furthermore, it will visit text and remote files in @samp{file:} links |
2936 | with Emacs and select a suitable application for local non-text files. | |
2937 | Classification of files is based on file extension only. See option | |
2938 | @code{org-file-apps}. If you want to override the default application and | |
e45e3595 | 2939 | visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid |
6eb02347 CD |
2940 | opening in Emacs, use a @kbd{C-u C-u} prefix.@* |
2941 | If the cursor is on a headline, but not on a link, offer all links in the | |
2942 | headline and entry text. | |
4009494e GM |
2943 | @c |
2944 | @kindex mouse-2 | |
2945 | @kindex mouse-1 | |
2946 | @item mouse-2 | |
2947 | @itemx mouse-1 | |
2948 | On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o} | |
c8d0cf5c | 2949 | would. Under Emacs 22, @kbd{mouse-1} will also follow a link. |
4009494e GM |
2950 | @c |
2951 | @kindex mouse-3 | |
2952 | @item mouse-3 | |
c8d0cf5c | 2953 | @vindex org-display-internal-link-with-indirect-buffer |
4009494e GM |
2954 | Like @kbd{mouse-2}, but force file links to be opened with Emacs, and |
2955 | internal links to be displayed in another window@footnote{See the | |
2956 | variable @code{org-display-internal-link-with-indirect-buffer}}. | |
2957 | @c | |
2958 | @cindex mark ring | |
2959 | @kindex C-c % | |
2960 | @item C-c % | |
2961 | Push the current position onto the mark ring, to be able to return | |
2962 | easily. Commands following an internal link do this automatically. | |
2963 | @c | |
2964 | @cindex links, returning to | |
2965 | @kindex C-c & | |
2966 | @item C-c & | |
2967 | Jump back to a recorded position. A position is recorded by the | |
2968 | commands following internal links, and by @kbd{C-c %}. Using this | |
2969 | command several times in direct succession moves through a ring of | |
2970 | previously recorded positions. | |
2971 | @c | |
2972 | @kindex C-c C-x C-n | |
2973 | @kindex C-c C-x C-p | |
2974 | @cindex links, finding next/previous | |
2975 | @item C-c C-x C-n | |
2976 | @itemx C-c C-x C-p | |
2977 | Move forward/backward to the next link in the buffer. At the limit of | |
2978 | the buffer, the search fails once, and then wraps around. The key | |
2979 | bindings for this are really too long, you might want to bind this also | |
2980 | to @kbd{C-n} and @kbd{C-p} | |
2981 | @lisp | |
2982 | (add-hook 'org-load-hook | |
2983 | (lambda () | |
2984 | (define-key 'org-mode-map "\C-n" 'org-next-link) | |
2985 | (define-key 'org-mode-map "\C-p" 'org-previous-link))) | |
2986 | @end lisp | |
2987 | @end table | |
2988 | ||
a7808fba CD |
2989 | @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks |
2990 | @section Using links outside Org | |
4009494e | 2991 | |
a7808fba CD |
2992 | You can insert and follow links that have Org syntax not only in |
2993 | Org, but in any Emacs buffer. For this, you should create two | |
4009494e GM |
2994 | global commands, like this (please select suitable global keys |
2995 | yourself): | |
2996 | ||
2997 | @lisp | |
2998 | (global-set-key "\C-c L" 'org-insert-link-global) | |
2999 | (global-set-key "\C-c o" 'org-open-at-point-global) | |
3000 | @end lisp | |
3001 | ||
a7808fba | 3002 | @node Link abbreviations, Search options, Using links outside Org, Hyperlinks |
4009494e GM |
3003 | @section Link abbreviations |
3004 | @cindex link abbreviations | |
3005 | @cindex abbreviation, links | |
3006 | ||
3007 | Long URLs can be cumbersome to type, and often many similar links are | |
3008 | needed in a document. For this you can use link abbreviations. An | |
3009 | abbreviated link looks like this | |
3010 | ||
3011 | @example | |
3012 | [[linkword:tag][description]] | |
3013 | @end example | |
3014 | ||
3015 | @noindent | |
c8d0cf5c CD |
3016 | @vindex org-link-abbrev-alist |
3017 | where the tag is optional. The @i{linkword} must be a word; letter, numbers, | |
3018 | @samp{-}, and @samp{_} are allowed here. Abbreviations are resolved | |
3019 | according to the information in the variable @code{org-link-abbrev-alist} | |
3020 | that relates the linkwords to replacement text. Here is an example: | |
4009494e GM |
3021 | |
3022 | @lisp | |
3023 | @group | |
3024 | (setq org-link-abbrev-alist | |
3025 | '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=") | |
3026 | ("google" . "http://www.google.com/search?q=") | |
3027 | ("ads" . "http://adsabs.harvard.edu/cgi-bin/ | |
3028 | nph-abs_connect?author=%s&db_key=AST"))) | |
3029 | @end group | |
3030 | @end lisp | |
3031 | ||
3032 | If the replacement text contains the string @samp{%s}, it will be | |
3033 | replaced with the tag. Otherwise the tag will be appended to the string | |
3034 | in order to create the link. You may also specify a function that will | |
3035 | be called with the tag as the only argument to create the link. | |
3036 | ||
3037 | With the above setting, you could link to a specific bug with | |
3038 | @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with | |
a7808fba | 3039 | @code{[[google:OrgMode]]} and find out what the Org author is |
4009494e GM |
3040 | doing besides Emacs hacking with @code{[[ads:Dominik,C]]}. |
3041 | ||
a7808fba | 3042 | If you need special abbreviations just for a single Org buffer, you |
4009494e GM |
3043 | can define them in the file with |
3044 | ||
c8d0cf5c | 3045 | @cindex #+LINK |
4009494e GM |
3046 | @example |
3047 | #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id= | |
3048 | #+LINK: google http://www.google.com/search?q=%s | |
3049 | @end example | |
3050 | ||
3051 | @noindent | |
c8d0cf5c CD |
3052 | In-buffer completion (@pxref{Completion}) can be used after @samp{[} to |
3053 | complete link abbreviations. You may also define a function | |
a351880d | 3054 | @code{org-PREFIX-complete-link} that implements special (e.g. completion) |
c8d0cf5c CD |
3055 | support for inserting such a link with @kbd{C-c C-l}. Such a function should |
3056 | not accept any arguments, and return the full link with prefix. | |
4009494e GM |
3057 | |
3058 | @node Search options, Custom searches, Link abbreviations, Hyperlinks | |
3059 | @section Search options in file links | |
3060 | @cindex search option in file links | |
3061 | @cindex file links, searching | |
3062 | ||
3063 | File links can contain additional information to make Emacs jump to a | |
3064 | particular location in the file when following a link. This can be a | |
3065 | line number or a search option after a double@footnote{For backward | |
3066 | compatibility, line numbers can also follow a single colon.} colon. For | |
3067 | example, when the command @kbd{C-c l} creates a link (@pxref{Handling | |
3068 | links}) to a file, it encodes the words in the current line as a search | |
3069 | string that can be used to find this line back later when following the | |
28a16a1b | 3070 | link with @kbd{C-c C-o}. |
4009494e GM |
3071 | |
3072 | Here is the syntax of the different ways to attach a search to a file | |
3073 | link, together with an explanation: | |
3074 | ||
3075 | @example | |
3076 | [[file:~/code/main.c::255]] | |
3077 | [[file:~/xx.org::My Target]] | |
3078 | [[file:~/xx.org::*My Target]] | |
3079 | [[file:~/xx.org::/regexp/]] | |
3080 | @end example | |
3081 | ||
3082 | @table @code | |
3083 | @item 255 | |
3084 | Jump to line 255. | |
3085 | @item My Target | |
3086 | Search for a link target @samp{<<My Target>>}, or do a text search for | |
3087 | @samp{my target}, similar to the search in internal links, see | |
3088 | @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file | |
3089 | link will become an HTML reference to the corresponding named anchor in | |
3090 | the linked file. | |
3091 | @item *My Target | |
a7808fba | 3092 | In an Org file, restrict search to headlines. |
4009494e GM |
3093 | @item /regexp/ |
3094 | Do a regular expression search for @code{regexp}. This uses the Emacs | |
3095 | command @code{occur} to list all matches in a separate window. If the | |
a7808fba | 3096 | target file is in Org mode, @code{org-occur} is used to create a |
4009494e GM |
3097 | sparse tree with the matches. |
3098 | @c If the target file is a directory, | |
3099 | @c @code{grep} will be used to search all files in the directory. | |
3100 | @end table | |
3101 | ||
3102 | As a degenerate case, a file link with an empty file name can be used | |
3103 | to search the current file. For example, @code{[[file:::find me]]} does | |
3104 | a search for @samp{find me} in the current file, just as | |
3105 | @samp{[[find me]]} would. | |
3106 | ||
dbc28aaa | 3107 | @node Custom searches, , Search options, Hyperlinks |
4009494e GM |
3108 | @section Custom Searches |
3109 | @cindex custom search strings | |
3110 | @cindex search strings, custom | |
3111 | ||
3112 | The default mechanism for creating search strings and for doing the | |
3113 | actual search related to a file link may not work correctly in all | |
c8d0cf5c | 3114 | cases. For example, Bib@TeX{} database files have many entries like |
4009494e | 3115 | @samp{year="1993"} which would not result in good search strings, |
c8d0cf5c | 3116 | because the only unique identification for a Bib@TeX{} entry is the |
4009494e GM |
3117 | citation key. |
3118 | ||
c8d0cf5c CD |
3119 | @vindex org-create-file-search-functions |
3120 | @vindex org-execute-file-search-functions | |
4009494e GM |
3121 | If you come across such a problem, you can write custom functions to set |
3122 | the right search string for a particular file type, and to do the search | |
3123 | for the string in the file. Using @code{add-hook}, these functions need | |
3124 | to be added to the hook variables | |
3125 | @code{org-create-file-search-functions} and | |
3126 | @code{org-execute-file-search-functions}. See the docstring for these | |
a7808fba | 3127 | variables for more information. Org actually uses this mechanism |
4009494e | 3128 | for Bib@TeX{} database files, and you can use the corresponding code as |
44ce9197 | 3129 | an implementation example. See the file @file{org-bibtex.el}. |
4009494e | 3130 | |
a7808fba CD |
3131 | @node TODO Items, Tags, Hyperlinks, Top |
3132 | @chapter TODO Items | |
4009494e GM |
3133 | @cindex TODO items |
3134 | ||
44ce9197 | 3135 | Org mode does not maintain TODO lists as separate documents@footnote{Of |
a50253cc | 3136 | course, you can make a document that contains only long lists of TODO items, |
44ce9197 CD |
3137 | but this is not required.}. Instead, TODO items are an integral part of the |
3138 | notes file, because TODO items usually come up while taking notes! With Org | |
3139 | mode, simply mark any entry in a tree as being a TODO item. In this way, | |
3140 | information is not duplicated, and the entire context from which the TODO | |
3141 | item emerged is always present. | |
4009494e | 3142 | |
dbc28aaa | 3143 | Of course, this technique for managing TODO items scatters them |
a7808fba | 3144 | throughout your notes file. Org mode compensates for this by providing |
dbc28aaa | 3145 | methods to give you an overview of all the things that you have to do. |
4009494e GM |
3146 | |
3147 | @menu | |
3148 | * TODO basics:: Marking and displaying TODO entries | |
3149 | * TODO extensions:: Workflow and assignments | |
dbc28aaa | 3150 | * Progress logging:: Dates and notes for progress |
4009494e GM |
3151 | * Priorities:: Some things are more important than others |
3152 | * Breaking down tasks:: Splitting a task into manageable pieces | |
3153 | * Checkboxes:: Tick-off lists | |
3154 | @end menu | |
3155 | ||
a7808fba | 3156 | @node TODO basics, TODO extensions, TODO Items, TODO Items |
4009494e GM |
3157 | @section Basic TODO functionality |
3158 | ||
dbc28aaa CD |
3159 | Any headline becomes a TODO item when it starts with the word |
3160 | @samp{TODO}, for example: | |
4009494e GM |
3161 | |
3162 | @example | |
3163 | *** TODO Write letter to Sam Fortune | |
3164 | @end example | |
3165 | ||
3166 | @noindent | |
3167 | The most important commands to work with TODO entries are: | |
3168 | ||
3169 | @table @kbd | |
3170 | @kindex C-c C-t | |
3171 | @cindex cycling, of TODO states | |
3172 | @item C-c C-t | |
3173 | Rotate the TODO state of the current item among | |
3174 | ||
3175 | @example | |
3176 | ,-> (unmarked) -> TODO -> DONE --. | |
3177 | '--------------------------------' | |
3178 | @end example | |
3179 | ||
3180 | The same rotation can also be done ``remotely'' from the timeline and | |
3181 | agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}). | |
dbc28aaa CD |
3182 | |
3183 | @kindex C-u C-c C-t | |
3184 | @item C-u C-c C-t | |
3185 | Select a specific keyword using completion or (if it has been set up) | |
28a16a1b | 3186 | the fast selection interface. For the latter, you need to assign keys |
c8d0cf5c | 3187 | to TODO states, see @ref{Per-file keywords}, and @ref{Setting tags}, for |
28a16a1b | 3188 | more information. |
dbc28aaa | 3189 | |
4009494e GM |
3190 | @kindex S-@key{right} |
3191 | @kindex S-@key{left} | |
c8d0cf5c | 3192 | @vindex org-treat-S-cursor-todo-selection-as-state-change |
4009494e GM |
3193 | @item S-@key{right} |
3194 | @itemx S-@key{left} | |
dbc28aaa CD |
3195 | Select the following/preceding TODO state, similar to cycling. Useful |
3196 | mostly if more than two TODO states are possible (@pxref{TODO | |
c8d0cf5c CD |
3197 | extensions}). See also @ref{Conflicts}, for a discussion of the interaction |
3198 | with @code{shift-selection-mode}. See also the variable | |
3199 | @code{org-treat-S-cursor-todo-selection-as-state-change}. | |
4009494e | 3200 | @kindex C-c C-v |
dbc28aaa | 3201 | @kindex C-c / t |
4009494e GM |
3202 | @cindex sparse tree, for TODO |
3203 | @item C-c C-v | |
dbc28aaa | 3204 | @itemx C-c / t |
c8d0cf5c CD |
3205 | @vindex org-todo-keywords |
3206 | View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the | |
3207 | entire buffer, but shows all TODO items and the headings hierarchy above | |
3208 | them. With a prefix argument, search for a specific TODO. You will be | |
4009494e | 3209 | prompted for the keyword, and you can also give a list of keywords like |
c8d0cf5c CD |
3210 | @code{KWD1|KWD2|...} to list entries that match any one of these keywords. |
3211 | With numeric prefix argument N, show the tree for the Nth keyword in the | |
3212 | variable @code{org-todo-keywords}. With two prefix arguments, find all TODO | |
3213 | and DONE entries. | |
4009494e GM |
3214 | @kindex C-c a t |
3215 | @item C-c a t | |
dbc28aaa | 3216 | Show the global TODO list. Collects the TODO items from all agenda |
a7808fba | 3217 | files (@pxref{Agenda Views}) into a single buffer. The new buffer will |
dbc28aaa CD |
3218 | be in @code{agenda-mode}, which provides commands to examine and |
3219 | manipulate the TODO entries from the new buffer (@pxref{Agenda | |
3220 | commands}). @xref{Global TODO list}, for more information. | |
4009494e GM |
3221 | @kindex S-M-@key{RET} |
3222 | @item S-M-@key{RET} | |
3223 | Insert a new TODO entry below the current one. | |
3224 | @end table | |
3225 | ||
71d35b24 | 3226 | @noindent |
c8d0cf5c | 3227 | @vindex org-todo-state-tags-triggers |
71d35b24 CD |
3228 | Changing a TODO state can also trigger tag changes. See the docstring of the |
3229 | option @code{org-todo-state-tags-triggers} for details. | |
3230 | ||
a7808fba | 3231 | @node TODO extensions, Progress logging, TODO basics, TODO Items |
4009494e GM |
3232 | @section Extended use of TODO keywords |
3233 | @cindex extended TODO keywords | |
3234 | ||
c8d0cf5c | 3235 | @vindex org-todo-keywords |
dbc28aaa | 3236 | By default, marked TODO entries have one of only two states: TODO and |
a7808fba | 3237 | DONE. Org mode allows you to classify TODO items in more complex ways |
dbc28aaa CD |
3238 | with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With |
3239 | special setup, the TODO keyword system can work differently in different | |
3240 | files. | |
4009494e GM |
3241 | |
3242 | Note that @i{tags} are another way to classify headlines in general and | |
3243 | TODO items in particular (@pxref{Tags}). | |
3244 | ||
3245 | @menu | |
3246 | * Workflow states:: From TODO to DONE in steps | |
dbc28aaa | 3247 | * TODO types:: I do this, Fred does the rest |
4009494e | 3248 | * Multiple sets in one file:: Mixing it all, and still finding your way |
dbc28aaa CD |
3249 | * Fast access to TODO states:: Single letter selection of a state |
3250 | * Per-file keywords:: Different files, different requirements | |
3251 | * Faces for TODO keywords:: Highlighting states | |
ec712abb | 3252 | * TODO dependencies:: When one task needs to wait for others |
4009494e GM |
3253 | @end menu |
3254 | ||
3255 | @node Workflow states, TODO types, TODO extensions, TODO extensions | |
3256 | @subsection TODO keywords as workflow states | |
3257 | @cindex TODO workflow | |
3258 | @cindex workflow states as TODO keywords | |
3259 | ||
3260 | You can use TODO keywords to indicate different @emph{sequential} states | |
3261 | in the process of working on an item, for example@footnote{Changing | |
a7808fba | 3262 | this variable only becomes effective after restarting Org mode in a |
4009494e GM |
3263 | buffer.}: |
3264 | ||
3265 | @lisp | |
3266 | (setq org-todo-keywords | |
3267 | '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED"))) | |
3268 | @end lisp | |
3269 | ||
3270 | The vertical bar separates the TODO keywords (states that @emph{need | |
44ce9197 | 3271 | action}) from the DONE states (which need @emph{no further action}). If |
4009494e GM |
3272 | you don't provide the separator bar, the last state is used as the DONE |
3273 | state. | |
3274 | @cindex completion, of TODO keywords | |
3275 | With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO | |
3276 | to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may | |
a7808fba | 3277 | also use a numeric prefix argument to quickly select a specific state. For |
4009494e | 3278 | example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY. |
560bb6ea | 3279 | Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you |
28a16a1b CD |
3280 | define many keywords, you can use in-buffer completion |
3281 | (@pxref{Completion}) or even a special one-key selection scheme | |
3282 | (@pxref{Fast access to TODO states}) to insert these words into the | |
a7808fba | 3283 | buffer. Changing a TODO state can be logged with a timestamp, see |
c8d0cf5c | 3284 | @ref{Tracking TODO state changes}, for more information. |
4009494e GM |
3285 | |
3286 | @node TODO types, Multiple sets in one file, Workflow states, TODO extensions | |
3287 | @subsection TODO keywords as types | |
3288 | @cindex TODO types | |
3289 | @cindex names as TODO keywords | |
3290 | @cindex types as TODO keywords | |
3291 | ||
3292 | The second possibility is to use TODO keywords to indicate different | |
3293 | @emph{types} of action items. For example, you might want to indicate | |
3294 | that items are for ``work'' or ``home''. Or, when you work with several | |
3295 | people on a single project, you might want to assign action items | |
3296 | directly to persons, by using their names as TODO keywords. This would | |
3297 | be set up like this: | |
3298 | ||
3299 | @lisp | |
3300 | (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE"))) | |
3301 | @end lisp | |
3302 | ||
3303 | In this case, different keywords do not indicate a sequence, but rather | |
3304 | different types. So the normal work flow would be to assign a task to a | |
a7808fba CD |
3305 | person, and later to mark it DONE. Org mode supports this style by adapting |
3306 | the workings of the command @kbd{C-c C-t}@footnote{This is also true for the | |
3307 | @kbd{t} command in the timeline and agenda buffers.}. When used several | |
3308 | times in succession, it will still cycle through all names, in order to first | |
3309 | select the right type for a task. But when you return to the item after some | |
3310 | time and execute @kbd{C-c C-t} again, it will switch from any name directly | |
3311 | to DONE. Use prefix arguments or completion to quickly select a specific | |
3312 | name. You can also review the items of a specific TODO type in a sparse tree | |
3313 | by using a numeric prefix to @kbd{C-c C-v}. For example, to see all things | |
3314 | Lucy has to do, you would use @kbd{C-3 C-c C-v}. To collect Lucy's items | |
3315 | from all agenda files into a single buffer, you would use the numeric prefix | |
3316 | argument as well when creating the global TODO list: @kbd{C-3 C-c t}. | |
4009494e | 3317 | |
dbc28aaa | 3318 | @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions |
4009494e | 3319 | @subsection Multiple keyword sets in one file |
a7808fba | 3320 | @cindex TODO keyword sets |
4009494e GM |
3321 | |
3322 | Sometimes you may want to use different sets of TODO keywords in | |
3323 | parallel. For example, you may want to have the basic | |
3324 | @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a | |
3325 | separate state indicating that an item has been canceled (so it is not | |
3326 | DONE, but also does not require action). Your setup would then look | |
3327 | like this: | |
3328 | ||
3329 | @lisp | |
3330 | (setq org-todo-keywords | |
3331 | '((sequence "TODO" "|" "DONE") | |
3332 | (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED") | |
3333 | (sequence "|" "CANCELED"))) | |
3334 | @end lisp | |
3335 | ||
a7808fba | 3336 | The keywords should all be different, this helps Org mode to keep track |
4009494e GM |
3337 | of which subsequence should be used for a given entry. In this setup, |
3338 | @kbd{C-c C-t} only operates within a subsequence, so it switches from | |
3339 | @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to | |
3340 | (nothing) to @code{REPORT}. Therefore you need a mechanism to initially | |
3341 | select the correct sequence. Besides the obvious ways like typing a | |
3342 | keyword or using completion, you may also apply the following commands: | |
3343 | ||
3344 | @table @kbd | |
3345 | @kindex C-S-@key{right} | |
3346 | @kindex C-S-@key{left} | |
3da3282e CD |
3347 | @kindex C-u C-u C-c C-t |
3348 | @item C-u C-u C-c C-t | |
3349 | @itemx C-S-@key{right} | |
4009494e GM |
3350 | @itemx C-S-@key{left} |
3351 | These keys jump from one TODO subset to the next. In the above example, | |
3da3282e CD |
3352 | @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or |
3353 | @code{DONE} to @code{REPORT}, and any of the words in the second row to | |
3354 | @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with | |
3355 | @code{shift-selection-mode} (@pxref{Conflicts}). | |
4009494e GM |
3356 | @kindex S-@key{right} |
3357 | @kindex S-@key{left} | |
3358 | @item S-@key{right} | |
3359 | @itemx S-@key{left} | |
3da3282e CD |
3360 | @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all} |
3361 | keywords from all sets, so for example @kbd{S-@key{<right>}} would switch | |
3362 | from @code{DONE} to @code{REPORT} in the example above. See also | |
c8d0cf5c | 3363 | @ref{Conflicts}, for a discussion of the interaction with |
3da3282e | 3364 | @code{shift-selection-mode}. |
4009494e GM |
3365 | @end table |
3366 | ||
dbc28aaa CD |
3367 | @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions |
3368 | @subsection Fast access to TODO states | |
3369 | ||
3370 | If you would like to quickly change an entry to an arbitrary TODO state | |
3371 | instead of cycling through the states, you can set up keys for | |
3372 | single-letter access to the states. This is done by adding the section | |
c8d0cf5c | 3373 | key after each keyword, in parentheses. For example: |
dbc28aaa CD |
3374 | |
3375 | @lisp | |
3376 | (setq org-todo-keywords | |
3377 | '((sequence "TODO(t)" "|" "DONE(d)") | |
3378 | (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)") | |
3379 | (sequence "|" "CANCELED(c)"))) | |
3380 | @end lisp | |
3381 | ||
c8d0cf5c | 3382 | @vindex org-fast-tag-selection-include-todo |
55033558 CD |
3383 | If you then press @code{C-c C-t} followed by the selection key, the entry |
3384 | will be switched to this state. @key{SPC} can be used to remove any TODO | |
3385 | keyword from an entry.@footnote{Check also the variable | |
c8d0cf5c | 3386 | @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO |
55033558 CD |
3387 | state through the tags interface (@pxref{Setting tags}), in case you like to |
3388 | mingle the two concepts. Note that this means you need to come up with | |
3389 | unique keys across both sets of keywords.} | |
dbc28aaa CD |
3390 | |
3391 | @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions | |
4009494e GM |
3392 | @subsection Setting up keywords for individual files |
3393 | @cindex keyword options | |
dbc28aaa | 3394 | @cindex per-file keywords |
c8d0cf5c CD |
3395 | @cindex #+TODO |
3396 | @cindex #+TYP_TODO | |
3397 | @cindex #+SEQ_TODO | |
4009494e GM |
3398 | |
3399 | It can be very useful to use different aspects of the TODO mechanism in | |
3400 | different files. For file-local settings, you need to add special lines | |
3401 | to the file which set the keywords and interpretation for that file | |
3402 | only. For example, to set one of the two examples discussed above, you | |
3403 | need one of the following lines, starting in column zero anywhere in the | |
3404 | file: | |
3405 | ||
3406 | @example | |
c8d0cf5c | 3407 | #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED |
4009494e | 3408 | @end example |
c8d0cf5c CD |
3409 | @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the |
3410 | interpretation, but it means the same as @code{#+TODO}), or | |
4009494e GM |
3411 | @example |
3412 | #+TYP_TODO: Fred Sara Lucy Mike | DONE | |
3413 | @end example | |
3414 | ||
3415 | A setup for using several sets in parallel would be: | |
3416 | ||
3417 | @example | |
c8d0cf5c CD |
3418 | #+TODO: TODO | DONE |
3419 | #+TODO: REPORT BUG KNOWNCAUSE | FIXED | |
3420 | #+TODO: | CANCELED | |
4009494e GM |
3421 | @end example |
3422 | ||
3423 | @cindex completion, of option keywords | |
3424 | @kindex M-@key{TAB} | |
3425 | @noindent To make sure you are using the correct keyword, type | |
3426 | @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion. | |
3427 | ||
3428 | @cindex DONE, final TODO keyword | |
3429 | Remember that the keywords after the vertical bar (or the last keyword | |
3430 | if no bar is there) must always mean that the item is DONE (although you | |
3431 | may use a different word). After changing one of these lines, use | |
3432 | @kbd{C-c C-c} with the cursor still in the line to make the changes | |
a7808fba CD |
3433 | known to Org mode@footnote{Org mode parses these lines only when |
3434 | Org mode is activated after visiting a file. @kbd{C-c C-c} with the | |
3435 | cursor in a line starting with @samp{#+} is simply restarting Org mode | |
4009494e GM |
3436 | for the current buffer.}. |
3437 | ||
7ddb1b5f | 3438 | @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions |
dbc28aaa CD |
3439 | @subsection Faces for TODO keywords |
3440 | @cindex faces, for TODO keywords | |
3441 | ||
c8d0cf5c CD |
3442 | @vindex org-todo @r{(face)} |
3443 | @vindex org-done @r{(face)} | |
3444 | @vindex org-todo-keyword-faces | |
a7808fba | 3445 | Org mode highlights TODO keywords with special faces: @code{org-todo} |
dbc28aaa CD |
3446 | for keywords indicating that an item still has to be acted upon, and |
3447 | @code{org-done} for keywords indicating that an item is finished. If | |
3448 | you are using more than 2 different states, you might want to use | |
3449 | special faces for some of them. This can be done using the variable | |
3450 | @code{org-todo-keyword-faces}. For example: | |
3451 | ||
3452 | @lisp | |
96c8522a | 3453 | @group |
dbc28aaa CD |
3454 | (setq org-todo-keyword-faces |
3455 | '(("TODO" . org-warning) | |
3456 | ("DEFERRED" . shadow) | |
3457 | ("CANCELED" . (:foreground "blue" :weight bold)))) | |
96c8522a | 3458 | @end group |
dbc28aaa CD |
3459 | @end lisp |
3460 | ||
28a16a1b CD |
3461 | While using a list with face properties as shown for CANCELED |
3462 | @emph{should} work, this does not aways seem to be the case. If | |
3463 | necessary, define a special face and use that. | |
3464 | ||
7ddb1b5f CD |
3465 | @node TODO dependencies, , Faces for TODO keywords, TODO extensions |
3466 | @subsection TODO dependencies | |
2e461fc1 CD |
3467 | @cindex TODO dependencies |
3468 | @cindex dependencies, of TODO states | |
7ddb1b5f | 3469 | |
c8d0cf5c CD |
3470 | @vindex org-enforce-todo-dependencies |
3471 | @cindex property, ORDERED | |
7ddb1b5f CD |
3472 | The structure of Org files (hierarchy and lists) makes it easy to define TODO |
3473 | dependencies. Usually, a parent TODO task should not be marked DONE until | |
3474 | all subtasks (defined as children tasks) are marked as DONE. And sometimes | |
3475 | there is a logical sequence to a number of (sub)tasks, so that one task | |
3476 | cannot be acted upon before all siblings above it are done. If you customize | |
3477 | the variable @code{org-enforce-todo-dependencies}, Org will block entries | |
2e461fc1 CD |
3478 | from changing state to DONE while they have children that are not DONE. |
3479 | Furthermore, if an entry has a property @code{ORDERED}, each of its children | |
3480 | will be blocked until all earlier siblings are marked DONE. Here is an | |
3481 | example: | |
7ddb1b5f CD |
3482 | |
3483 | @example | |
3484 | * TODO Blocked until (two) is done | |
3485 | ** DONE one | |
3486 | ** TODO two | |
3487 | ||
3488 | * Parent | |
3489 | :PROPERTIES: | |
3490 | :ORDERED: t | |
3491 | :END: | |
3492 | ** TODO a | |
3493 | ** TODO b, needs to wait for (a) | |
3494 | ** TODO c, needs to wait for (a) and (b) | |
3495 | @end example | |
3496 | ||
bc283609 CD |
3497 | @table @kbd |
3498 | @kindex C-c C-x o | |
3499 | @item C-c C-x o | |
c8d0cf5c CD |
3500 | @vindex org-track-ordered-property-with-tag |
3501 | @cindex property, ORDERED | |
3502 | Toggle the @code{ORDERED} property of the current entry. A property is used | |
3503 | for this behavior because this should be local to the current entry, not | |
3504 | inherited like a tag. However, if you would like to @i{track} the value of | |
3505 | this property with a tag for better visibility, customize the variable | |
3506 | @code{org-track-ordered-property-with-tag}. | |
2e461fc1 CD |
3507 | @kindex C-u C-u C-u C-c C-t |
3508 | @item C-u C-u C-u C-c C-t | |
c8d0cf5c | 3509 | Change TODO state, circumventing any state blocking. |
bc283609 CD |
3510 | @end table |
3511 | ||
c8d0cf5c | 3512 | @vindex org-agenda-dim-blocked-tasks |
7ddb1b5f CD |
3513 | If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries |
3514 | that cannot be closed because of such dependencies will be shown in a dimmed | |
3515 | font or even made invisible in agenda views (@pxref{Agenda Views}). | |
3516 | ||
2e461fc1 | 3517 | @cindex checkboxes and TODO dependencies |
c8d0cf5c | 3518 | @vindex org-enforce-todo-dependencies |
2e461fc1 CD |
3519 | You can also block changes of TODO states by looking at checkboxes |
3520 | (@pxref{Checkboxes}). If you set the variable | |
3521 | @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked | |
3522 | checkboxes will be blocked from switching to DONE. | |
3523 | ||
7ddb1b5f CD |
3524 | If you need more complex dependency structures, for example dependencies |
3525 | between entries in different trees or files, check out the contributed | |
3526 | module @file{org-depend.el}. | |
3527 | ||
dbc28aaa | 3528 | @page |
a7808fba CD |
3529 | @node Progress logging, Priorities, TODO extensions, TODO Items |
3530 | @section Progress logging | |
dbc28aaa CD |
3531 | @cindex progress logging |
3532 | @cindex logging, of progress | |
3533 | ||
c8d0cf5c | 3534 | Org mode can automatically record a timestamp and possibly a note when |
28a16a1b CD |
3535 | you mark a TODO item as DONE, or even each time you change the state of |
3536 | a TODO item. This system is highly configurable, settings can be on a | |
3537 | per-keyword basis and can be localized to a file or even a subtree. For | |
3538 | information on how to clock working time for a task, see @ref{Clocking | |
3539 | work time}. | |
dbc28aaa CD |
3540 | |
3541 | @menu | |
3542 | * Closing items:: When was this entry marked DONE? | |
3543 | * Tracking TODO state changes:: When did the status change? | |
a351880d | 3544 | * Tracking your habits:: How consistent have you been? |
dbc28aaa CD |
3545 | @end menu |
3546 | ||
3547 | @node Closing items, Tracking TODO state changes, Progress logging, Progress logging | |
3548 | @subsection Closing items | |
3549 | ||
28a16a1b CD |
3550 | The most basic logging is to keep track of @emph{when} a certain TODO |
3551 | item was finished. This is achieved with@footnote{The corresponding | |
3552 | in-buffer setting is: @code{#+STARTUP: logdone}}. | |
dbc28aaa CD |
3553 | |
3554 | @lisp | |
28a16a1b | 3555 | (setq org-log-done 'time) |
dbc28aaa CD |
3556 | @end lisp |
3557 | ||
3558 | @noindent | |
28a16a1b CD |
3559 | Then each time you turn an entry from a TODO (not-done) state into any |
3560 | of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted | |
3561 | just after the headline. If you turn the entry back into a TODO item | |
3562 | through further state cycling, that line will be removed again. If you | |
3563 | want to record a note along with the timestamp, use@footnote{The | |
3564 | corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}} | |
dbc28aaa CD |
3565 | |
3566 | @lisp | |
28a16a1b | 3567 | (setq org-log-done 'note) |
dbc28aaa CD |
3568 | @end lisp |
3569 | ||
28a16a1b CD |
3570 | @noindent |
3571 | You will then be prompted for a note, and that note will be stored below | |
3572 | the entry with a @samp{Closing Note} heading. | |
3573 | ||
3574 | In the timeline (@pxref{Timeline}) and in the agenda | |
a7808fba | 3575 | (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to |
28a16a1b CD |
3576 | display the TODO items with a @samp{CLOSED} timestamp on each day, |
3577 | giving you an overview of what has been done. | |
3578 | ||
a351880d | 3579 | @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging |
dbc28aaa | 3580 | @subsection Tracking TODO state changes |
c8d0cf5c CD |
3581 | @cindex drawer, for state change recording |
3582 | ||
3583 | @vindex org-log-states-order-reversed | |
3584 | @vindex org-log-into-drawer | |
3585 | @cindex property, LOG_INTO_DRAWER | |
3586 | When TODO keywords are used as workflow states (@pxref{Workflow states}), you | |
3587 | might want to keep track of when a state change occurred and maybe take a | |
3588 | note about this change. You can either record just a timestamp, or a | |
3589 | time-stamped note for a change. These records will be inserted after the | |
3590 | headline as an itemized list, newest first@footnote{See the variable | |
3591 | @code{org-log-states-order-reversed}}. When taking a lot of notes, you might | |
3592 | want to get the notes out of the way into a drawer (@pxref{Drawers}). | |
3593 | Customize the variable @code{org-log-into-drawer} to get this | |
3594 | behavior---the recommended drawer for this is called @code{LOGBOOK}. You can | |
3595 | also overrule the setting of this variable for a subtree by setting a | |
3596 | @code{LOG_INTO_DRAWER} property. | |
3597 | ||
3598 | Since it is normally too much to record a note for every state, Org mode | |
3599 | expects configuration on a per-keyword basis for this. This is achieved by | |
3600 | adding special markers @samp{!} (for a timestamp) and @samp{@@} (for a note) | |
3601 | in parentheses after each keyword. For example, with the setting | |
dbc28aaa CD |
3602 | |
3603 | @lisp | |
28a16a1b CD |
3604 | (setq org-todo-keywords |
3605 | '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)"))) | |
dbc28aaa CD |
3606 | @end lisp |
3607 | ||
3608 | @noindent | |
c8d0cf5c | 3609 | @vindex org-log-done |
28a16a1b | 3610 | you not only define global TODO keywords and fast access keys, but also |
c8d0cf5c CD |
3611 | request that a time is recorded when the entry is set to |
3612 | DONE@footnote{It is possible that Org mode will record two timestamps | |
28a16a1b | 3613 | when you are using both @code{org-log-done} and state change logging. |
c8d0cf5c | 3614 | However, it will never prompt for two notes---if you have configured |
28a16a1b CD |
3615 | both, the state change recording note will take precedence and cancel |
3616 | the @samp{Closing Note}.}, and that a note is recorded when switching to | |
c8d0cf5c | 3617 | WAIT or CANCELED. The setting for WAIT is even more special: the |
28a16a1b | 3618 | @samp{!} after the slash means that in addition to the note taken when |
c8d0cf5c | 3619 | entering the state, a timestamp should be recorded when @i{leaving} the |
28a16a1b CD |
3620 | WAIT state, if and only if the @i{target} state does not configure |
3621 | logging for entering it. So it has no effect when switching from WAIT | |
3622 | to DONE, because DONE is configured to record a timestamp only. But | |
3623 | when switching from WAIT back to TODO, the @samp{/!} in the WAIT | |
3624 | setting now triggers a timestamp even though TODO has no logging | |
3625 | configured. | |
3626 | ||
3627 | You can use the exact same syntax for setting logging preferences local | |
3628 | to a buffer: | |
3629 | @example | |
c8d0cf5c | 3630 | #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@) |
28a16a1b CD |
3631 | @end example |
3632 | ||
c8d0cf5c | 3633 | @cindex property, LOGGING |
28a16a1b CD |
3634 | In order to define logging settings that are local to a subtree or a |
3635 | single item, define a LOGGING property in this entry. Any non-empty | |
3636 | LOGGING property resets all logging settings to nil. You may then turn | |
3637 | on logging for this specific tree using STARTUP keywords like | |
3638 | @code{lognotedone} or @code{logrepeat}, as well as adding state specific | |
3639 | settings like @code{TODO(!)}. For example | |
3640 | ||
3641 | @example | |
3642 | * TODO Log each state with only a time | |
3643 | :PROPERTIES: | |
3644 | :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!) | |
3645 | :END: | |
3646 | * TODO Only log when switching to WAIT, and when repeating | |
3647 | :PROPERTIES: | |
3648 | :LOGGING: WAIT(@@) logrepeat | |
3649 | :END: | |
3650 | * TODO No logging at all | |
3651 | :PROPERTIES: | |
3652 | :LOGGING: nil | |
3653 | :END: | |
dbc28aaa CD |
3654 | @end example |
3655 | ||
a351880d CD |
3656 | @node Tracking your habits, , Tracking TODO state changes, Progress logging |
3657 | @subsection Tracking your habits | |
3658 | @cindex habits | |
3659 | ||
3660 | Org has the ability to track the consistency of a special category of TODOs, | |
3661 | called ``habits''. A habit has the following properties: | |
3662 | ||
3663 | @enumerate | |
3664 | @item | |
3665 | You have enabled the @code{habits} module by customizing the variable | |
3666 | @code{org-modules}. | |
3667 | @item | |
3668 | The habit is a TODO, with a TODO keyword representing an open state. | |
3669 | @item | |
3670 | The property @code{STYLE} is set to the value @code{habit}. | |
3671 | @item | |
3672 | The TODO has a scheduled date, with a @code{.+} style repeat interval. | |
3673 | @item | |
3674 | The TODO may also have minimum and maximum ranges specified by using the | |
3675 | syntax @samp{.+2d/3d}, which says that you want to do the task at least every | |
3676 | three days, but at most every two days. | |
3677 | @item | |
3678 | You must also have state logging for the @code{DONE} state enabled, in order | |
3679 | for historical data to be represented in the consistency graph. If it's not | |
3680 | enabled it's not an error, but the consistency graphs will be largely | |
3681 | meaningless. | |
3682 | @end enumerate | |
3683 | ||
3684 | To give you an idea of what the above rules look like in action, here's an | |
3685 | actual habit with some history: | |
3686 | ||
3687 | @example | |
3688 | ** TODO Shave | |
3689 | SCHEDULED: <2009-10-17 Sat .+2d/4d> | |
3690 | - State "DONE" from "TODO" [2009-10-15 Thu] | |
3691 | - State "DONE" from "TODO" [2009-10-12 Mon] | |
3692 | - State "DONE" from "TODO" [2009-10-10 Sat] | |
3693 | - State "DONE" from "TODO" [2009-10-04 Sun] | |
3694 | - State "DONE" from "TODO" [2009-10-02 Fri] | |
3695 | - State "DONE" from "TODO" [2009-09-29 Tue] | |
3696 | - State "DONE" from "TODO" [2009-09-25 Fri] | |
3697 | - State "DONE" from "TODO" [2009-09-19 Sat] | |
3698 | - State "DONE" from "TODO" [2009-09-16 Wed] | |
3699 | - State "DONE" from "TODO" [2009-09-12 Sat] | |
3700 | :PROPERTIES: | |
3701 | :STYLE: habit | |
3702 | :LAST_REPEAT: [2009-10-19 Mon 00:36] | |
3703 | :END: | |
3704 | @end example | |
3705 | ||
3706 | What this habit says is: I want to shave at most every 2 days (given by the | |
3707 | @code{SCHEDULED} date and repeat interval) and at least every 4 days. If | |
3708 | today is the 15th, then the habit first appears in the agenda on Oct 17, | |
3709 | after the minimum of 2 days has elapsed, and will appear overdue on Oct 19, | |
3710 | after four days have elapsed. | |
3711 | ||
3712 | What's really useful about habits is that they are displayed along with a | |
3713 | consistency graph, to show how consistent you've been at getting that task | |
3714 | done in the past. This graph shows every day that the task was done over the | |
3715 | past three weeks, with colors for each day. The colors used are: | |
3716 | ||
3717 | @table @code | |
3718 | @item Blue | |
3719 | If the task wasn't to be done yet on that day. | |
3720 | @item Green | |
3721 | If the task could have been done on that day. | |
3722 | @item Yellow | |
3723 | If the task was going to be overdue the next day. | |
3724 | @item Red | |
3725 | If the task was overdue on that day. | |
3726 | @end table | |
3727 | ||
3728 | In addition to coloring each day, the day is also marked with an asterix if | |
3729 | the task was actually done that day, and an exclamation mark to show where | |
3730 | the current day falls in the graph. | |
3731 | ||
3732 | There are several configuration variables that can be used to change the way | |
3733 | habits are displayed in the agenda. | |
3734 | ||
3735 | @table @code | |
3736 | @item org-habit-graph-column | |
3737 | The buffer column at which the consistency graph should be drawn. This will | |
3738 | overwrite any text in that column, so it's a good idea to keep your habits' | |
3739 | titles brief and to the point. | |
3740 | @item org-habit-preceding-days | |
3741 | The amount of history, in days before today, to appear in consistency graphs. | |
3742 | @item org-habit-following-days | |
3743 | The number of days after today that will appear in consistency graphs. | |
3744 | @item org-habit-show-habits-only-for-today | |
3745 | If non-nil, only show habits in today's agenda view. This is set to true by | |
3746 | default. | |
3747 | @end table | |
3748 | ||
3749 | Lastly, pressing @kbd{K} in the agenda buffer will cause habits to | |
3750 | temporarily be disabled and they won't appear at all. Press @kbd{K} again to | |
3751 | bring them back. They are also subject to tag filtering, if you have habits | |
3752 | which should only be done in certain contexts, for example. | |
3753 | ||
a7808fba | 3754 | @node Priorities, Breaking down tasks, Progress logging, TODO Items |
4009494e GM |
3755 | @section Priorities |
3756 | @cindex priorities | |
3757 | ||
a7808fba | 3758 | If you use Org mode extensively, you may end up enough TODO items that |
dbc28aaa CD |
3759 | it starts to make sense to prioritize them. Prioritizing can be done by |
3760 | placing a @emph{priority cookie} into the headline of a TODO item, like | |
3761 | this | |
4009494e GM |
3762 | |
3763 | @example | |
3764 | *** TODO [#A] Write letter to Sam Fortune | |
3765 | @end example | |
3766 | ||
3767 | @noindent | |
a7808fba | 3768 | By default, Org mode supports three priorities: @samp{A}, @samp{B}, and |
dbc28aaa CD |
3769 | @samp{C}. @samp{A} is the highest priority. An entry without a cookie |
3770 | is treated as priority @samp{B}. Priorities make a difference only in | |
a7808fba CD |
3771 | the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they have |
3772 | no inherent meaning to Org mode. | |
dbc28aaa CD |
3773 | |
3774 | Priorities can be attached to any outline tree entries; they do not need | |
3775 | to be TODO items. | |
4009494e GM |
3776 | |
3777 | @table @kbd | |
3778 | @kindex @kbd{C-c ,} | |
3779 | @item @kbd{C-c ,} | |
3780 | Set the priority of the current headline. The command prompts for a | |
3781 | priority character @samp{A}, @samp{B} or @samp{C}. When you press | |
3782 | @key{SPC} instead, the priority cookie is removed from the headline. | |
3783 | The priorities can also be changed ``remotely'' from the timeline and | |
3784 | agenda buffer with the @kbd{,} command (@pxref{Agenda commands}). | |
3785 | @c | |
3786 | @kindex S-@key{up} | |
3787 | @kindex S-@key{down} | |
3788 | @item S-@key{up} | |
3789 | @itemx S-@key{down} | |
c8d0cf5c | 3790 | @vindex org-priority-start-cycle-with-default |
3da3282e | 3791 | Increase/decrease priority of current headline@footnote{See also the option |
c8d0cf5c CD |
3792 | @code{org-priority-start-cycle-with-default}.}. Note that these keys are |
3793 | also used to modify timestamps (@pxref{Creating timestamps}). See also | |
3794 | @ref{Conflicts}, for a discussion of the interaction with | |
3da3282e | 3795 | @code{shift-selection-mode}. |
4009494e GM |
3796 | @end table |
3797 | ||
c8d0cf5c CD |
3798 | @vindex org-highest-priority |
3799 | @vindex org-lowest-priority | |
3800 | @vindex org-default-priority | |
4009494e GM |
3801 | You can change the range of allowed priorities by setting the variables |
3802 | @code{org-highest-priority}, @code{org-lowest-priority}, and | |
3803 | @code{org-default-priority}. For an individual buffer, you may set | |
3804 | these values (highest, lowest, default) like this (please make sure that | |
3805 | the highest priority is earlier in the alphabet than the lowest | |
3806 | priority): | |
3807 | ||
c8d0cf5c | 3808 | @cindex #+PRIORITIES |
4009494e GM |
3809 | @example |
3810 | #+PRIORITIES: A C B | |
3811 | @end example | |
3812 | ||
a7808fba | 3813 | @node Breaking down tasks, Checkboxes, Priorities, TODO Items |
4009494e GM |
3814 | @section Breaking tasks down into subtasks |
3815 | @cindex tasks, breaking down | |
6eb02347 | 3816 | @cindex statistics, for TODO items |
4009494e | 3817 | |
c8d0cf5c | 3818 | @vindex org-agenda-todo-list-sublevels |
4009494e | 3819 | It is often advisable to break down large tasks into smaller, manageable |
b349f79f CD |
3820 | subtasks. You can do this by creating an outline tree below a TODO item, |
3821 | with detailed subtasks on the tree@footnote{To keep subtasks out of the | |
3822 | global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep | |
3823 | the overview over the fraction of subtasks that are already completed, insert | |
3824 | either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will | |
6eb02347 CD |
3825 | be updates each time the todo status of a child changes, or when pressing |
3826 | @kbd{C-c C-c} on the cookie. For example: | |
b349f79f CD |
3827 | |
3828 | @example | |
3829 | * Organize Party [33%] | |
3830 | ** TODO Call people [1/2] | |
3831 | *** TODO Peter | |
3832 | *** DONE Sarah | |
3833 | ** TODO Buy food | |
3834 | ** DONE Talk to neighbor | |
3835 | @end example | |
3836 | ||
c8d0cf5c CD |
3837 | @cindex property, COOKIE_DATA |
3838 | If a heading has both checkboxes and TODO children below it, the meaning of | |
3839 | the statistics cookie become ambiguous. Set the property | |
3840 | @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve | |
3841 | this issue. | |
3842 | ||
6eb02347 CD |
3843 | @vindex org-hierarchical-todo-statistics |
3844 | If you would like to have the statistics cookie count any TODO entries in the | |
a351880d | 3845 | subtree (not just direct children), configure the variable |
6eb02347 CD |
3846 | @code{org-hierarchical-todo-statistics}. To do this for a single subtree, |
3847 | include the word @samp{recursive} into the value of the @code{COOKIE_DATA} | |
3848 | property. | |
3849 | ||
3850 | @example | |
3851 | * Parent capturing statistics [2/20] | |
3852 | :PROPERTIES: | |
3853 | :COOKIE_DATA: todo recursive | |
3854 | :END: | |
3855 | @end example | |
3856 | ||
c8d0cf5c CD |
3857 | If you would like a TODO entry to automatically change to DONE |
3858 | when all children are done, you can use the following setup: | |
b349f79f CD |
3859 | |
3860 | @example | |
3861 | (defun org-summary-todo (n-done n-not-done) | |
3862 | "Switch entry to DONE when all subentries are done, to TODO otherwise." | |
3863 | (let (org-log-done org-log-states) ; turn off logging | |
3864 | (org-todo (if (= n-not-done 0) "DONE" "TODO")))) | |
3865 | ||
3866 | (add-hook 'org-after-todo-statistics-hook 'org-summary-todo) | |
3867 | @end example | |
3868 | ||
3869 | ||
3870 | Another possibility is the use of checkboxes to identify (a hierarchy of) a | |
3871 | large number of subtasks (@pxref{Checkboxes}). | |
4009494e GM |
3872 | |
3873 | ||
a7808fba | 3874 | @node Checkboxes, , Breaking down tasks, TODO Items |
4009494e GM |
3875 | @section Checkboxes |
3876 | @cindex checkboxes | |
3877 | ||
dbc28aaa CD |
3878 | Every item in a plain list (@pxref{Plain lists}) can be made into a |
3879 | checkbox by starting it with the string @samp{[ ]}. This feature is | |
a7808fba | 3880 | similar to TODO items (@pxref{TODO Items}), but is more lightweight. |
dbc28aaa CD |
3881 | Checkboxes are not included into the global TODO list, so they are often |
3882 | great to split a task into a number of simple steps. Or you can use | |
3883 | them in a shopping list. To toggle a checkbox, use @kbd{C-c C-c}, or | |
3884 | use the mouse (thanks to Piotr Zielinski's @file{org-mouse.el}). | |
3885 | ||
3886 | Here is an example of a checkbox list. | |
4009494e GM |
3887 | |
3888 | @example | |
28a16a1b CD |
3889 | * TODO Organize party [2/4] |
3890 | - [-] call people [1/3] | |
4009494e GM |
3891 | - [ ] Peter |
3892 | - [X] Sarah | |
3893 | - [ ] Sam | |
3894 | - [X] order food | |
3895 | - [ ] think about what music to play | |
3896 | - [X] talk to the neighbors | |
3897 | @end example | |
3898 | ||
28a16a1b CD |
3899 | Checkboxes work hierarchically, so if a checkbox item has children that |
3900 | are checkboxes, toggling one of the children checkboxes will make the | |
3901 | parent checkbox reflect if none, some, or all of the children are | |
3902 | checked. | |
3903 | ||
4009494e GM |
3904 | @cindex statistics, for checkboxes |
3905 | @cindex checkbox statistics | |
c8d0cf5c | 3906 | @cindex property, COOKIE_DATA |
6eb02347 | 3907 | @vindex org-hierarchical-checkbox-statistics |
c8d0cf5c CD |
3908 | The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies |
3909 | indicating how many checkboxes present in this entry have been checked off, | |
3910 | and the total number of checkboxes present. This can give you an idea on how | |
3911 | many checkboxes remain, even without opening a folded entry. The cookies can | |
3912 | be placed into a headline or into (the first line of) a plain list item. | |
3913 | Each cookie covers checkboxes of direct children structurally below the | |
3914 | headline/item on which the cookie appears@footnote{Set the variable | |
6eb02347 | 3915 | @code{org-hierarchical-checkbox-statistics} if you want such cookies to |
c8d0cf5c CD |
3916 | represent the all checkboxes below the cookie, not just the direct |
3917 | children.}. You have to insert the cookie yourself by typing either | |
3918 | @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m} | |
3919 | result, as in the examples above. With @samp{[%]} you get information about | |
3920 | the percentage of checkboxes checked (in the above example, this would be | |
3921 | @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can | |
3922 | count either checkboxes below the heading or TODO states of children, and it | |
3923 | will display whatever was changed last. Set the property @code{COOKIE_DATA} | |
3924 | to either @samp{checkbox} or @samp{todo} to resolve this issue. | |
3925 | ||
3926 | @cindex blocking, of checkboxes | |
3927 | @cindex checkbox blocking | |
3928 | @cindex property, ORDERED | |
3929 | If the current outline node has an @code{ORDERED} property, checkboxes must | |
3930 | be checked off in sequence, and an error will be thrown if you try to check | |
3931 | off a box while there are unchecked boxes above it. | |
4009494e GM |
3932 | |
3933 | @noindent The following commands work with checkboxes: | |
3934 | ||
3935 | @table @kbd | |
3936 | @kindex C-c C-c | |
3937 | @item C-c C-c | |
c8d0cf5c CD |
3938 | Toggle checkbox status or (with prefix arg) checkbox presence at point. With |
3939 | double prefix argument, set it to @samp{[-]}, which is considered to be an | |
3940 | intermediate state. | |
4009494e GM |
3941 | @kindex C-c C-x C-b |
3942 | @item C-c C-x C-b | |
c8d0cf5c CD |
3943 | Toggle checkbox status or (with prefix arg) checkbox presence at point. With |
3944 | double prefix argument, set it to @samp{[-]}, which is considered to be an | |
3945 | intermediate state. | |
4009494e GM |
3946 | @itemize @minus |
3947 | @item | |
3948 | If there is an active region, toggle the first checkbox in the region | |
7ddb1b5f CD |
3949 | and set all remaining boxes to the same status as the first. With a prefix |
3950 | arg, add or remove the checkbox for all items in the region. | |
4009494e GM |
3951 | @item |
3952 | If the cursor is in a headline, toggle checkboxes in the region between | |
3953 | this headline and the next (so @emph{not} the entire subtree). | |
3954 | @item | |
3955 | If there is no active region, just toggle the checkbox at point. | |
3956 | @end itemize | |
3957 | @kindex M-S-@key{RET} | |
3958 | @item M-S-@key{RET} | |
3959 | Insert a new item with a checkbox. | |
3960 | This works only if the cursor is already in a plain list item | |
3961 | (@pxref{Plain lists}). | |
c8d0cf5c CD |
3962 | @kindex C-c C-x o |
3963 | @item C-c C-x o | |
3964 | @vindex org-track-ordered-property-with-tag | |
3965 | @cindex property, ORDERED | |
3966 | Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must | |
3967 | be checked off in sequence. A property is used for this behavior because | |
3968 | this should be local to the current entry, not inherited like a tag. | |
3969 | However, if you would like to @i{track} the value of this property with a tag | |
3970 | for better visibility, customize the variable | |
3971 | @code{org-track-ordered-property-with-tag}. | |
4009494e GM |
3972 | @kindex C-c # |
3973 | @item C-c # | |
6eb02347 CD |
3974 | Update the statistics cookie in the current outline entry. When called with |
3975 | a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are | |
3976 | updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make | |
3977 | new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when | |
3978 | changing TODO states. If you delete boxes/entries or add/change them by | |
3979 | hand, use this command to get things back into sync. Or simply toggle any | |
3980 | entry twice (checkboxes with @kbd{C-c C-c}). | |
4009494e GM |
3981 | @end table |
3982 | ||
a7808fba | 3983 | @node Tags, Properties and Columns, TODO Items, Top |
4009494e GM |
3984 | @chapter Tags |
3985 | @cindex tags | |
3986 | @cindex headline tagging | |
3987 | @cindex matching, tags | |
3988 | @cindex sparse tree, tag based | |
3989 | ||
dbc28aaa | 3990 | An excellent way to implement labels and contexts for cross-correlating |
a7808fba | 3991 | information is to assign @i{tags} to headlines. Org mode has extensive |
dbc28aaa | 3992 | support for tags. |
4009494e | 3993 | |
c8d0cf5c | 3994 | @vindex org-tag-faces |
dbc28aaa | 3995 | Every headline can contain a list of tags; they occur at the end of the |
96c8522a | 3996 | headline. Tags are normal words containing letters, numbers, @samp{_}, and |
a351880d | 3997 | @samp{@@}. Tags must be preceded and followed by a single colon, e.g., |
96c8522a | 3998 | @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}. |
c8d0cf5c | 3999 | Tags will by default be in bold face with the same color as the headline. |
96c8522a | 4000 | You may specify special faces for specific tags using the variable |
c8d0cf5c | 4001 | @code{org-tag-faces}, in much the same way as you can for TODO keywords |
96c8522a | 4002 | (@pxref{Faces for TODO keywords}). |
4009494e GM |
4003 | |
4004 | @menu | |
4005 | * Tag inheritance:: Tags use the tree structure of the outline | |
4006 | * Setting tags:: How to assign tags to a headline | |
4007 | * Tag searches:: Searching for combinations of tags | |
4008 | @end menu | |
4009 | ||
4010 | @node Tag inheritance, Setting tags, Tags, Tags | |
4011 | @section Tag inheritance | |
dbc28aaa | 4012 | @cindex tag inheritance |
4009494e GM |
4013 | @cindex inheritance, of tags |
4014 | @cindex sublevels, inclusion into tags match | |
4015 | ||
4016 | @i{Tags} make use of the hierarchical structure of outline trees. If a | |
4017 | heading has a certain tag, all subheadings will inherit the tag as | |
4018 | well. For example, in the list | |
4019 | ||
4020 | @example | |
dbc28aaa CD |
4021 | * Meeting with the French group :work: |
4022 | ** Summary by Frank :boss:notes: | |
4023 | *** TODO Prepare slides for him :action: | |
4009494e GM |
4024 | @end example |
4025 | ||
4026 | @noindent | |
dbc28aaa CD |
4027 | the final heading will have the tags @samp{:work:}, @samp{:boss:}, |
4028 | @samp{:notes:}, and @samp{:action:} even though the final heading is not | |
b349f79f | 4029 | explicitly marked with those tags. You can also set tags that all entries in |
c8d0cf5c | 4030 | a file should inherit just as if these tags were defined in a hypothetical |
7006d207 CD |
4031 | level zero that surrounds the entire file. Use a line like this@footnote{As |
4032 | with all these in-buffer settings, pressing @kbd{C-c C-c} activates any | |
4033 | changes in the line.}: | |
b349f79f | 4034 | |
c8d0cf5c | 4035 | @cindex #+FILETAGS |
b349f79f CD |
4036 | @example |
4037 | #+FILETAGS: :Peter:Boss:Secret: | |
4038 | @end example | |
4039 | ||
4040 | @noindent | |
c8d0cf5c CD |
4041 | @vindex org-use-tag-inheritance |
4042 | @vindex org-tags-exclude-from-inheritance | |
b349f79f | 4043 | To limit tag inheritance to specific tags, or to turn it off entirely, use |
96c8522a CD |
4044 | the variables @code{org-use-tag-inheritance} and |
4045 | @code{org-tags-exclude-from-inheritance}. | |
b349f79f | 4046 | |
c8d0cf5c | 4047 | @vindex org-tags-match-list-sublevels |
b349f79f | 4048 | When a headline matches during a tags search while tag inheritance is turned |
96c8522a | 4049 | on, all the sublevels in the same tree will (for a simple match form) match |
07450bee | 4050 | as well@footnote{This is only true if the search does not involve more |
96c8522a CD |
4051 | complex tests including properties (@pxref{Property searches}).}. The list |
4052 | of matches may then become very long. If you only want to see the first tags | |
4053 | match in a subtree, configure the variable | |
4054 | @code{org-tags-match-list-sublevels} (not recommended). | |
4009494e GM |
4055 | |
4056 | @node Setting tags, Tag searches, Tag inheritance, Tags | |
4057 | @section Setting tags | |
4058 | @cindex setting tags | |
4059 | @cindex tags, setting | |
4060 | ||
4061 | @kindex M-@key{TAB} | |
4062 | Tags can simply be typed into the buffer at the end of a headline. | |
4063 | After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is | |
4064 | also a special command for inserting tags: | |
4065 | ||
4066 | @table @kbd | |
71d35b24 CD |
4067 | @kindex C-c C-q |
4068 | @item C-c C-q | |
4009494e | 4069 | @cindex completion, of tags |
c8d0cf5c | 4070 | @vindex org-tags-column |
a7808fba | 4071 | Enter new tags for the current headline. Org mode will either offer |
4009494e GM |
4072 | completion or a special single-key interface for setting tags, see |
4073 | below. After pressing @key{RET}, the tags will be inserted and aligned | |
4074 | to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all | |
4075 | tags in the current buffer will be aligned to that column, just to make | |
4076 | things look nice. TAGS are automatically realigned after promotion, | |
4077 | demotion, and TODO state changes (@pxref{TODO basics}). | |
71d35b24 CD |
4078 | @kindex C-c C-c |
4079 | @item C-c C-c | |
4080 | When the cursor is in a headline, this does the same as @kbd{C-c C-q}. | |
4009494e GM |
4081 | @end table |
4082 | ||
c8d0cf5c | 4083 | @vindex org-tag-alist |
4009494e GM |
4084 | Org will support tag insertion based on a @emph{list of tags}. By |
4085 | default this list is constructed dynamically, containing all tags | |
4086 | currently used in the buffer. You may also globally specify a hard list | |
4087 | of tags with the variable @code{org-tag-alist}. Finally you can set | |
4088 | the default tags for a given file with lines like | |
4089 | ||
c8d0cf5c | 4090 | @cindex #+TAGS |
4009494e | 4091 | @example |
dbc28aaa CD |
4092 | #+TAGS: @@work @@home @@tennisclub |
4093 | #+TAGS: laptop car pc sailboat | |
4009494e GM |
4094 | @end example |
4095 | ||
4096 | If you have globally defined your preferred set of tags using the | |
4097 | variable @code{org-tag-alist}, but would like to use a dynamic tag list | |
dbc28aaa | 4098 | in a specific file, add an empty TAGS option line to that file: |
4009494e GM |
4099 | |
4100 | @example | |
4101 | #+TAGS: | |
4102 | @end example | |
4103 | ||
c8d0cf5c CD |
4104 | @vindex org-tag-persistent-alist |
4105 | If you have a preferred set of tags that you would like to use in every file, | |
4106 | in addition to those defined on a per-file basis by TAGS option lines, then | |
4107 | you may specify a list of tags with the variable | |
4108 | @code{org-tag-persistent-alist}. You may turn this off on a per-file basis | |
4109 | by adding a STARTUP option line to that file: | |
4110 | ||
4111 | @example | |
4112 | #+STARTUP: noptag | |
4113 | @end example | |
4114 | ||
a7808fba CD |
4115 | By default Org mode uses the standard minibuffer completion facilities for |
4116 | entering tags. However, it also implements another, quicker, tag selection | |
4117 | method called @emph{fast tag selection}. This allows you to select and | |
4118 | deselect tags with just a single key press. For this to work well you should | |
4119 | assign unique letters to most of your commonly used tags. You can do this | |
4120 | globally by configuring the variable @code{org-tag-alist} in your | |
4121 | @file{.emacs} file. For example, you may find the need to tag many items in | |
4122 | different files with @samp{:@@home:}. In this case you can set something | |
4123 | like: | |
4009494e GM |
4124 | |
4125 | @lisp | |
dbc28aaa | 4126 | (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l))) |
4009494e GM |
4127 | @end lisp |
4128 | ||
c8d0cf5c CD |
4129 | @noindent If the tag is only relevant to the file you are working on, then you |
4130 | can instead set the TAGS option line as: | |
4009494e GM |
4131 | |
4132 | @example | |
dbc28aaa | 4133 | #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p) |
4009494e GM |
4134 | @end example |
4135 | ||
c8d0cf5c CD |
4136 | @noindent The tags interface will show the available tags in a splash |
4137 | window. If you want to start a new line after a specific tag, insert | |
4138 | @samp{\n} into the tag list | |
4139 | ||
4140 | @example | |
4141 | #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p) | |
4142 | @end example | |
4143 | ||
4144 | @noindent or write them in two lines: | |
4145 | ||
4146 | @example | |
4147 | #+TAGS: @@work(w) @@home(h) @@tennisclub(t) | |
4148 | #+TAGS: laptop(l) pc(p) | |
4149 | @end example | |
4150 | ||
4009494e | 4151 | @noindent |
c8d0cf5c | 4152 | You can also group together tags that are mutually exclusive by using |
a7808fba | 4153 | braces, as in: |
4009494e GM |
4154 | |
4155 | @example | |
dbc28aaa | 4156 | #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p) |
4009494e GM |
4157 | @end example |
4158 | ||
dbc28aaa | 4159 | @noindent you indicate that at most one of @samp{@@work}, @samp{@@home}, |
a7808fba | 4160 | and @samp{@@tennisclub} should be selected. Multiple such groups are allowed. |
4009494e GM |
4161 | |
4162 | @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of | |
4163 | these lines to activate any changes. | |
4164 | ||
a7808fba | 4165 | @noindent |
c8d0cf5c | 4166 | To set these mutually exclusive groups in the variable @code{org-tags-alist}, |
a7808fba | 4167 | you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead |
c8d0cf5c CD |
4168 | of the braces. Similarly, you can use @code{:newline} to indicate a line |
4169 | break. The previous example would be set globally by the following | |
a7808fba CD |
4170 | configuration: |
4171 | ||
4172 | @lisp | |
4173 | (setq org-tag-alist '((:startgroup . nil) | |
4174 | ("@@work" . ?w) ("@@home" . ?h) | |
4175 | ("@@tennisclub" . ?t) | |
4176 | (:endgroup . nil) | |
4177 | ("laptop" . ?l) ("pc" . ?p))) | |
4178 | @end lisp | |
4179 | ||
4180 | If at least one tag has a selection key then pressing @kbd{C-c C-c} will | |
4181 | automatically present you with a special interface, listing inherited tags, | |
4182 | the tags of the current headline, and a list of all valid tags with | |
4183 | corresponding keys@footnote{Keys will automatically be assigned to tags which | |
4184 | have no configured keys.}. In this interface, you can use the following | |
4185 | keys: | |
4009494e GM |
4186 | |
4187 | @table @kbd | |
4188 | @item a-z... | |
4189 | Pressing keys assigned to tags will add or remove them from the list of | |
4190 | tags in the current line. Selecting a tag in a group of mutually | |
4191 | exclusive tags will turn off any other tags from that group. | |
4192 | @kindex @key{TAB} | |
4193 | @item @key{TAB} | |
4194 | Enter a tag in the minibuffer, even if the tag is not in the predefined | |
4195 | list. You will be able to complete on all tags present in the buffer. | |
4196 | @kindex @key{SPC} | |
4197 | @item @key{SPC} | |
4198 | Clear all tags for this line. | |
4199 | @kindex @key{RET} | |
4200 | @item @key{RET} | |
4201 | Accept the modified set. | |
4202 | @item C-g | |
4203 | Abort without installing changes. | |
4204 | @item q | |
4205 | If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}. | |
4206 | @item ! | |
4207 | Turn off groups of mutually exclusive tags. Use this to (as an | |
4208 | exception) assign several tags from such a group. | |
4209 | @item C-c | |
4210 | Toggle auto-exit after the next change (see below). | |
4211 | If you are using expert mode, the first @kbd{C-c} will display the | |
4212 | selection window. | |
4213 | @end table | |
4214 | ||
4215 | @noindent | |
4216 | This method lets you assign tags to a headline with very few keys. With | |
dbc28aaa CD |
4217 | the above setup, you could clear the current tags and set @samp{@@home}, |
4218 | @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c | |
4219 | C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to | |
4220 | @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or | |
4009494e GM |
4221 | alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag |
4222 | @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h | |
4223 | @key{RET} @key{RET}}. | |
4224 | ||
c8d0cf5c CD |
4225 | @vindex org-fast-tag-selection-single-key |
4226 | If you find that most of the time you need only a single key press to | |
4009494e GM |
4227 | modify your list of tags, set the variable |
4228 | @code{org-fast-tag-selection-single-key}. Then you no longer have to | |
c8d0cf5c | 4229 | press @key{RET} to exit fast tag selection---it will immediately exit |
4009494e GM |
4230 | after the first change. If you then occasionally need more keys, press |
4231 | @kbd{C-c} to turn off auto-exit for the current tag selection process | |
4232 | (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c | |
4233 | C-c}). If you set the variable to the value @code{expert}, the special | |
4234 | window is not even shown for single-key tag selection, it comes up only | |
4235 | when you press an extra @kbd{C-c}. | |
4236 | ||
4237 | @node Tag searches, , Setting tags, Tags | |
4238 | @section Tag searches | |
4239 | @cindex tag searches | |
4240 | @cindex searching for tags | |
4241 | ||
dbc28aaa | 4242 | Once a system of tags has been set up, it can be used to collect related |
4009494e GM |
4243 | information into special lists. |
4244 | ||
4245 | @table @kbd | |
4246 | @kindex C-c \ | |
c8d0cf5c | 4247 | @kindex C-c / m |
4009494e | 4248 | @item C-c \ |
c8d0cf5c | 4249 | @itemx C-c / m |
4009494e GM |
4250 | Create a sparse tree with all headlines matching a tags search. With a |
4251 | @kbd{C-u} prefix argument, ignore headlines that are not a TODO line. | |
4252 | @kindex C-c a m | |
4253 | @item C-c a m | |
4254 | Create a global list of tag matches from all agenda files. | |
4255 | @xref{Matching tags and properties}. | |
4256 | @kindex C-c a M | |
4257 | @item C-c a M | |
c8d0cf5c | 4258 | @vindex org-tags-match-list-sublevels |
4009494e GM |
4259 | Create a global list of tag matches from all agenda files, but check |
4260 | only TODO items and force checking subitems (see variable | |
4261 | @code{org-tags-match-list-sublevels}). | |
4262 | @end table | |
4263 | ||
c8d0cf5c CD |
4264 | These commands all prompt for a match string which allows basic Boolean logic |
4265 | like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and | |
4266 | @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries | |
4267 | which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search | |
4268 | string is rich and allows also matching against TODO keywords, entry levels | |
4269 | and properties. For a complete description with many examples, see | |
4270 | @ref{Matching tags and properties}. | |
dbc28aaa | 4271 | |
e45e3595 | 4272 | |
a7808fba | 4273 | @node Properties and Columns, Dates and Times, Tags, Top |
4009494e GM |
4274 | @chapter Properties and Columns |
4275 | @cindex properties | |
4276 | ||
4277 | Properties are a set of key-value pairs associated with an entry. There | |
a7808fba | 4278 | are two main applications for properties in Org mode. First, properties |
dbc28aaa | 4279 | are like tags, but with a value. Second, you can use properties to |
a7808fba | 4280 | implement (very basic) database capabilities in an Org buffer. For |
dbc28aaa | 4281 | an example of the first application, imagine maintaining a file where |
c8d0cf5c | 4282 | you document bugs and plan releases for a piece of software. Instead of |
dbc28aaa CD |
4283 | using tags like @code{:release_1:}, @code{:release_2:}, one can use a |
4284 | property, say @code{:Release:}, that in different subtrees has different | |
4285 | values, such as @code{1.0} or @code{2.0}. For an example of the second | |
a50253cc | 4286 | application of properties, imagine keeping track of your music CDs, |
c8d0cf5c | 4287 | where properties could be things such as the album, artist, date of |
dbc28aaa CD |
4288 | release, number of tracks, and so on. |
4289 | ||
28a16a1b | 4290 | Properties can be conveniently edited and viewed in column view |
dbc28aaa CD |
4291 | (@pxref{Column view}). |
4292 | ||
4009494e GM |
4293 | @menu |
4294 | * Property syntax:: How properties are spelled out | |
a7808fba | 4295 | * Special properties:: Access to other Org mode features |
4009494e | 4296 | * Property searches:: Matching property values |
dbc28aaa | 4297 | * Property inheritance:: Passing values down the tree |
4009494e GM |
4298 | * Column view:: Tabular viewing and editing |
4299 | * Property API:: Properties for Lisp programmers | |
4300 | @end menu | |
4301 | ||
a7808fba CD |
4302 | @node Property syntax, Special properties, Properties and Columns, Properties and Columns |
4303 | @section Property syntax | |
4009494e GM |
4304 | @cindex property syntax |
4305 | @cindex drawer, for properties | |
4306 | ||
4307 | Properties are key-value pairs. They need to be inserted into a special | |
4308 | drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property | |
4309 | is specified on a single line, with the key (surrounded by colons) | |
4310 | first, and the value after it. Here is an example: | |
4311 | ||
4312 | @example | |
4313 | * CD collection | |
4314 | ** Classic | |
4315 | *** Goldberg Variations | |
4316 | :PROPERTIES: | |
4317 | :Title: Goldberg Variations | |
4318 | :Composer: J.S. Bach | |
28a16a1b | 4319 | :Artist: Glen Gould |
c8d0cf5c | 4320 | :Publisher: Deutsche Grammophon |
4009494e | 4321 | :NDisks: 1 |
28a16a1b | 4322 | :END: |
4009494e GM |
4323 | @end example |
4324 | ||
dbc28aaa CD |
4325 | You may define the allowed values for a particular property @samp{:Xyz:} |
4326 | by setting a property @samp{:Xyz_ALL:}. This special property is | |
4009494e GM |
4327 | @emph{inherited}, so if you set it in a level 1 entry, it will apply to |
4328 | the entire tree. When allowed values are defined, setting the | |
4329 | corresponding property becomes easier and is less prone to typing | |
4330 | errors. For the example with the CD collection, we can predefine | |
4331 | publishers and the number of disks in a box like this: | |
4332 | ||
4333 | @example | |
4334 | * CD collection | |
4335 | :PROPERTIES: | |
4336 | :NDisks_ALL: 1 2 3 4 | |
64fb801f | 4337 | :Publisher_ALL: "Deutsche Grammophon" Philips EMI |
4009494e GM |
4338 | :END: |
4339 | @end example | |
4340 | ||
4341 | If you want to set properties that can be inherited by any entry in a | |
4342 | file, use a line like | |
c8d0cf5c CD |
4343 | @cindex property, _ALL |
4344 | @cindex #+PROPERTY | |
4009494e GM |
4345 | @example |
4346 | #+PROPERTY: NDisks_ALL 1 2 3 4 | |
4347 | @end example | |
4348 | ||
c8d0cf5c | 4349 | @vindex org-global-properties |
4009494e GM |
4350 | Property values set with the global variable |
4351 | @code{org-global-properties} can be inherited by all entries in all | |
a7808fba | 4352 | Org files. |
4009494e GM |
4353 | |
4354 | @noindent | |
4355 | The following commands help to work with properties: | |
4356 | ||
4357 | @table @kbd | |
4358 | @kindex M-@key{TAB} | |
4359 | @item M-@key{TAB} | |
4360 | After an initial colon in a line, complete property keys. All keys used | |
4361 | in the current file will be offered as possible completions. | |
dbc28aaa CD |
4362 | @kindex C-c C-x p |
4363 | @item C-c C-x p | |
4364 | Set a property. This prompts for a property name and a value. If | |
4365 | necessary, the property drawer is created as well. | |
4009494e GM |
4366 | @item M-x org-insert-property-drawer |
4367 | Insert a property drawer into the current entry. The drawer will be | |
4368 | inserted early in the entry, but after the lines with planning | |
4369 | information like deadlines. | |
4370 | @kindex C-c C-c | |
4371 | @item C-c C-c | |
4372 | With the cursor in a property drawer, this executes property commands. | |
4373 | @item C-c C-c s | |
4374 | Set a property in the current entry. Both the property and the value | |
4375 | can be inserted using completion. | |
4376 | @kindex S-@key{right} | |
4377 | @kindex S-@key{left} | |
4378 | @item S-@key{left}/@key{right} | |
4379 | Switch property at point to the next/previous allowed value. | |
4380 | @item C-c C-c d | |
4381 | Remove a property from the current entry. | |
4382 | @item C-c C-c D | |
4383 | Globally remove a property, from all entries in the current file. | |
dbc28aaa CD |
4384 | @item C-c C-c c |
4385 | Compute the property at point, using the operator and scope from the | |
4386 | nearest column format definition. | |
4009494e GM |
4387 | @end table |
4388 | ||
a7808fba CD |
4389 | @node Special properties, Property searches, Property syntax, Properties and Columns |
4390 | @section Special properties | |
4009494e GM |
4391 | @cindex properties, special |
4392 | ||
c8d0cf5c CD |
4393 | Special properties provide an alternative access method to Org mode |
4394 | features, like the TODO state or the priority of an entry, discussed in the | |
4395 | previous chapters. This interface exists so that you can include | |
4396 | these states in a column view (@pxref{Column view}), or to use them in | |
dbc28aaa CD |
4397 | queries. The following property names are special and should not be |
4398 | used as keys in the properties drawer: | |
4009494e | 4399 | |
c8d0cf5c CD |
4400 | @cindex property, special, TODO |
4401 | @cindex property, special, TAGS | |
4402 | @cindex property, special, ALLTAGS | |
4403 | @cindex property, special, CATEGORY | |
4404 | @cindex property, special, PRIORITY | |
4405 | @cindex property, special, DEADLINE | |
4406 | @cindex property, special, SCHEDULED | |
4407 | @cindex property, special, CLOSED | |
4408 | @cindex property, special, TIMESTAMP | |
4409 | @cindex property, special, TIMESTAMP_IA | |
4410 | @cindex property, special, CLOCKSUM | |
4411 | @c guessing that ITEM is needed in this area; also, should this list be sorted? | |
4412 | @cindex property, special, ITEM | |
4009494e GM |
4413 | @example |
4414 | TODO @r{The TODO keyword of the entry.} | |
4415 | TAGS @r{The tags defined directly in the headline.} | |
4416 | ALLTAGS @r{All tags, including inherited ones.} | |
c8d0cf5c | 4417 | CATEGORY @r{The category of an entry.} |
4009494e GM |
4418 | PRIORITY @r{The priority of the entry, a string with a single letter.} |
4419 | DEADLINE @r{The deadline time string, without the angular brackets.} | |
c8d0cf5c CD |
4420 | SCHEDULED @r{The scheduling timestamp, without the angular brackets.} |
4421 | CLOSED @r{When was this entry closed?} | |
4422 | TIMESTAMP @r{The first keyword-less timestamp in the entry.} | |
4423 | TIMESTAMP_IA @r{The first inactive timestamp in the entry.} | |
dbc28aaa CD |
4424 | CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}} |
4425 | @r{must be run first to compute the values.} | |
c8d0cf5c | 4426 | ITEM @r{The content of the entry.} |
4009494e GM |
4427 | @end example |
4428 | ||
a7808fba | 4429 | @node Property searches, Property inheritance, Special properties, Properties and Columns |
4009494e GM |
4430 | @section Property searches |
4431 | @cindex properties, searching | |
dbc28aaa | 4432 | @cindex searching, of properties |
4009494e | 4433 | |
a7808fba | 4434 | To create sparse trees and special lists with selection based on properties, |
c8d0cf5c CD |
4435 | the same commands are used as for tag searches (@pxref{Tag searches}). |
4436 | @table @kbd | |
4437 | @kindex C-c \ | |
4438 | @kindex C-c / m | |
4439 | @item C-c \ | |
4440 | @itemx C-c / m | |
4441 | Create a sparse tree with all matching entries. With a | |
4442 | @kbd{C-u} prefix argument, ignore headlines that are not a TODO line. | |
4443 | @kindex C-c a m | |
4444 | @item C-c a m | |
4445 | Create a global list of tag/property matches from all agenda files. | |
4446 | @xref{Matching tags and properties}. | |
4447 | @kindex C-c a M | |
4448 | @item C-c a M | |
4449 | @vindex org-tags-match-list-sublevels | |
4450 | Create a global list of tag matches from all agenda files, but check | |
4451 | only TODO items and force checking of subitems (see variable | |
4452 | @code{org-tags-match-list-sublevels}). | |
4453 | @end table | |
a7808fba | 4454 | |
c8d0cf5c CD |
4455 | The syntax for the search string is described in @ref{Matching tags and |
4456 | properties}. | |
dbc28aaa CD |
4457 | |
4458 | There is also a special command for creating sparse trees based on a | |
4459 | single property: | |
4460 | ||
4461 | @table @kbd | |
4462 | @kindex C-c / p | |
4463 | @item C-c / p | |
4464 | Create a sparse tree based on the value of a property. This first | |
4465 | prompts for the name of a property, and then for a value. A sparse tree | |
4466 | is created with all entries that define this property with the given | |
4467 | value. If you enclose the value into curly braces, it is interpreted as | |
4468 | a regular expression and matched against the property values. | |
4469 | @end table | |
4470 | ||
a7808fba | 4471 | @node Property inheritance, Column view, Property searches, Properties and Columns |
dbc28aaa | 4472 | @section Property Inheritance |
a7808fba CD |
4473 | @cindex properties, inheritance |
4474 | @cindex inheritance, of properties | |
dbc28aaa | 4475 | |
c8d0cf5c CD |
4476 | @vindex org-use-property-inheritance |
4477 | The outline structure of Org-mode documents lends itself for an | |
4478 | inheritance model of properties: if the parent in a tree has a certain | |
a7808fba | 4479 | property, the children can inherit this property. Org mode does not |
dbc28aaa CD |
4480 | turn this on by default, because it can slow down property searches |
4481 | significantly and is often not needed. However, if you find inheritance | |
4482 | useful, you can turn it on by setting the variable | |
c8d0cf5c | 4483 | @code{org-use-property-inheritance}. It may be set to @code{t} to make |
a7808fba CD |
4484 | all properties inherited from the parent, to a list of properties |
4485 | that should be inherited, or to a regular expression that matches | |
4486 | inherited properties. | |
dbc28aaa | 4487 | |
a7808fba | 4488 | Org mode has a few properties for which inheritance is hard-coded, at |
dbc28aaa CD |
4489 | least for the special applications for which they are used: |
4490 | ||
c8d0cf5c | 4491 | @cindex property, COLUMNS |
dbc28aaa CD |
4492 | @table @code |
4493 | @item COLUMNS | |
4494 | The @code{:COLUMNS:} property defines the format of column view | |
4495 | (@pxref{Column view}). It is inherited in the sense that the level | |
4496 | where a @code{:COLUMNS:} property is defined is used as the starting | |
4497 | point for a column view table, independently of the location in the | |
4498 | subtree from where columns view is turned on. | |
4499 | @item CATEGORY | |
c8d0cf5c | 4500 | @cindex property, CATEGORY |
dbc28aaa CD |
4501 | For agenda view, a category set through a @code{:CATEGORY:} property |
4502 | applies to the entire subtree. | |
4503 | @item ARCHIVE | |
c8d0cf5c | 4504 | @cindex property, ARCHIVE |
dbc28aaa CD |
4505 | For archiving, the @code{:ARCHIVE:} property may define the archive |
4506 | location for the entire subtree (@pxref{Moving subtrees}). | |
28a16a1b | 4507 | @item LOGGING |
c8d0cf5c | 4508 | @cindex property, LOGGING |
28a16a1b CD |
4509 | The LOGGING property may define logging settings for an entry or a |
4510 | subtree (@pxref{Tracking TODO state changes}). | |
dbc28aaa CD |
4511 | @end table |
4512 | ||
a7808fba CD |
4513 | @node Column view, Property API, Property inheritance, Properties and Columns |
4514 | @section Column view | |
4009494e GM |
4515 | |
4516 | A great way to view and edit properties in an outline tree is | |
c8d0cf5c | 4517 | @emph{column view}. In column view, each outline node is turned into a |
4009494e | 4518 | table row. Columns in this table provide access to properties of the |
a7808fba | 4519 | entries. Org mode implements columns by overlaying a tabular structure |
4009494e GM |
4520 | over the headline of each item. While the headlines have been turned |
4521 | into a table row, you can still change the visibility of the outline | |
4522 | tree. For example, you get a compact table by switching to CONTENTS | |
4523 | view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view | |
4524 | is active), but you can still open, read, and edit the entry below each | |
4525 | headline. Or, you can switch to column view after executing a sparse | |
4526 | tree command and in this way get a table only for the selected items. | |
a7808fba | 4527 | Column view also works in agenda buffers (@pxref{Agenda Views}) where |
4009494e GM |
4528 | queries have collected selected items, possibly from a number of files. |
4529 | ||
4530 | @menu | |
4531 | * Defining columns:: The COLUMNS format property | |
4532 | * Using column view:: How to create and use column view | |
a7808fba | 4533 | * Capturing column view:: A dynamic block for column view |
4009494e GM |
4534 | @end menu |
4535 | ||
4536 | @node Defining columns, Using column view, Column view, Column view | |
a7808fba | 4537 | @subsection Defining columns |
4009494e GM |
4538 | @cindex column view, for properties |
4539 | @cindex properties, column view | |
4540 | ||
4541 | Setting up a column view first requires defining the columns. This is | |
4542 | done by defining a column format line. | |
4543 | ||
4544 | @menu | |
4545 | * Scope of column definitions:: Where defined, where valid? | |
4546 | * Column attributes:: Appearance and content of a column | |
4547 | @end menu | |
4548 | ||
4549 | @node Scope of column definitions, Column attributes, Defining columns, Defining columns | |
4550 | @subsubsection Scope of column definitions | |
4551 | ||
4552 | To define a column format for an entire file, use a line like | |
4553 | ||
c8d0cf5c | 4554 | @cindex #+COLUMNS |
4009494e GM |
4555 | @example |
4556 | #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO | |
4557 | @end example | |
4558 | ||
dbc28aaa CD |
4559 | To specify a format that only applies to a specific tree, add a |
4560 | @code{:COLUMNS:} property to the top node of that tree, for example: | |
4561 | ||
4009494e GM |
4562 | @example |
4563 | ** Top node for columns view | |
4564 | :PROPERTIES: | |
4565 | :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO | |
4566 | :END: | |
4567 | @end example | |
4568 | ||
dbc28aaa | 4569 | If a @code{:COLUMNS:} property is present in an entry, it defines columns |
4009494e GM |
4570 | for the entry itself, and for the entire subtree below it. Since the |
4571 | column definition is part of the hierarchical structure of the document, | |
4572 | you can define columns on level 1 that are general enough for all | |
4573 | sublevels, and more specific columns further down, when you edit a | |
4574 | deeper part of the tree. | |
4575 | ||
4576 | @node Column attributes, , Scope of column definitions, Defining columns | |
4577 | @subsubsection Column attributes | |
4578 | A column definition sets the attributes of a column. The general | |
4579 | definition looks like this: | |
4580 | ||
4581 | @example | |
c8d0cf5c | 4582 | %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}] |
4009494e GM |
4583 | @end example |
4584 | ||
4585 | @noindent | |
4586 | Except for the percent sign and the property name, all items are | |
4587 | optional. The individual parts have the following meaning: | |
4588 | ||
4589 | @example | |
c8d0cf5c | 4590 | @var{width} @r{An integer specifying the width of the column in characters.} |
72d803ad | 4591 | @r{If omitted, the width will be determined automatically.} |
c8d0cf5c | 4592 | @var{property} @r{The property that should be edited in this column.} |
72d803ad CD |
4593 | @r{Special properties representing meta data are allowed here} |
4594 | @r{as well (@pxref{Special properties})} | |
4009494e | 4595 | (title) @r{The header text for the column. If omitted, the} |
72d803ad | 4596 | @r{property name is used.} |
c8d0cf5c | 4597 | @{@var{summary-type}@} @r{The summary type. If specified, the column values for} |
72d803ad CD |
4598 | @r{parent nodes are computed from the children.} |
4599 | @r{Supported summary types are:} | |
4600 | @{+@} @r{Sum numbers in this column.} | |
4601 | @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.} | |
4602 | @{$@} @r{Currency, short for @samp{+;%.2f}.} | |
4603 | @{:@} @r{Sum times, HH:MM:SS, plain numbers are hours.} | |
4604 | @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.} | |
4605 | @{X/@} @r{Checkbox status, @samp{[n/m]}.} | |
4606 | @{X%@} @r{Checkbox status, @samp{[n%]}.} | |
4607 | @{min@} @r{Smallest number in column.} | |
4608 | @{max@} @r{Largest number.} | |
4609 | @{mean@} @r{Arithmetic mean of numbers.} | |
4610 | @{:min@} @r{Smallest time value in column.} | |
4611 | @{:max@} @r{Largest time value.} | |
4612 | @{:mean@} @r{Arithmetic mean of time values.} | |
4613 | @{@@min@} @r{Minimum age (in days/hours/mins/seconds).} | |
4614 | @{@@max@} @r{Maximum age (in days/hours/mins/seconds).} | |
4615 | @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).} | |
4009494e GM |
4616 | @end example |
4617 | ||
4618 | @noindent | |
a351880d CD |
4619 | Be aware that you can only have one summary type for any property you |
4620 | include. Subsequent columns referencing the same property will all display the | |
4621 | same summary information. | |
4622 | ||
4009494e GM |
4623 | Here is an example for a complete columns definition, along with allowed |
4624 | values. | |
4625 | ||
4626 | @example | |
7006d207 | 4627 | :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.} |
b1fbbb32 | 4628 | %10Time_Estimate@{:@} %CLOCKSUM |
4009494e GM |
4629 | :Owner_ALL: Tammy Mark Karl Lisa Don |
4630 | :Status_ALL: "In progress" "Not started yet" "Finished" "" | |
4631 | :Approved_ALL: "[ ]" "[X]" | |
4632 | @end example | |
4633 | ||
c8d0cf5c | 4634 | @noindent |
4009494e | 4635 | The first column, @samp{%25ITEM}, means the first 25 characters of the |
a351880d | 4636 | item itself, i.e. of the headline. You probably always should start the |
28a16a1b CD |
4637 | column definition with the @samp{ITEM} specifier. The other specifiers |
4638 | create columns @samp{Owner} with a list of names as allowed values, for | |
4009494e GM |
4639 | @samp{Status} with four different possible values, and for a checkbox |
4640 | field @samp{Approved}. When no width is given after the @samp{%} | |
4641 | character, the column will be exactly as wide as it needs to be in order | |
4642 | to fully display all values. The @samp{Approved} column does have a | |
4643 | modified title (@samp{Approved?}, with a question mark). Summaries will | |
dbc28aaa | 4644 | be created for the @samp{Time_Estimate} column by adding time duration |
4009494e | 4645 | expressions like HH:MM, and for the @samp{Approved} column, by providing |
dbc28aaa CD |
4646 | an @samp{[X]} status if all children have been checked. The |
4647 | @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals | |
4648 | in the subtree. | |
4009494e | 4649 | |
a7808fba CD |
4650 | @node Using column view, Capturing column view, Defining columns, Column view |
4651 | @subsection Using column view | |
4009494e GM |
4652 | |
4653 | @table @kbd | |
4654 | @tsubheading{Turning column view on and off} | |
4655 | @kindex C-c C-x C-c | |
4656 | @item C-c C-x C-c | |
c8d0cf5c CD |
4657 | @vindex org-columns-default-format |
4658 | Turn on column view. If the cursor is before the first headline in the file, | |
4659 | column view is turned on for the entire file, using the @code{#+COLUMNS} | |
a351880d | 4660 | definition. If the cursor is somewhere inside the outline, this command |
c8d0cf5c CD |
4661 | searches the hierarchy, up from point, for a @code{:COLUMNS:} property that |
4662 | defines a format. When one is found, the column view table is established | |
4663 | for the tree starting at the entry that contains the @code{:COLUMNS:} | |
4664 | property. If no such property is found, the format is taken from the | |
4665 | @code{#+COLUMNS} line or from the variable @code{org-columns-default-format}, | |
4666 | and column view is established for the current entry and its subtree. | |
28a16a1b CD |
4667 | @kindex r |
4668 | @item r | |
a7808fba | 4669 | Recreate the column view, to include recent changes made in the buffer. |
28a16a1b CD |
4670 | @kindex g |
4671 | @item g | |
4672 | Same as @kbd{r}. | |
4009494e GM |
4673 | @kindex q |
4674 | @item q | |
4675 | Exit column view. | |
4676 | @tsubheading{Editing values} | |
4677 | @item @key{left} @key{right} @key{up} @key{down} | |
4678 | Move through the column view from field to field. | |
4679 | @kindex S-@key{left} | |
4680 | @kindex S-@key{right} | |
4681 | @item S-@key{left}/@key{right} | |
4682 | Switch to the next/previous allowed value of the field. For this, you | |
4683 | have to have specified allowed values for a property. | |
b349f79f CD |
4684 | @item 1..9,0 |
4685 | Directly select the nth allowed value, @kbd{0} selects the 10th value. | |
4009494e GM |
4686 | @kindex n |
4687 | @kindex p | |
4688 | @itemx n / p | |
4689 | Same as @kbd{S-@key{left}/@key{right}} | |
4690 | @kindex e | |
4691 | @item e | |
4692 | Edit the property at point. For the special properties, this will | |
4693 | invoke the same interface that you normally use to change that | |
4694 | property. For example, when editing a TAGS property, the tag completion | |
4695 | or fast selection interface will pop up. | |
dbc28aaa CD |
4696 | @kindex C-c C-c |
4697 | @item C-c C-c | |
4698 | When there is a checkbox at point, toggle it. | |
4009494e GM |
4699 | @kindex v |
4700 | @item v | |
4701 | View the full value of this property. This is useful if the width of | |
4702 | the column is smaller than that of the value. | |
4703 | @kindex a | |
4704 | @item a | |
4705 | Edit the list of allowed values for this property. If the list is found | |
4706 | in the hierarchy, the modified values is stored there. If no list is | |
4707 | found, the new value is stored in the first entry that is part of the | |
4708 | current column view. | |
4709 | @tsubheading{Modifying the table structure} | |
4710 | @kindex < | |
4711 | @kindex > | |
4712 | @item < / > | |
4713 | Make the column narrower/wider by one character. | |
4714 | @kindex S-M-@key{right} | |
4715 | @item S-M-@key{right} | |
864c9740 | 4716 | Insert a new column, to the left of the current column. |
4009494e GM |
4717 | @kindex S-M-@key{left} |
4718 | @item S-M-@key{left} | |
4719 | Delete the current column. | |
4720 | @end table | |
4721 | ||
a7808fba CD |
4722 | @node Capturing column view, , Using column view, Column view |
4723 | @subsection Capturing column view | |
dbc28aaa CD |
4724 | |
4725 | Since column view is just an overlay over a buffer, it cannot be | |
4726 | exported or printed directly. If you want to capture a column view, use | |
c8d0cf5c | 4727 | a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame |
28a16a1b | 4728 | of this block looks like this: |
dbc28aaa | 4729 | |
c8d0cf5c | 4730 | @cindex #+BEGIN, columnview |
dbc28aaa CD |
4731 | @example |
4732 | * The column view | |
4733 | #+BEGIN: columnview :hlines 1 :id "label" | |
4734 | ||
4735 | #+END: | |
4736 | @end example | |
4737 | ||
4738 | @noindent This dynamic block has the following parameters: | |
4739 | ||
4740 | @table @code | |
4741 | @item :id | |
c8d0cf5c | 4742 | This is the most important parameter. Column view is a feature that is |
dbc28aaa | 4743 | often localized to a certain (sub)tree, and the capture block might be |
c8d0cf5c CD |
4744 | at a different location in the file. To identify the tree whose view to |
4745 | capture, you can use 4 values: | |
4746 | @cindex property, ID | |
dbc28aaa CD |
4747 | @example |
4748 | local @r{use the tree in which the capture block is located} | |
4749 | global @r{make a global view, including all headings in the file} | |
c8d0cf5c | 4750 | "file:@var{path-to-file}" |
55e0839d | 4751 | @r{run column view at the top of this file} |
c8d0cf5c | 4752 | "@var{ID}" @r{call column view in the tree that has an @code{:ID:}} |
b349f79f CD |
4753 | @r{property with the value @i{label}. You can use} |
4754 | @r{@kbd{M-x org-id-copy} to create a globally unique ID for} | |
4755 | @r{the current entry and copy it to the kill-ring.} | |
dbc28aaa CD |
4756 | @end example |
4757 | @item :hlines | |
c8d0cf5c CD |
4758 | When @code{t}, insert an hline after every line. When a number @var{N}, insert |
4759 | an hline before each headline with level @code{<= @var{N}}. | |
dbc28aaa | 4760 | @item :vlines |
c8d0cf5c | 4761 | When set to @code{t}, force column groups to get vertical lines. |
28a16a1b CD |
4762 | @item :maxlevel |
4763 | When set to a number, don't capture entries below this level. | |
4764 | @item :skip-empty-rows | |
c8d0cf5c | 4765 | When set to @code{t}, skip rows where the only non-empty specifier of the |
28a16a1b CD |
4766 | column view is @code{ITEM}. |
4767 | ||
dbc28aaa CD |
4768 | @end table |
4769 | ||
4770 | @noindent | |
4771 | The following commands insert or update the dynamic block: | |
4772 | ||
4773 | @table @kbd | |
864c9740 CD |
4774 | @kindex C-c C-x i |
4775 | @item C-c C-x i | |
dbc28aaa | 4776 | Insert a dynamic block capturing a column view. You will be prompted |
c8d0cf5c | 4777 | for the scope or ID of the view. |
dbc28aaa CD |
4778 | @kindex C-c C-c |
4779 | @item C-c C-c | |
4780 | @kindex C-c C-x C-u | |
4781 | @itemx C-c C-x C-u | |
c8d0cf5c | 4782 | Update dynamic block at point. The cursor needs to be in the |
dbc28aaa CD |
4783 | @code{#+BEGIN} line of the dynamic block. |
4784 | @kindex C-u C-c C-x C-u | |
4785 | @item C-u C-c C-x C-u | |
4786 | Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if | |
a7808fba | 4787 | you have several clock table blocks in a buffer. |
dbc28aaa CD |
4788 | @end table |
4789 | ||
864c9740 | 4790 | You can add formulas to the column view table and you may add plotting |
c8d0cf5c | 4791 | instructions in front of the table---these will survive an update of the |
864c9740 CD |
4792 | block. If there is a @code{#+TBLFM:} after the table, the table will |
4793 | actually be recalculated automatically after an update. | |
4794 | ||
c8d0cf5c CD |
4795 | An alternative way to capture and process property values into a table is |
4796 | provided by Eric Schulte's @file{org-collector.el} which is a contributed | |
4797 | package@footnote{Contributed packages are not part of Emacs, but are | |
4798 | distributed with the main distribution of Org (visit | |
4799 | @uref{http://orgmode.org}).}. It provides a general API to collect | |
4800 | properties from entries in a certain scope, and arbitrary Lisp expressions to | |
4801 | process these values before inserting them into a table or a dynamic block. | |
4802 | ||
a7808fba | 4803 | @node Property API, , Column view, Properties and Columns |
4009494e GM |
4804 | @section The Property API |
4805 | @cindex properties, API | |
4806 | @cindex API, for properties | |
4807 | ||
4808 | There is a full API for accessing and changing properties. This API can | |
4809 | be used by Emacs Lisp programs to work with properties and to implement | |
4810 | features based on them. For more information see @ref{Using the | |
4811 | property API}. | |
4812 | ||
a351880d | 4813 | @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top |
dbc28aaa CD |
4814 | @chapter Dates and Times |
4815 | @cindex dates | |
4816 | @cindex times | |
c8d0cf5c CD |
4817 | @cindex timestamp |
4818 | @cindex date stamp | |
4009494e | 4819 | |
dbc28aaa CD |
4820 | To assist project planning, TODO items can be labeled with a date and/or |
4821 | a time. The specially formatted string carrying the date and time | |
a7808fba | 4822 | information is called a @emph{timestamp} in Org mode. This may be a |
dbc28aaa | 4823 | little confusing because timestamp is often used as indicating when |
a7808fba | 4824 | something was created or last changed. However, in Org mode this term |
dbc28aaa | 4825 | is used in a much wider sense. |
4009494e GM |
4826 | |
4827 | @menu | |
a7808fba | 4828 | * Timestamps:: Assigning a time to a tree entry |
4009494e GM |
4829 | * Creating timestamps:: Commands which insert timestamps |
4830 | * Deadlines and scheduling:: Planning your work | |
a7808fba | 4831 | * Clocking work time:: Tracking how long you spend on a task |
a351880d | 4832 | * Resolving idle time:: Resolving time if you've been idle |
a7808fba | 4833 | * Effort estimates:: Planning work effort in advance |
96c8522a | 4834 | * Relative timer:: Notes with a running timer |
4009494e GM |
4835 | @end menu |
4836 | ||
4837 | ||
a7808fba | 4838 | @node Timestamps, Creating timestamps, Dates and Times, Dates and Times |
c8d0cf5c CD |
4839 | @section Timestamps, deadlines, and scheduling |
4840 | @cindex timestamps | |
4009494e GM |
4841 | @cindex ranges, time |
4842 | @cindex date stamps | |
4843 | @cindex deadlines | |
4844 | @cindex scheduling | |
4845 | ||
7006d207 CD |
4846 | A timestamp is a specification of a date (possibly with a time or a range of |
4847 | times) in a special format, either @samp{<2003-09-16 Tue>} or | |
4009494e | 4848 | @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue |
7006d207 CD |
4849 | 12:00-12:30>}@footnote{This is inspired by the standard ISO 6801 date/time |
4850 | format. To use an alternative format, see @ref{Custom time format}.}. A | |
4851 | timestamp can appear anywhere in the headline or body of an Org tree entry. | |
4852 | Its presence causes entries to be shown on specific dates in the agenda | |
a7808fba | 4853 | (@pxref{Weekly/daily agenda}). We distinguish: |
4009494e GM |
4854 | |
4855 | @table @var | |
c8d0cf5c | 4856 | @item Plain timestamp; Event; Appointment |
4009494e | 4857 | @cindex timestamp |
c8d0cf5c | 4858 | A simple timestamp just assigns a date/time to an item. This is just |
dbc28aaa CD |
4859 | like writing down an appointment or event in a paper agenda. In the |
4860 | timeline and agenda displays, the headline of an entry associated with a | |
c8d0cf5c | 4861 | plain timestamp will be shown exactly on that date. |
4009494e GM |
4862 | |
4863 | @example | |
4864 | * Meet Peter at the movies <2006-11-01 Wed 19:15> | |
4865 | * Discussion on climate change <2006-11-02 Thu 20:00-22:00> | |
4866 | @end example | |
4867 | ||
c8d0cf5c | 4868 | @item Timestamp with repeater interval |
4009494e | 4869 | @cindex timestamp, with repeater interval |
c8d0cf5c | 4870 | A timestamp may contain a @emph{repeater interval}, indicating that it |
4009494e | 4871 | applies not only on the given date, but again and again after a certain |
c8d0cf5c | 4872 | interval of N days (d), weeks (w), months (m), or years (y). The |
4009494e GM |
4873 | following will show up in the agenda every Wednesday: |
4874 | ||
4875 | @example | |
4876 | * Pick up Sam at school <2007-05-16 Wed 12:30 +1w> | |
4877 | @end example | |
4878 | ||
4879 | @item Diary-style sexp entries | |
a7808fba | 4880 | For more complex date specifications, Org mode supports using the |
4009494e GM |
4881 | special sexp diary entries implemented in the Emacs calendar/diary |
4882 | package. For example | |
4883 | ||
4884 | @example | |
4885 | * The nerd meeting on every 2nd Thursday of the month | |
4886 | <%%(diary-float t 4 2)> | |
4887 | @end example | |
4888 | ||
4889 | @item Time/Date range | |
4890 | @cindex timerange | |
4891 | @cindex date range | |
c8d0cf5c | 4892 | Two timestamps connected by @samp{--} denote a range. The headline |
4009494e GM |
4893 | will be shown on the first and last day of the range, and on any dates |
4894 | that are displayed and fall in the range. Here is an example: | |
4895 | ||
4896 | @example | |
4897 | ** Meeting in Amsterdam | |
4898 | <2004-08-23 Mon>--<2004-08-26 Thu> | |
4899 | @end example | |
4900 | ||
c8d0cf5c | 4901 | @item Inactive timestamp |
4009494e GM |
4902 | @cindex timestamp, inactive |
4903 | @cindex inactive timestamp | |
c8d0cf5c CD |
4904 | Just like a plain timestamp, but with square brackets instead of |
4905 | angular ones. These timestamps are inactive in the sense that they do | |
4009494e GM |
4906 | @emph{not} trigger an entry to show up in the agenda. |
4907 | ||
4908 | @example | |
4909 | * Gillian comes late for the fifth time [2006-11-01 Wed] | |
4910 | @end example | |
4911 | ||
4912 | @end table | |
4913 | ||
a7808fba | 4914 | @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times |
4009494e GM |
4915 | @section Creating timestamps |
4916 | @cindex creating timestamps | |
4917 | @cindex timestamps, creating | |
4918 | ||
c8d0cf5c CD |
4919 | For Org mode to recognize timestamps, they need to be in the specific |
4920 | format. All commands listed below produce timestamps in the correct | |
4009494e GM |
4921 | format. |
4922 | ||
4923 | @table @kbd | |
4924 | @kindex C-c . | |
4925 | @item C-c . | |
c8d0cf5c CD |
4926 | Prompt for a date and insert a corresponding timestamp. When the cursor is |
4927 | at an existing timestamp in the buffer, the command is used to modify this | |
864c9740 CD |
4928 | timestamp instead of inserting a new one. When this command is used twice in |
4929 | succession, a time range is inserted. | |
4009494e | 4930 | @c |
4009494e GM |
4931 | @kindex C-c ! |
4932 | @item C-c ! | |
c8d0cf5c | 4933 | Like @kbd{C-c .}, but insert an inactive timestamp that will not cause |
4009494e GM |
4934 | an agenda entry. |
4935 | @c | |
c8d0cf5c CD |
4936 | @kindex C-u C-c . |
4937 | @kindex C-u C-c ! | |
4938 | @item C-u C-c . | |
4939 | @itemx C-u C-c ! | |
4940 | @vindex org-time-stamp-rounding-minutes | |
4941 | Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which | |
4942 | contains date and time. The default time can be rounded to multiples of 5 | |
4943 | minutes, see the option @code{org-time-stamp-rounding-minutes}. | |
4944 | @c | |
4009494e GM |
4945 | @kindex C-c < |
4946 | @item C-c < | |
c8d0cf5c | 4947 | Insert a timestamp corresponding to the cursor date in the Calendar. |
4009494e GM |
4948 | @c |
4949 | @kindex C-c > | |
4950 | @item C-c > | |
4951 | Access the Emacs calendar for the current date. If there is a | |
a7808fba | 4952 | timestamp in the current line, go to the corresponding date |
4009494e GM |
4953 | instead. |
4954 | @c | |
4955 | @kindex C-c C-o | |
4956 | @item C-c C-o | |
c8d0cf5c | 4957 | Access the agenda for the date given by the timestamp or -range at |
a7808fba | 4958 | point (@pxref{Weekly/daily agenda}). |
4009494e GM |
4959 | @c |
4960 | @kindex S-@key{left} | |
4961 | @kindex S-@key{right} | |
4962 | @item S-@key{left} | |
4963 | @itemx S-@key{right} | |
4964 | Change date at cursor by one day. These key bindings conflict with | |
c8d0cf5c | 4965 | shift-selection and related modes (@pxref{Conflicts}). |
4009494e GM |
4966 | @c |
4967 | @kindex S-@key{up} | |
4968 | @kindex S-@key{down} | |
4969 | @item S-@key{up} | |
4970 | @itemx S-@key{down} | |
4971 | Change the item under the cursor in a timestamp. The cursor can be on a | |
c8d0cf5c CD |
4972 | year, month, day, hour or minute. When the timestamp contains a time range |
4973 | like @samp{15:30-16:30}, modifying the first time will also shift the second, | |
4974 | shifting the time block with constant length. To change the length, modify | |
4975 | the second time. Note that if the cursor is in a headline and not at a | |
4976 | timestamp, these same keys modify the priority of an item. | |
4977 | (@pxref{Priorities}). The key bindings also conflict with shift-selection and | |
4978 | related modes (@pxref{Conflicts}). | |
4009494e GM |
4979 | @c |
4980 | @kindex C-c C-y | |
4981 | @cindex evaluate time range | |
4982 | @item C-c C-y | |
a7808fba CD |
4983 | Evaluate a time range by computing the difference between start and end. |
4984 | With a prefix argument, insert result after the time range (in a table: into | |
4985 | the following column). | |
4009494e GM |
4986 | @end table |
4987 | ||
4988 | ||
4989 | @menu | |
a7808fba CD |
4990 | * The date/time prompt:: How Org mode helps you entering date and time |
4991 | * Custom time format:: Making dates look different | |
4009494e GM |
4992 | @end menu |
4993 | ||
4994 | @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps | |
4995 | @subsection The date/time prompt | |
4996 | @cindex date, reading in minibuffer | |
4997 | @cindex time, reading in minibuffer | |
4998 | ||
c8d0cf5c | 4999 | @vindex org-read-date-prefer-future |
7006d207 CD |
5000 | When Org mode prompts for a date/time, the default is shown in default |
5001 | date/time format, and the prompt therefore seems to ask for a specific | |
5002 | format. But it will in fact accept any string containing some date and/or | |
5003 | time information, and it is really smart about interpreting your input. You | |
dbc28aaa | 5004 | can, for example, use @kbd{C-y} to paste a (possibly multi-line) string |
7006d207 CD |
5005 | copied from an email message. Org mode will find whatever information is in |
5006 | there and derive anything you have not specified from the @emph{default date | |
5007 | and time}. The default is usually the current date and time, but when | |
5008 | modifying an existing timestamp, or when entering the second stamp of a | |
5009 | range, it is taken from the stamp in the buffer. When filling in | |
5010 | information, Org mode assumes that most of the time you will want to enter a | |
5011 | date in the future: if you omit the month/year and the given day/month is | |
5012 | @i{before} today, it will assume that you mean a future date@footnote{See the | |
a351880d CD |
5013 | variable @code{org-read-date-prefer-future}. You may set that variable to |
5014 | the symbol @code{time} to even make a time before now shift the date to | |
5015 | tomorrow.}. If the date has been automatically shifted into the future, the | |
5016 | time prompt will show this with @samp{(=>F).} | |
dbc28aaa | 5017 | |
07450bee | 5018 | For example, let's assume that today is @b{June 13, 2006}. Here is how |
a7808fba | 5019 | various inputs will be interpreted, the items filled in by Org mode are |
dbc28aaa CD |
5020 | in @b{bold}. |
5021 | ||
5022 | @example | |
5023 | 3-2-5 --> 2003-02-05 | |
5024 | 14 --> @b{2006}-@b{06}-14 | |
5025 | 12 --> @b{2006}-@b{07}-12 | |
5026 | Fri --> nearest Friday (defaultdate or later) | |
07450bee | 5027 | sep 15 --> @b{2006}-09-15 |
dbc28aaa CD |
5028 | feb 15 --> @b{2007}-02-15 |
5029 | sep 12 9 --> 2009-09-12 | |
5030 | 12:45 --> @b{2006}-@b{06}-@b{13} 12:45 | |
5031 | 22 sept 0:34 --> @b{2006}-09-22 0:34 | |
a7808fba CD |
5032 | w4 --> ISO week for of the current year @b{2006} |
5033 | 2012 w4 fri --> Friday of ISO week 4 in 2012 | |
5034 | 2012-w04-5 --> Same as above | |
dbc28aaa CD |
5035 | @end example |
5036 | ||
5037 | Furthermore you can specify a relative date by giving, as the | |
5038 | @emph{first} thing in the input: a plus/minus sign, a number and a | |
c8d0cf5c | 5039 | letter ([dwmy]) to indicate change in days, weeks, months, or years. With a |
dbc28aaa CD |
5040 | single plus or minus, the date is always relative to today. With a |
5041 | double plus or minus, it is relative to the default date. If instead of | |
5042 | a single letter, you use the abbreviation of day name, the date will be | |
a351880d | 5043 | the nth such day. E.g. |
dbc28aaa CD |
5044 | |
5045 | @example | |
b349f79f CD |
5046 | +0 --> today |
5047 | . --> today | |
dbc28aaa CD |
5048 | +4d --> four days from today |
5049 | +4 --> same as above | |
5050 | +2w --> two weeks from today | |
5051 | ++5 --> five days from default date | |
c8d0cf5c | 5052 | +2tue --> second Tuesday from now. |
4009494e GM |
5053 | @end example |
5054 | ||
c8d0cf5c CD |
5055 | @vindex parse-time-months |
5056 | @vindex parse-time-weekdays | |
4009494e GM |
5057 | The function understands English month and weekday abbreviations. If |
5058 | you want to use unabbreviated names and/or other languages, configure | |
5059 | the variables @code{parse-time-months} and @code{parse-time-weekdays}. | |
5060 | ||
5061 | @cindex calendar, for selecting date | |
c8d0cf5c | 5062 | @vindex org-popup-calendar-for-date-prompt |
4009494e GM |
5063 | Parallel to the minibuffer prompt, a calendar is popped up@footnote{If |
5064 | you don't need/want the calendar, configure the variable | |
5065 | @code{org-popup-calendar-for-date-prompt}.}. When you exit the date | |
5066 | prompt, either by clicking on a date in the calendar, or by pressing | |
5067 | @key{RET}, the date selected in the calendar will be combined with the | |
5068 | information entered at the prompt. You can control the calendar fully | |
5069 | from the minibuffer: | |
5070 | ||
4009494e | 5071 | @kindex < |
4009494e | 5072 | @kindex > |
4009494e | 5073 | @kindex mouse-1 |
4009494e | 5074 | @kindex S-@key{right} |
4009494e | 5075 | @kindex S-@key{left} |
4009494e | 5076 | @kindex S-@key{down} |
4009494e | 5077 | @kindex S-@key{up} |
4009494e | 5078 | @kindex M-S-@key{right} |
4009494e | 5079 | @kindex M-S-@key{left} |
4009494e | 5080 | @kindex @key{RET} |
dbc28aaa CD |
5081 | @example |
5082 | > / < @r{Scroll calendar forward/backward by one month.} | |
5083 | mouse-1 @r{Select date by clicking on it.} | |
5084 | S-@key{right}/@key{left} @r{One day forward/backward.} | |
5085 | S-@key{down}/@key{up} @r{One week forward/backward.} | |
5086 | M-S-@key{right}/@key{left} @r{One month forward/backward.} | |
5087 | @key{RET} @r{Choose date in calendar.} | |
5088 | @end example | |
5089 | ||
c8d0cf5c | 5090 | @vindex org-read-date-display-live |
a7808fba CD |
5091 | The actions of the date/time prompt may seem complex, but I assure you they |
5092 | will grow on you, and you will start getting annoyed by pretty much any other | |
5093 | way of entering a date/time out there. To help you understand what is going | |
5094 | on, the current interpretation of your input will be displayed live in the | |
5095 | minibuffer@footnote{If you find this distracting, turn the display of with | |
5096 | @code{org-read-date-display-live}.}. | |
4009494e GM |
5097 | |
5098 | @node Custom time format, , The date/time prompt, Creating timestamps | |
5099 | @subsection Custom time format | |
5100 | @cindex custom date/time format | |
5101 | @cindex time format, custom | |
5102 | @cindex date format, custom | |
5103 | ||
c8d0cf5c CD |
5104 | @vindex org-display-custom-times |
5105 | @vindex org-time-stamp-custom-formats | |
a7808fba | 5106 | Org mode uses the standard ISO notation for dates and times as it is |
4009494e GM |
5107 | defined in ISO 8601. If you cannot get used to this and require another |
5108 | representation of date and time to keep you happy, you can get it by | |
5109 | customizing the variables @code{org-display-custom-times} and | |
5110 | @code{org-time-stamp-custom-formats}. | |
5111 | ||
5112 | @table @kbd | |
5113 | @kindex C-c C-x C-t | |
5114 | @item C-c C-x C-t | |
5115 | Toggle the display of custom formats for dates and times. | |
5116 | @end table | |
5117 | ||
5118 | @noindent | |
a7808fba | 5119 | Org mode needs the default format for scanning, so the custom date/time |
c8d0cf5c | 5120 | format does not @emph{replace} the default format---instead it is put |
4009494e GM |
5121 | @emph{over} the default format using text properties. This has the |
5122 | following consequences: | |
5123 | @itemize @bullet | |
28a16a1b | 5124 | @item |
c8d0cf5c | 5125 | You cannot place the cursor onto a timestamp anymore, only before or |
4009494e GM |
5126 | after. |
5127 | @item | |
5128 | The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust | |
c8d0cf5c | 5129 | each component of a timestamp. If the cursor is at the beginning of |
4009494e GM |
5130 | the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day, |
5131 | just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the | |
5132 | time will be changed by one minute. | |
5133 | @item | |
c8d0cf5c | 5134 | If the timestamp contains a range of clock times or a repeater, these |
4009494e GM |
5135 | will not be overlayed, but remain in the buffer as they were. |
5136 | @item | |
c8d0cf5c | 5137 | When you delete a timestamp character-by-character, it will only |
4009494e GM |
5138 | disappear from the buffer after @emph{all} (invisible) characters |
5139 | belonging to the ISO timestamp have been removed. | |
5140 | @item | |
c8d0cf5c | 5141 | If the custom timestamp format is longer than the default and you are |
4009494e GM |
5142 | using dates in tables, table alignment will be messed up. If the custom |
5143 | format is shorter, things do work as expected. | |
5144 | @end itemize | |
5145 | ||
5146 | ||
a7808fba CD |
5147 | @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times |
5148 | @section Deadlines and scheduling | |
4009494e | 5149 | |
c8d0cf5c | 5150 | A timestamp may be preceded by special keywords to facilitate planning: |
4009494e GM |
5151 | |
5152 | @table @var | |
5153 | @item DEADLINE | |
5154 | @cindex DEADLINE keyword | |
dbc28aaa CD |
5155 | |
5156 | Meaning: the task (most likely a TODO item, though not necessarily) is supposed | |
5157 | to be finished on that date. | |
5158 | ||
c8d0cf5c | 5159 | @vindex org-deadline-warning-days |
dbc28aaa CD |
5160 | On the deadline date, the task will be listed in the agenda. In |
5161 | addition, the agenda for @emph{today} will carry a warning about the | |
5162 | approaching or missed deadline, starting | |
5163 | @code{org-deadline-warning-days} before the due date, and continuing | |
5164 | until the entry is marked DONE. An example: | |
4009494e GM |
5165 | |
5166 | @example | |
5167 | *** TODO write article about the Earth for the Guide | |
5168 | The editor in charge is [[bbdb:Ford Prefect]] | |
5169 | DEADLINE: <2004-02-29 Sun> | |
5170 | @end example | |
5171 | ||
5172 | You can specify a different lead time for warnings for a specific | |
5173 | deadlines using the following syntax. Here is an example with a warning | |
5174 | period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}. | |
5175 | ||
5176 | @item SCHEDULED | |
5177 | @cindex SCHEDULED keyword | |
dbc28aaa CD |
5178 | |
5179 | Meaning: you are planning to start working on that task on the given | |
5180 | date. | |
5181 | ||
c8d0cf5c | 5182 | @vindex org-agenda-skip-scheduled-if-done |
dbc28aaa CD |
5183 | The headline will be listed under the given date@footnote{It will still |
5184 | be listed on that date after it has been marked DONE. If you don't like | |
4009494e GM |
5185 | this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In |
5186 | addition, a reminder that the scheduled date has passed will be present | |
5187 | in the compilation for @emph{today}, until the entry is marked DONE. | |
a351880d | 5188 | I.e. the task will automatically be forwarded until completed. |
4009494e GM |
5189 | |
5190 | @example | |
5191 | *** TODO Call Trillian for a date on New Years Eve. | |
5192 | SCHEDULED: <2004-12-25 Sat> | |
5193 | @end example | |
dbc28aaa CD |
5194 | |
5195 | @noindent | |
a7808fba | 5196 | @b{Important:} Scheduling an item in Org mode should @i{not} be |
dbc28aaa CD |
5197 | understood in the same way that we understand @i{scheduling a meeting}. |
5198 | Setting a date for a meeting is just a simple appointment, you should | |
c8d0cf5c CD |
5199 | mark this entry with a simple plain timestamp, to get this item shown |
5200 | on the date where it applies. This is a frequent misunderstanding by | |
5201 | Org users. In Org mode, @i{scheduling} means setting a date when you | |
dbc28aaa | 5202 | want to start working on an action item. |
4009494e GM |
5203 | @end table |
5204 | ||
c8d0cf5c | 5205 | You may use timestamps with repeaters in scheduling and deadline |
a7808fba | 5206 | entries. Org mode will issue early and late warnings based on the |
c8d0cf5c | 5207 | assumption that the timestamp represents the @i{nearest instance} of |
dbc28aaa CD |
5208 | the repeater. However, the use of diary sexp entries like |
5209 | @c | |
5210 | @code{<%%(diary-float t 42)>} | |
5211 | @c | |
a7808fba | 5212 | in scheduling and deadline timestamps is limited. Org mode does not |
dbc28aaa CD |
5213 | know enough about the internals of each sexp function to issue early and |
5214 | late warnings. However, it will show the item on each day where the | |
5215 | sexp entry matches. | |
5216 | ||
4009494e GM |
5217 | @menu |
5218 | * Inserting deadline/schedule:: Planning items | |
5219 | * Repeated tasks:: Items that show up again and again | |
5220 | @end menu | |
5221 | ||
5222 | @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling | |
a7808fba | 5223 | @subsection Inserting deadlines or schedules |
4009494e | 5224 | |
c8d0cf5c | 5225 | The following commands allow you to quickly insert a deadline or to schedule |
4009494e GM |
5226 | an item: |
5227 | ||
5228 | @table @kbd | |
5229 | @c | |
5230 | @kindex C-c C-d | |
5231 | @item C-c C-d | |
a351880d CD |
5232 | Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen |
5233 | in the line directly following the headline. When called with a prefix arg, | |
5234 | an existing deadline will be removed from the entry. Depending on the | |
5235 | variable @code{org-log-redeadline}@footnote{with corresponding | |
5236 | @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline}, | |
5237 | and @code{nologredeadline}}, a note will be taken when changing an existing | |
5238 | deadline. | |
4009494e GM |
5239 | @c FIXME Any CLOSED timestamp will be removed.???????? |
5240 | @c | |
4009494e GM |
5241 | @kindex C-c C-s |
5242 | @item C-c C-s | |
5243 | Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will | |
a351880d CD |
5244 | happen in the line directly following the headline. Any CLOSED timestamp |
5245 | will be removed. When called with a prefix argument, remove the scheduling | |
5246 | date from the entry. Depending on the variable | |
5247 | @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP} | |
5248 | keywords @code{logredeadline}, @code{lognoteredeadline}, and | |
5249 | @code{nologredeadline}}, a note will be taken when changing an existing | |
5250 | scheduling time. | |
b349f79f CD |
5251 | @c |
5252 | @kindex C-c C-x C-k | |
5253 | @kindex k a | |
5254 | @kindex k s | |
5255 | @item C-c C-x C-k | |
5256 | Mark the current entry for agenda action. After you have marked the entry | |
5257 | like this, you can open the agenda or the calendar to find an appropriate | |
5258 | date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to | |
5259 | schedule the marked item. | |
c8d0cf5c CD |
5260 | @c |
5261 | @kindex C-c / d | |
5262 | @cindex sparse tree, for deadlines | |
5263 | @item C-c / d | |
5264 | @vindex org-deadline-warning-days | |
5265 | Create a sparse tree with all deadlines that are either past-due, or | |
5266 | which will become due within @code{org-deadline-warning-days}. | |
5267 | With @kbd{C-u} prefix, show all deadlines in the file. With a numeric | |
5268 | prefix, check that many days. For example, @kbd{C-1 C-c / d} shows | |
5269 | all deadlines due tomorrow. | |
5270 | @c | |
5271 | @kindex C-c / b | |
5272 | @item C-c / b | |
5273 | Sparse tree for deadlines and scheduled items before a given date. | |
5274 | @c | |
5275 | @kindex C-c / a | |
5276 | @item C-c / a | |
5277 | Sparse tree for deadlines and scheduled items after a given date. | |
4009494e GM |
5278 | @end table |
5279 | ||
5280 | @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling | |
a7808fba | 5281 | @subsection Repeated tasks |
c8d0cf5c CD |
5282 | @cindex tasks, repeated |
5283 | @cindex repeated tasks | |
4009494e | 5284 | |
a7808fba | 5285 | Some tasks need to be repeated again and again. Org mode helps to |
28a16a1b | 5286 | organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED, |
c8d0cf5c | 5287 | or plain timestamp. In the following example |
4009494e GM |
5288 | @example |
5289 | ** TODO Pay the rent | |
5290 | DEADLINE: <2005-10-01 Sat +1m> | |
5291 | @end example | |
c8d0cf5c CD |
5292 | @noindent |
5293 | the @code{+1m} is a repeater; the intended interpretation is that the task | |
5294 | has a deadline on <2005-10-01> and repeats itself every (one) month starting | |
5295 | from that time. If you need both a repeater and a special warning period in | |
5296 | a deadline entry, the repeater should come first and the warning period last: | |
5297 | @code{DEADLINE: <2005-10-01 Sat +1m -3d>}. | |
4009494e GM |
5298 | |
5299 | Deadlines and scheduled items produce entries in the agenda when they | |
5300 | are over-due, so it is important to be able to mark such an entry as | |
5301 | completed once you have done so. When you mark a DEADLINE or a SCHEDULE | |
a7808fba | 5302 | with the TODO keyword DONE, it will no longer produce entries in the |
28a16a1b | 5303 | agenda. The problem with this is, however, that then also the |
a7808fba | 5304 | @emph{next} instance of the repeated entry will not be active. Org mode |
4009494e GM |
5305 | deals with this in the following way: When you try to mark such an entry |
5306 | DONE (using @kbd{C-c C-t}), it will shift the base date of the repeating | |
c8d0cf5c | 5307 | timestamp by the repeater interval, and immediately set the entry state |
4009494e GM |
5308 | back to TODO. In the example above, setting the state to DONE would |
5309 | actually switch the date like this: | |
5310 | ||
5311 | @example | |
5312 | ** TODO Pay the rent | |
5313 | DEADLINE: <2005-11-01 Tue +1m> | |
5314 | @end example | |
5315 | ||
c8d0cf5c | 5316 | @vindex org-log-repeat |
a7808fba CD |
5317 | A timestamp@footnote{You can change this using the option |
5318 | @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat}, | |
5319 | @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you | |
a50253cc | 5320 | will also be prompted for a note.} will be added under the deadline, to keep |
a7808fba | 5321 | a record that you actually acted on the previous instance of this deadline. |
4009494e GM |
5322 | |
5323 | As a consequence of shifting the base date, this entry will no longer be | |
5324 | visible in the agenda when checking past dates, but all future instances | |
5325 | will be visible. | |
5326 | ||
28a16a1b | 5327 | With the @samp{+1m} cookie, the date shift will always be exactly one |
c8d0cf5c | 5328 | month. So if you have not paid the rent for three months, marking this |
28a16a1b CD |
5329 | entry DONE will still keep it as an overdue deadline. Depending on the |
5330 | task, this may not be the best way to handle it. For example, if you | |
5331 | forgot to call you father for 3 weeks, it does not make sense to call | |
a7808fba | 5332 | him 3 times in a single day to make up for it. Finally, there are tasks |
28a16a1b | 5333 | like changing batteries which should always repeat a certain time |
a7808fba CD |
5334 | @i{after} the last time you did it. For these tasks, Org mode has |
5335 | special repeaters markers with @samp{++} and @samp{.+}. For example: | |
28a16a1b CD |
5336 | |
5337 | @example | |
5338 | ** TODO Call Father | |
5339 | DEADLINE: <2008-02-10 Sun ++1w> | |
5340 | Marking this DONE will shift the date by at least one week, | |
5341 | but also by as many weeks as it takes to get this date into | |
5342 | the future. However, it stays on a Sunday, even if you called | |
5343 | and marked it done on Saturday. | |
5344 | ** TODO Check the batteries in the smoke detectors | |
5345 | DEADLINE: <2005-11-01 Tue .+1m> | |
5346 | Marking this DONE will shift the date to one month after | |
5347 | today. | |
5348 | @end example | |
5349 | ||
4009494e | 5350 | You may have both scheduling and deadline information for a specific |
c8d0cf5c CD |
5351 | task---just make sure that the repeater intervals on both are the same. |
5352 | ||
5353 | An alternative to using a repeater is to create a number of copies of a task | |
5354 | subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was | |
5355 | created for this purpose, it is described in @ref{Structure editing}. | |
5356 | ||
4009494e | 5357 | |
a351880d | 5358 | @node Clocking work time, Resolving idle time, Deadlines and scheduling, Dates and Times |
dbc28aaa | 5359 | @section Clocking work time |
4009494e | 5360 | |
c8d0cf5c | 5361 | Org mode allows you to clock the time you spend on specific tasks in a |
4009494e GM |
5362 | project. When you start working on an item, you can start the clock. |
5363 | When you stop working on that task, or when you mark the task done, the | |
5364 | clock is stopped and the corresponding time interval is recorded. It | |
a351880d CD |
5365 | also computes the total time spent on each subtree of a project. And it |
5366 | remembers a history or tasks recently clocked, to that you can jump quickly | |
5367 | between a number of tasks absorbing your time. | |
c8d0cf5c | 5368 | |
a351880d | 5369 | To save the clock history across Emacs sessions, use |
c8d0cf5c | 5370 | @lisp |
a351880d | 5371 | (setq org-clock-persist 'history) |
c8d0cf5c CD |
5372 | (org-clock-persistence-insinuate) |
5373 | @end lisp | |
a351880d CD |
5374 | When you clock into a new task after resuming Emacs, the incomplete |
5375 | clock@footnote{To resume the clock under the assumption that you have worked | |
5376 | on this task while outside Emacs, use @code{(setq org-clock-persist t)}.} | |
5377 | will be found (@pxref{Resolving idle time}) and you will be prompted about | |
5378 | what to do with it. | |
c8d0cf5c | 5379 | |
4009494e GM |
5380 | @table @kbd |
5381 | @kindex C-c C-x C-i | |
5382 | @item C-c C-x C-i | |
c8d0cf5c | 5383 | @vindex org-clock-into-drawer |
4009494e | 5384 | Start the clock on the current item (clock-in). This inserts the CLOCK |
dbc28aaa CD |
5385 | keyword together with a timestamp. If this is not the first clocking of |
5386 | this item, the multiple CLOCK lines will be wrapped into a | |
c8d0cf5c | 5387 | @code{:LOGBOOK:} drawer (see also the variable |
a7808fba CD |
5388 | @code{org-clock-into-drawer}). When called with a @kbd{C-u} prefix argument, |
5389 | select the task from a list of recently clocked tasks. With two @kbd{C-u | |
5390 | C-u} prefixes, clock into the task at point and mark it as the default task. | |
5391 | The default task will always be available when selecting a clocking task, | |
c8d0cf5c CD |
5392 | with letter @kbd{d}.@* |
5393 | @cindex property: CLOCK_MODELINE_TOTAL | |
5394 | @cindex property: LAST_REPEAT | |
5395 | @vindex org-clock-modeline-total | |
5396 | While the clock is running, the current clocking time is shown in the mode | |
5397 | line, along with the title of the task. The clock time shown will be all | |
5398 | time ever clocked for this task and its children. If the task has an effort | |
5399 | estimate (@pxref{Effort estimates}), the mode line displays the current | |
5400 | clocking time against it@footnote{To add an effort estimate ``on the fly'', | |
5401 | hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task | |
5402 | is a repeating one (@pxref{Repeated tasks}), only the time since the last | |
5403 | reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property} | |
5404 | will be shown. More control over what time is shown can be exercised with | |
5405 | the @code{CLOCK_MODELINE_TOTAL} property. It may have the values | |
5406 | @code{current} to show only the current clocking instance, @code{today} to | |
5407 | show all time clocked on this tasks today (see also the variable | |
5408 | @code{org-extend-today-until}), @code{all} to include all time, or | |
5409 | @code{auto} which is the default@footnote{See also the variable | |
5410 | @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the | |
5411 | mode line entry will pop up a menu with clocking options. | |
4009494e GM |
5412 | @kindex C-c C-x C-o |
5413 | @item C-c C-x C-o | |
c8d0cf5c | 5414 | @vindex org-log-note-clock-out |
a20d3598 | 5415 | Stop the clock (clock-out). This inserts another timestamp at the same |
4009494e GM |
5416 | location where the clock was last started. It also directly computes |
5417 | the resulting time in inserts it after the time range as @samp{=> | |
28a16a1b CD |
5418 | HH:MM}. See the variable @code{org-log-note-clock-out} for the |
5419 | possibility to record an additional note together with the clock-out | |
c8d0cf5c | 5420 | timestamp@footnote{The corresponding in-buffer setting is: |
28a16a1b | 5421 | @code{#+STARTUP: lognoteclock-out}}. |
c8d0cf5c CD |
5422 | @kindex C-c C-x C-e |
5423 | @item C-c C-x C-e | |
5424 | Update the effort estimate for the current clock task. | |
4009494e | 5425 | @kindex C-c C-y |
c8d0cf5c CD |
5426 | @kindex C-c C-c |
5427 | @item C-c C-y @ @ @r{or}@ @ C-c C-c | |
5428 | Recompute the time interval after changing one of the timestamps. This | |
5429 | is only necessary if you edit the timestamps directly. If you change | |
4009494e GM |
5430 | them with @kbd{S-@key{cursor}} keys, the update is automatic. |
5431 | @kindex C-c C-t | |
5432 | @item C-c C-t | |
5433 | Changing the TODO state of an item to DONE automatically stops the clock | |
5434 | if it is running in this same item. | |
5435 | @kindex C-c C-x C-x | |
5436 | @item C-c C-x C-x | |
5437 | Cancel the current clock. This is useful if a clock was started by | |
5438 | mistake, or if you ended up working on something else. | |
dbc28aaa CD |
5439 | @kindex C-c C-x C-j |
5440 | @item C-c C-x C-j | |
a7808fba CD |
5441 | Jump to the entry that contains the currently running clock. With a |
5442 | @kbd{C-u} prefix arg, select the target task from a list of recently clocked | |
5443 | tasks. | |
4009494e GM |
5444 | @kindex C-c C-x C-d |
5445 | @item C-c C-x C-d | |
c8d0cf5c | 5446 | @vindex org-remove-highlights-with-change |
4009494e GM |
5447 | Display time summaries for each subtree in the current buffer. This |
5448 | puts overlays at the end of each headline, showing the total time | |
5449 | recorded under that heading, including the time of any subheadings. You | |
5450 | can use visibility cycling to study the tree, but the overlays disappear | |
5451 | when you change the buffer (see variable | |
5452 | @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}. | |
5453 | @kindex C-c C-x C-r | |
5454 | @item C-c C-x C-r | |
5455 | Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock | |
c8d0cf5c | 5456 | report as an Org-mode table into the current file. When the cursor is |
dbc28aaa CD |
5457 | at an existing clock table, just update it. When called with a prefix |
5458 | argument, jump to the first clock report in the current document and | |
5459 | update it. | |
c8d0cf5c | 5460 | @cindex #+BEGIN, clocktable |
4009494e | 5461 | @example |
dbc28aaa | 5462 | #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file |
4009494e GM |
5463 | #+END: clocktable |
5464 | @end example | |
5465 | @noindent | |
dbc28aaa CD |
5466 | If such a block already exists at point, its content is replaced by the |
5467 | new table. The @samp{BEGIN} line can specify options: | |
4009494e | 5468 | @example |
dbc28aaa | 5469 | :maxlevel @r{Maximum level depth to which times are listed in the table.} |
c8d0cf5c | 5470 | :emphasize @r{When @code{t}, emphasize level one and level two items.} |
dbc28aaa CD |
5471 | :scope @r{The scope to consider. This can be any of the following:} |
5472 | nil @r{the current buffer or narrowed region} | |
5473 | file @r{the full current buffer} | |
5474 | subtree @r{the subtree where the clocktable is located} | |
c8d0cf5c | 5475 | tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}} |
dbc28aaa CD |
5476 | tree @r{the surrounding level 1 tree} |
5477 | agenda @r{all agenda files} | |
5478 | ("file"..) @r{scan these files} | |
a7808fba CD |
5479 | file-with-archives @r{current file and its archives} |
5480 | agenda-with-archives @r{all agenda files, including archives} | |
5481 | :block @r{The time block to consider. This block is specified either} | |
5482 | @r{absolute, or relative to the current time and may be any of} | |
5483 | @r{these formats:} | |
5484 | 2007-12-31 @r{New year eve 2007} | |
5485 | 2007-12 @r{December 2007} | |
5486 | 2007-W50 @r{ISO-week 50 in 2007} | |
5487 | 2007 @r{the year 2007} | |
c8d0cf5c CD |
5488 | today, yesterday, today-@var{N} @r{a relative day} |
5489 | thisweek, lastweek, thisweek-@var{N} @r{a relative week} | |
5490 | thismonth, lastmonth, thismonth-@var{N} @r{a relative month} | |
5491 | thisyear, lastyear, thisyear-@var{N} @r{a relative year} | |
a7808fba | 5492 | @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.} |
c8d0cf5c CD |
5493 | :tstart @r{A time string specifying when to start considering times.} |
5494 | :tend @r{A time string specifying when to stop considering times.} | |
a7808fba CD |
5495 | :step @r{@code{week} or @code{day}, to split the table into chunks.} |
5496 | @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.} | |
c8d0cf5c | 5497 | :link @r{Link the item headlines in the table to their origins.} |
e45e3595 | 5498 | :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.} |
c8d0cf5c CD |
5499 | @r{As a special case, @samp{:formula %} adds a column with % time.} |
5500 | @r{If you do not specify a formula here, any existing formula.} | |
e45e3595 | 5501 | @r{below the clock table will survive updates and be evaluated.} |
c8d0cf5c CD |
5502 | :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,} |
5503 | @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.} | |
4009494e | 5504 | @end example |
c8d0cf5c | 5505 | To get a clock summary of the current level 1 tree, for the current |
dbc28aaa | 5506 | day, you could write |
4009494e | 5507 | @example |
a7808fba | 5508 | #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t |
4009494e GM |
5509 | #+END: clocktable |
5510 | @end example | |
c8d0cf5c | 5511 | @noindent |
4009494e | 5512 | and to use a specific time range you could write@footnote{Note that all |
c8d0cf5c CD |
5513 | parameters must be specified in a single line---the line is broken here |
5514 | only to fit it into the manual.} | |
4009494e | 5515 | @example |
28a16a1b | 5516 | #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>" |
4009494e | 5517 | :tend "<2006-08-10 Thu 12:00>" |
4009494e GM |
5518 | #+END: clocktable |
5519 | @end example | |
e45e3595 CD |
5520 | A summary of the current subtree with % times would be |
5521 | @example | |
5522 | #+BEGIN: clocktable :scope subtree :link t :formula % | |
5523 | #+END: clocktable | |
5524 | @end example | |
dbc28aaa CD |
5525 | @kindex C-c C-c |
5526 | @item C-c C-c | |
5527 | @kindex C-c C-x C-u | |
5528 | @itemx C-c C-x C-u | |
c8d0cf5c | 5529 | Update dynamic block at point. The cursor needs to be in the |
dbc28aaa | 5530 | @code{#+BEGIN} line of the dynamic block. |
4009494e GM |
5531 | @kindex C-u C-c C-x C-u |
5532 | @item C-u C-c C-x C-u | |
5533 | Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if | |
a7808fba CD |
5534 | you have several clock table blocks in a buffer. |
5535 | @kindex S-@key{left} | |
5536 | @kindex S-@key{right} | |
5537 | @item S-@key{left} | |
5538 | @itemx S-@key{right} | |
5539 | Shift the current @code{:block} interval and update the table. The cursor | |
5540 | needs to be in the @code{#+BEGIN: clocktable} line for this command. If | |
5541 | @code{:block} is @code{today}, it will be shifted to @code{today-1} etc. | |
4009494e GM |
5542 | @end table |
5543 | ||
5544 | The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in | |
a7808fba | 5545 | the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been |
4009494e GM |
5546 | worked on or closed during a day. |
5547 | ||
a351880d CD |
5548 | @node Resolving idle time, Effort estimates, Clocking work time, Dates and Times |
5549 | @section Resolving idle time | |
5550 | @cindex resolve idle time | |
5551 | ||
5552 | @cindex idle, resolve, dangling | |
5553 | If you clock in on a work item, and then walk away from your | |
5554 | computer---perhaps to take a phone call---you often need to ``resolve'' the | |
5555 | time you were away by either subtracting it from the current clock, or | |
5556 | applying it to another one. | |
5557 | ||
5558 | @vindex org-clock-idle-time | |
5559 | By customizing the variable @code{org-clock-idle-time} to some integer, such | |
5560 | as 10 or 15, Emacs can alert you when you get back to your computer after | |
5561 | being idle for that many minutes@footnote{On computers using Mac OS X, | |
5562 | idleness is based on actual user idleness, not just Emacs' idle time. For | |
5563 | X11, you can install a utility program @file{x11idle.c}, available in the | |
5564 | UTILITIES directory of the Org git distribution, to get the same general | |
5565 | treatment of idleness. On other systems, idle time refers to Emacs idle time | |
5566 | only.}, and ask what you want to do with the idle time. There will be a | |
5567 | question waiting for you when you get back, indicating how much idle time has | |
5568 | passed (constantly updated with the current amount), as well as a set of | |
5569 | choices to correct the discrepancy: | |
5570 | ||
5571 | @table @kbd | |
5572 | @item k | |
5573 | To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org | |
5574 | will ask how many of the minutes to keep. Press @key{RET} to keep them all, | |
5575 | effectively changing nothing, or enter a number to keep that many minutes. | |
5576 | @item K | |
5577 | If you use the shift key and press @kbd{K}, it will keep however many minutes | |
5578 | you request and then immediately clock out of that task. If you keep all of | |
5579 | the minutes, this is the same as just clocking out of the current task. | |
5580 | @item s | |
5581 | To keep none of the minutes, use @kbd{s} to subtract all the away time from | |
5582 | the clock, and then check back in from the moment you returned. | |
5583 | @item S | |
5584 | To keep none of the minutes and just clock out at the start of the away time, | |
5585 | use the shift key and press @kbd{S}. Remember that using shift will always | |
5586 | leave you clocked out, no matter which option you choose. | |
5587 | @item C | |
5588 | To cancel the clock altogether, use @kbd{C}. Note that if instead of | |
5589 | cancelling you subtract the away time, and the resulting clock amount is less | |
5590 | than a minute, the clock will still be cancelled rather than clutter up the | |
5591 | log with an empty entry. | |
5592 | @end table | |
5593 | ||
5594 | What if you subtracted those away minutes from the current clock, and now | |
5595 | want to apply them to a new clock? Simply clock in to any task immediately | |
5596 | after the subtraction. Org will notice that you have subtracted time ``on | |
5597 | the books'', so to speak, and will ask if you want to apply those minutes to | |
5598 | the next task you clock in on. | |
5599 | ||
5600 | There is one other instance when this clock resolution magic occurs. Say you | |
5601 | were clocked in and hacking away, and suddenly your cat chased a mouse who | |
5602 | scared a hamster that crashed into your UPS's power button! You suddenly | |
5603 | lose all your buffers, but thanks to auto-save you still have your recent Org | |
5604 | mode changes, including your last clock in. | |
5605 | ||
5606 | If you restart Emacs and clock into any task, Org will notice that you have a | |
5607 | dangling clock which was never clocked out from your last session. Using | |
5608 | that clock's starting time as the beginning of the unaccounted-for period, | |
5609 | Org will ask how you want to resolve that time. The logic and behavior is | |
5610 | identical to dealing with away time due to idleness, it's just happening due | |
5611 | to a recovery event rather than a set amount of idle time. | |
5612 | ||
5613 | You can also check all the files visited by your Org agenda for dangling | |
5614 | clocks at any time using @kbd{M-x org-resolve-clocks}. | |
5615 | ||
5616 | @node Effort estimates, Relative timer, Resolving idle time, Dates and Times | |
a7808fba | 5617 | @section Effort estimates |
96c8522a | 5618 | @cindex effort estimates |
a7808fba | 5619 | |
c8d0cf5c CD |
5620 | @cindex property, Effort |
5621 | @vindex org-effort-property | |
a7808fba CD |
5622 | If you want to plan your work in a very detailed way, or if you need to |
5623 | produce offers with quotations of the estimated work effort, you may want to | |
5624 | assign effort estimates to entries. If you are also clocking your work, you | |
5625 | may later want to compare the planned effort with the actual working time, a | |
5626 | great way to improve planning estimates. Effort estimates are stored in a | |
5627 | special property @samp{Effort}@footnote{You may change the property being | |
6eb02347 CD |
5628 | used with the variable @code{org-effort-property}.}. You can set the effort |
5629 | for an entry with the following commands: | |
5630 | ||
5631 | @table @kbd | |
5632 | @kindex C-c C-x e | |
5633 | @item C-c C-x e | |
5634 | Set the effort estimate for the current entry. With a numeric prefix | |
5635 | argument, set it to the NTH allowed value (see below). This command is also | |
5636 | accessible from the agenda with the @kbd{e} key. | |
5637 | @kindex C-c C-x C-e | |
5638 | @item C-c C-x C-e | |
5639 | Modify the effort estimate of the item currently being clocked. | |
5640 | @end table | |
5641 | ||
5642 | Clearly the best way to work with effort estimates is through column view | |
5643 | (@pxref{Column view}). You should start by setting up discrete values for | |
5644 | effort estimates, and a @code{COLUMNS} format that displays these values | |
5645 | together with clock sums (if you want to clock your time). For a specific | |
5646 | buffer you can use | |
a7808fba CD |
5647 | |
5648 | @example | |
5649 | #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00 | |
5650 | #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM | |
5651 | @end example | |
5652 | ||
5653 | @noindent | |
c8d0cf5c CD |
5654 | @vindex org-global-properties |
5655 | @vindex org-columns-default-format | |
71d35b24 CD |
5656 | or, even better, you can set up these values globally by customizing the |
5657 | variables @code{org-global-properties} and @code{org-columns-default-format}. | |
5658 | In particular if you want to use this setup also in the agenda, a global | |
5659 | setup may be advised. | |
a7808fba CD |
5660 | |
5661 | The way to assign estimates to individual items is then to switch to column | |
5662 | mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the | |
5663 | value. The values you enter will immediately be summed up in the hierarchy. | |
5664 | In the column next to it, any clocked time will be displayed. | |
5665 | ||
c8d0cf5c | 5666 | @vindex org-agenda-columns-add-appointments-to-effort-sum |
a7808fba CD |
5667 | If you switch to column view in the daily/weekly agenda, the effort column |
5668 | will summarize the estimated work effort for each day@footnote{Please note | |
5669 | the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda | |
b349f79f | 5670 | column view}).}, and you can use this to find space in your schedule. To get |
a7808fba CD |
5671 | an overview of the entire part of the day that is committed, you can set the |
5672 | option @code{org-agenda-columns-add-appointments-to-effort-sum}. The | |
5673 | appointments on a day that take place over a specified time interval will | |
5674 | then also be added to the load estimate of the day. | |
5675 | ||
71d35b24 CD |
5676 | Effort estimates can be used in secondary agenda filtering that is triggered |
5677 | with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have | |
5678 | these estimates defined consistently, two or three key presses will narrow | |
5679 | down the list to stuff that fits into an available time slot. | |
864c9740 | 5680 | |
96c8522a CD |
5681 | @node Relative timer, , Effort estimates, Dates and Times |
5682 | @section Taking notes with a relative timer | |
5683 | @cindex relative timer | |
5684 | ||
5685 | When taking notes during, for example, a meeting or a video viewing, it can | |
5686 | be useful to have access to times relative to a starting time. Org provides | |
5687 | such a relative timer and make it easy to create timed notes. | |
5688 | ||
5689 | @table @kbd | |
5690 | @kindex C-c C-x . | |
5691 | @item C-c C-x . | |
5692 | Insert a relative time into the buffer. The first time you use this, the | |
5693 | timer will be started. When called with a prefix argument, the timer is | |
5694 | restarted. | |
5695 | @kindex C-c C-x - | |
5696 | @item C-c C-x - | |
5697 | Insert a description list item with the current relative time. With a prefix | |
5698 | argument, first reset the timer to 0. | |
5699 | @kindex M-@key{RET} | |
5700 | @item M-@key{RET} | |
377952e0 | 5701 | Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert |
96c8522a | 5702 | new timer items. |
55e0839d CD |
5703 | @kindex C-c C-x , |
5704 | @item C-c C-x , | |
c8d0cf5c CD |
5705 | Pause the timer, or continue it if it is already paused. |
5706 | @c removed the sentence because it is redundant to the following item | |
55e0839d CD |
5707 | @kindex C-u C-c C-x , |
5708 | @item C-u C-c C-x , | |
5709 | Stop the timer. After this, you can only start a new timer, not continue the | |
5710 | old one. This command also removes the timer from the mode line. | |
96c8522a CD |
5711 | @kindex C-c C-x 0 |
5712 | @item C-c C-x 0 | |
5713 | Reset the timer without inserting anything into the buffer. By default, the | |
5714 | timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to | |
5715 | specific starting offset. The user is prompted for the offset, with a | |
5716 | default taken from a timer string at point, if any, So this can be used to | |
5717 | restart taking notes after a break in the process. When called with a double | |
5718 | prefix argument @kbd{C-c C-u}, change all timer strings in the active region | |
5719 | by a certain amount. This can be used to fix timer strings if the timer was | |
5720 | not started at exactly the right moment. | |
5721 | @end table | |
5722 | ||
a351880d CD |
5723 | @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top |
5724 | @chapter Capture - Refile - Archive | |
864c9740 CD |
5725 | @cindex capture |
5726 | ||
5727 | An important part of any organization system is the ability to quickly | |
5728 | capture new ideas and tasks, and to associate reference material with them. | |
c8d0cf5c | 5729 | Org uses the @file{remember.el} package to create tasks, and stores files |
a351880d CD |
5730 | related to a task (@i{attachments}) in a special directory. Once in the |
5731 | system, tasks and projects need to be moved around. Moving completed project | |
5732 | trees to an archive file keeps the system compact and fast. | |
864c9740 CD |
5733 | |
5734 | @menu | |
5735 | * Remember:: Capture new tasks/ideas with little interruption | |
5736 | * Attachments:: Add files to tasks. | |
c8d0cf5c | 5737 | * RSS Feeds:: Getting input from RSS feeds |
a351880d CD |
5738 | * Protocols:: External (e.g. Browser) access to Emacs and Org |
5739 | * Refiling notes:: Moving a tree from one place to another | |
5740 | * Archiving:: What to do with finished projects | |
864c9740 CD |
5741 | @end menu |
5742 | ||
a351880d | 5743 | @node Remember, Attachments, Capture - Refile - Archive, Capture - Refile - Archive |
864c9740 | 5744 | @section Remember |
dbc28aaa CD |
5745 | @cindex @file{remember.el} |
5746 | ||
c8d0cf5c CD |
5747 | The Remember package by John Wiegley lets you store quick notes with little |
5748 | interruption of your work flow. It is an excellent way to add new notes and | |
5749 | tasks to Org files. The @code{remember.el} package is part of Emacs 23, not | |
5750 | Emacs 22. See @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for | |
5751 | more information. | |
5752 | ||
5753 | Org significantly expands the possibilities of Remember: you may define | |
5754 | templates for different note types, and associate target files and headlines | |
5755 | with specific templates. It also allows you to select the location where a | |
5756 | note should be stored interactively, on the fly. | |
dbc28aaa CD |
5757 | |
5758 | @menu | |
7006d207 | 5759 | * Setting up Remember for Org:: Some code for .emacs to get things going |
dbc28aaa CD |
5760 | * Remember templates:: Define the outline of different note types |
5761 | * Storing notes:: Directly get the note to where it belongs | |
dbc28aaa CD |
5762 | @end menu |
5763 | ||
c8d0cf5c CD |
5764 | @node Setting up Remember for Org, Remember templates, Remember, Remember |
5765 | @subsection Setting up Remember for Org | |
dbc28aaa | 5766 | |
c8d0cf5c | 5767 | The following customization will tell Remember to use Org files as |
a7808fba | 5768 | target, and to create annotations compatible with Org links. |
dbc28aaa CD |
5769 | |
5770 | @example | |
5771 | (org-remember-insinuate) | |
5772 | (setq org-directory "~/path/to/my/orgfiles/") | |
5773 | (setq org-default-notes-file (concat org-directory "/notes.org")) | |
5774 | (define-key global-map "\C-cr" 'org-remember) | |
5775 | @end example | |
5776 | ||
c8d0cf5c | 5777 | @noindent |
dbc28aaa CD |
5778 | The last line binds the command @code{org-remember} to a global |
5779 | key@footnote{Please select your own key, @kbd{C-c r} is only a | |
c8d0cf5c CD |
5780 | suggestion.}. @code{org-remember} basically just calls Remember, |
5781 | but it makes a few things easier: if there is an active region, it will | |
5782 | automatically copy the region into the Remember buffer. It also allows | |
5783 | to jump to the buffer and location where Remember notes are being | |
5784 | stored: just call @code{org-remember} with a prefix argument. If you | |
a7808fba | 5785 | use two prefix arguments, Org jumps to the location where the last |
28a16a1b | 5786 | remember note was stored. |
dbc28aaa | 5787 | |
c8d0cf5c CD |
5788 | The Remember buffer will actually use @code{org-mode} as its major mode, so |
5789 | that all editing features of Org mode are available. In addition to this, a | |
64fb801f CD |
5790 | minor mode @code{org-remember-mode} is turned on, for the single purpose that |
5791 | you can use its keymap @code{org-remember-mode-map} to overwrite some of | |
c8d0cf5c | 5792 | Org mode's key bindings. |
64fb801f | 5793 | |
b349f79f | 5794 | You can also call @code{org-remember} in a special way from the agenda, |
c8d0cf5c CD |
5795 | using the @kbd{k r} key combination. With this access, any timestamps |
5796 | inserted by the selected Remember template (see below) will default to | |
b349f79f CD |
5797 | the cursor date in the agenda, rather than to the current date. |
5798 | ||
c8d0cf5c | 5799 | @node Remember templates, Storing notes, Setting up Remember for Org, Remember |
864c9740 | 5800 | @subsection Remember templates |
c8d0cf5c | 5801 | @cindex templates, for Remember |
dbc28aaa | 5802 | |
a7808fba | 5803 | In combination with Org, you can use templates to generate |
c8d0cf5c | 5804 | different types of Remember notes. For example, if you would like |
dbc28aaa CD |
5805 | to use one template to create general TODO entries, another one for |
5806 | journal entries, and a third one for collecting random ideas, you could | |
5807 | use: | |
5808 | ||
5809 | @example | |
5810 | (setq org-remember-templates | |
5811 | '(("Todo" ?t "* TODO %?\n %i\n %a" "~/org/TODO.org" "Tasks") | |
5812 | ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org") | |
5813 | ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas"))) | |
5814 | @end example | |
5815 | ||
c8d0cf5c CD |
5816 | @vindex org-remember-default-headline |
5817 | @vindex org-directory | |
dbc28aaa CD |
5818 | @noindent In these entries, the first string is just a name, and the |
5819 | character specifies how to select the template. It is useful if the | |
b349f79f CD |
5820 | character is also the first letter of the name. The next string specifies |
5821 | the template. Two more (optional) strings give the file in which, and the | |
a351880d CD |
5822 | headline under which, the new note should be stored. The file (if not |
5823 | present or @code{nil}) defaults to @code{org-default-notes-file}, the heading | |
5824 | to @code{org-remember-default-headline}. If the file name is not an absolute | |
5825 | path, it will be interpreted relative to @code{org-directory}. | |
5826 | ||
5827 | The heading can also be the symbols @code{top} or @code{bottom} to send notes | |
5828 | as level 1 entries to the beginning or end of the file, respectively. It may | |
5829 | also be the symbol @code{date-tree}. Then, a tree with year on level 1, | |
5830 | month on level 2 and day on level three will be build in the file, and the | |
5831 | entry will be filed into the tree under the current date@footnote{If the file | |
5832 | contains an entry with a @code{DATE_TREE} property, the entire date tree will | |
5833 | be build under that entry.} | |
b349f79f CD |
5834 | |
5835 | An optional sixth element specifies the contexts in which the user can select | |
5836 | the template. This element can be a list of major modes or a function. | |
5837 | @code{org-remember} will first check whether the function returns @code{t} or | |
c8d0cf5c | 5838 | if we are in any of the listed major modes, and exclude templates for which |
b349f79f CD |
5839 | this condition is not fulfilled. Templates that do not specify this element |
5840 | at all, or that use @code{nil} or @code{t} as a value will always be | |
5841 | selectable. | |
28a16a1b CD |
5842 | |
5843 | So for example: | |
5844 | ||
5845 | @example | |
5846 | (setq org-remember-templates | |
5847 | '(("Bug" ?b "* BUG %?\n %i\n %a" "~/org/BUGS.org" "Bugs" (emacs-lisp-mode)) | |
b349f79f | 5848 | ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org" "X" my-check) |
28a16a1b CD |
5849 | ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas"))) |
5850 | @end example | |
5851 | ||
c8d0cf5c | 5852 | @noindent |
28a16a1b CD |
5853 | The first template will only be available when invoking @code{org-remember} |
5854 | from an buffer in @code{emacs-lisp-mode}. The second template will only be | |
5855 | available when the function @code{my-check} returns @code{t}. The third | |
5856 | template will be proposed in any context. | |
5857 | ||
b349f79f CD |
5858 | When you call @kbd{M-x org-remember} (or @kbd{M-x remember}) to remember |
5859 | something, Org will prompt for a key to select the template (if you have | |
dbc28aaa CD |
5860 | more than one template) and then prepare the buffer like |
5861 | @example | |
5862 | * TODO | |
c8d0cf5c | 5863 | [[file:@var{link to where you called remember}]] |
dbc28aaa CD |
5864 | @end example |
5865 | ||
5866 | @noindent | |
6eb02347 CD |
5867 | During expansion of the template, special @kbd{%}-escapes@footnote{If you |
5868 | need one of these sequences literally, escape the @kbd{%} with a backslash.} | |
5869 | allow dynamic insertion of content: | |
dbc28aaa | 5870 | @example |
c8d0cf5c | 5871 | %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.} |
dbc28aaa CD |
5872 | @r{You may specify a default value and a completion table with} |
5873 | @r{%^@{prompt|default|completion2|completion3...@}} | |
5874 | @r{The arrow keys access a prompt-specific history.} | |
b349f79f CD |
5875 | %a @r{annotation, normally the link created with @code{org-store-link}} |
5876 | %A @r{like @code{%a}, but prompt for the description part} | |
5877 | %i @r{initial content, the region when remember is called with C-u.} | |
5878 | @r{The entire text will be indented like @code{%i} itself.} | |
c8d0cf5c CD |
5879 | %t @r{timestamp, date only} |
5880 | %T @r{timestamp with date and time} | |
5881 | %u, %U @r{like the above, but inactive timestamps} | |
dbc28aaa CD |
5882 | %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}} |
5883 | @r{You may define a prompt like @code{%^@{Birthday@}t}} | |
5884 | %n @r{user name (taken from @code{user-full-name})} | |
a7808fba CD |
5885 | %c @r{Current kill ring head.} |
5886 | %x @r{Content of the X clipboard.} | |
5887 | %^C @r{Interactive selection of which kill or clip to use.} | |
5888 | %^L @r{Like @code{%^C}, but insert as link.} | |
dbc28aaa | 5889 | %^g @r{prompt for tags, with completion on tags in target file.} |
864c9740 CD |
5890 | %k @r{title of currently clocked task} |
5891 | %K @r{link to currently clocked task} | |
dbc28aaa | 5892 | %^G @r{prompt for tags, with completion all tags in all agenda files.} |
c8d0cf5c | 5893 | %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}} |
dbc28aaa | 5894 | %:keyword @r{specific information for certain link types, see below} |
c8d0cf5c CD |
5895 | %[@var{file}] @r{insert the contents of the file given by @var{file}} |
5896 | %(@var{sexp}) @r{evaluate Elisp @var{sexp} and replace with the result} | |
dbc28aaa CD |
5897 | %! @r{immediately store note after completing the template} |
5898 | @r{(skipping the @kbd{C-c C-c} that normally triggers storing)} | |
b349f79f | 5899 | %& @r{jump to target location immediately after storing note} |
dbc28aaa CD |
5900 | @end example |
5901 | ||
5902 | @noindent | |
5903 | For specific link types, the following keywords will be | |
5904 | defined@footnote{If you define your own link types (@pxref{Adding | |
5905 | hyperlink types}), any property you store with | |
5906 | @code{org-store-link-props} can be accessed in remember templates in a | |
5907 | similar way.}: | |
5908 | ||
c8d0cf5c | 5909 | @vindex org-from-is-user-regexp |
dbc28aaa CD |
5910 | @example |
5911 | Link type | Available keywords | |
5912 | -------------------+---------------------------------------------- | |
5913 | bbdb | %:name %:company | |
28a16a1b | 5914 | bbdb | %::server %:port %:nick |
dbc28aaa CD |
5915 | vm, wl, mh, rmail | %:type %:subject %:message-id |
5916 | | %:from %:fromname %:fromaddress | |
5917 | | %:to %:toname %:toaddress | |
28a16a1b | 5918 | | %: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}.}} |
dbc28aaa CD |
5919 | gnus | %:group, @r{for messages also all email fields} |
5920 | w3, w3m | %:url | |
5921 | info | %:file %:node | |
5922 | calendar | %:date" | |
5923 | @end example | |
5924 | ||
5925 | @noindent | |
5926 | To place the cursor after template expansion use: | |
5927 | ||
5928 | @example | |
5929 | %? @r{After completing the template, position cursor here.} | |
5930 | @end example | |
5931 | ||
5932 | @noindent | |
28a16a1b | 5933 | If you change your mind about which template to use, call |
dbc28aaa CD |
5934 | @code{org-remember} in the remember buffer. You may then select a new |
5935 | template that will be filled with the previous context information. | |
5936 | ||
a351880d | 5937 | @node Storing notes, , Remember templates, Remember |
864c9740 | 5938 | @subsection Storing notes |
dbc28aaa | 5939 | |
c8d0cf5c CD |
5940 | @vindex org-remember-clock-out-on-exit |
5941 | When you are finished preparing a note with Remember, you have to press | |
b349f79f | 5942 | @kbd{C-c C-c} to file the note away. If you have started the clock in the |
c8d0cf5c | 5943 | Remember buffer, you will first be asked if you want to clock out |
b349f79f CD |
5944 | now@footnote{To avoid this query, configure the variable |
5945 | @code{org-remember-clock-out-on-exit}.}. If you answer @kbd{n}, the clock | |
44ce9197 | 5946 | will continue to run after the note was filed away. |
b349f79f CD |
5947 | |
5948 | The handler will then store the note in the file and under the headline | |
c8d0cf5c | 5949 | specified in the template, or it will use the default file and headline. |
b349f79f | 5950 | The window configuration will be restored, sending you back to the working |
c8d0cf5c CD |
5951 | context before the call to Remember. To re-use the location found |
5952 | during the last call to Remember, exit the Remember buffer with | |
a351880d | 5953 | @kbd{C-0 C-c C-c}, i.e. specify a zero prefix argument to @kbd{C-c C-c}. |
864c9740 CD |
5954 | Another special case is @kbd{C-2 C-c C-c} which files the note as a child of |
5955 | the currently clocked item. | |
dbc28aaa | 5956 | |
c8d0cf5c | 5957 | @vindex org-remember-store-without-prompt |
dbc28aaa | 5958 | If you want to store the note directly to a different place, use |
c8d0cf5c | 5959 | @kbd{C-1 C-c C-c} instead to exit Remember@footnote{Configure the |
dbc28aaa | 5960 | variable @code{org-remember-store-without-prompt} to make this behavior |
c8d0cf5c CD |
5961 | the default.}. The handler will then first prompt for a target file---if |
5962 | you press @key{RET}, the value specified for the template is used. | |
dbc28aaa | 5963 | Then the command offers the headings tree of the selected file, with the |
c8d0cf5c | 5964 | cursor position at the default headline (if you specified one in the |
dbc28aaa CD |
5965 | template). You can either immediately press @key{RET} to get the note |
5966 | placed there. Or you can use the following keys to find a different | |
5967 | location: | |
5968 | @example | |
5969 | @key{TAB} @r{Cycle visibility.} | |
5970 | @key{down} / @key{up} @r{Next/previous visible headline.} | |
5971 | n / p @r{Next/previous visible headline.} | |
5972 | f / b @r{Next/previous headline same level.} | |
5973 | u @r{One level up.} | |
5974 | @c 0-9 @r{Digit argument.} | |
5975 | @end example | |
5976 | @noindent | |
5977 | Pressing @key{RET} or @key{left} or @key{right} | |
5978 | then leads to the following result. | |
5979 | ||
c8d0cf5c | 5980 | @vindex org-reverse-note-order |
dbc28aaa CD |
5981 | @multitable @columnfractions 0.2 0.15 0.65 |
5982 | @item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted} | |
5983 | @item on headline @tab @key{RET} @tab as sublevel of the heading at cursor, first or last | |
5984 | @item @tab @tab depending on @code{org-reverse-note-order}. | |
5985 | @item @tab @key{left}/@key{right} @tab as same level, before/after current heading | |
5986 | @item buffer-start @tab @key{RET} @tab as level 2 heading at end of file or level 1 at beginning | |
5987 | @item @tab @tab depending on @code{org-reverse-note-order}. | |
5988 | @item not on headline @tab @key{RET} | |
5989 | @tab at cursor position, level taken from context. | |
5990 | @end multitable | |
5991 | ||
864c9740 | 5992 | Before inserting the text into a tree, the function ensures that the text has |
a351880d | 5993 | a headline, i.e. a first line that starts with a @samp{*}. If not, a |
864c9740 CD |
5994 | headline is constructed from the current date. If you have indented the text |
5995 | of the note below the headline, the indentation will be adapted if inserting | |
5996 | the note into the tree requires demotion from level 1. | |
dbc28aaa | 5997 | |
c8d0cf5c | 5998 | |
a351880d | 5999 | @node Attachments, RSS Feeds, Remember, Capture - Refile - Archive |
864c9740 CD |
6000 | @section Attachments |
6001 | @cindex attachments | |
6002 | ||
c8d0cf5c | 6003 | @vindex org-attach-directory |
864c9740 CD |
6004 | It is often useful to associate reference material with an outline node/task. |
6005 | Small chunks of plain text can simply be stored in the subtree of a project. | |
6006 | Hyperlinks (@pxref{Hyperlinks}) can be used to establish associations with | |
6007 | files that live elsewhere on your computer or in the cloud, like emails or | |
6008 | source code files belonging to a project. Another method is @i{attachments}, | |
6009 | which are files located in a directory belonging to an outline node. Org | |
6010 | uses directories named by the unique ID of each entry. These directories are | |
6011 | located in the @file{data} directory which lives in the same directory where | |
c8d0cf5c CD |
6012 | your Org file lives@footnote{If you move entries or Org files from one |
6013 | directory to another, you may want to configure @code{org-attach-directory} | |
864c9740 | 6014 | to contain an absolute path.}. If you initialize this directory with |
c8d0cf5c | 6015 | @code{git init}, Org will automatically commit changes when it sees them. |
864c9740 CD |
6016 | The attachment system has been contributed to Org by John Wiegley. |
6017 | ||
c8d0cf5c | 6018 | In cases where it seems better to do so, you can also attach a directory of your |
55e0839d CD |
6019 | choice to an entry. You can also make children inherit the attachment |
6020 | directory from a parent, so that an entire subtree uses the same attached | |
6021 | directory. | |
6022 | ||
864c9740 CD |
6023 | @noindent The following commands deal with attachments. |
6024 | ||
6025 | @table @kbd | |
6026 | ||
6027 | @kindex C-c C-a | |
6028 | @item C-c C-a | |
6029 | The dispatcher for commands related to the attachment system. After these | |
6030 | keys, a list of commands is displayed and you need to press an additional key | |
6031 | to select a command: | |
6032 | ||
6033 | @table @kbd | |
96c8522a CD |
6034 | @kindex C-c C-a a |
6035 | @item a | |
c8d0cf5c | 6036 | @vindex org-attach-method |
864c9740 CD |
6037 | Select a file and move it into the task's attachment directory. The file |
6038 | will be copied, moved, or linked, depending on @code{org-attach-method}. | |
6039 | Note that hard links are not supported on all systems. | |
6040 | ||
6041 | @kindex C-c C-a c | |
96c8522a CD |
6042 | @kindex C-c C-a m |
6043 | @kindex C-c C-a l | |
864c9740 CD |
6044 | @item c/m/l |
6045 | Attach a file using the copy/move/link method. | |
6046 | Note that hard links are not supported on all systems. | |
6047 | ||
6048 | @kindex C-c C-a n | |
6049 | @item n | |
6050 | Create a new attachment as an Emacs buffer. | |
6051 | ||
6052 | @kindex C-c C-a z | |
6053 | @item z | |
6054 | Synchronize the current task with its attachment directory, in case you added | |
6055 | attachments yourself. | |
6056 | ||
6057 | @kindex C-c C-a o | |
6058 | @item o | |
c8d0cf5c | 6059 | @vindex org-file-apps |
864c9740 CD |
6060 | Open current task's attachment. If there are more than one, prompt for a |
6061 | file name first. Opening will follow the rules set by @code{org-file-apps}. | |
a50253cc | 6062 | For more details, see the information on following hyperlinks |
864c9740 CD |
6063 | (@pxref{Handling links}). |
6064 | ||
6065 | @kindex C-c C-a O | |
6066 | @item O | |
6067 | Also open the attachment, but force opening the file in Emacs. | |
6068 | ||
6069 | @kindex C-c C-a f | |
6070 | @item f | |
6071 | Open the current task's attachment directory. | |
6072 | ||
6073 | @kindex C-c C-a F | |
6074 | @item F | |
c8d0cf5c | 6075 | Also open the directory, but force using @command{dired} in Emacs. |
864c9740 CD |
6076 | |
6077 | @kindex C-c C-a d | |
6078 | @item d | |
6079 | Select and delete a single attachment. | |
6080 | ||
6081 | @kindex C-c C-a D | |
6082 | @item D | |
6083 | Delete all of a task's attachments. A safer way is to open the directory in | |
c8d0cf5c | 6084 | @command{dired} and delete from there. |
55e0839d CD |
6085 | |
6086 | @kindex C-c C-a s | |
6087 | @item C-c C-a s | |
c8d0cf5c | 6088 | @cindex property, ATTACH_DIR |
55e0839d CD |
6089 | Set a specific directory as the entry's attachment directory. This works by |
6090 | putting the directory path into the @code{ATTACH_DIR} property. | |
6091 | ||
6092 | @kindex C-c C-a i | |
6093 | @item C-c C-a i | |
c8d0cf5c | 6094 | @cindex property, ATTACH_DIR_INHERIT |
55e0839d | 6095 | Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the |
c8d0cf5c | 6096 | same directory for attachments as the parent does. |
864c9740 CD |
6097 | @end table |
6098 | @end table | |
6099 | ||
a351880d | 6100 | @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive |
c8d0cf5c CD |
6101 | @section RSS feeds |
6102 | @cindex RSS feeds | |
6103 | ||
6104 | Org has the capability to add and change entries based on information found in | |
6105 | RSS feeds. You could use this to make a task out of each new podcast in a | |
6106 | podcast feed. Or you could use a phone-based note-creating service on the | |
6107 | web to import tasks into Org. To access feeds, you need to configure the | |
6108 | variable @code{org-feed-alist}. The docstring of this variable has detailed | |
6109 | information. Here is just an example: | |
6110 | ||
6111 | @example | |
6112 | (setq org-feed-alist | |
6113 | '(("ReQall" "http://www.reqall.com/user/feeds/rss/a1b2c3....." | |
6114 | "~/org/feeds.org" "ReQall Entries") | |
6115 | @end example | |
6116 | @noindent | |
6117 | will configure that new items from the feed provided by @file{reqall.com} | |
6118 | will result in new entries in the file @file{~/org/feeds.org} under the | |
6119 | heading @samp{ReQall Entries}, whenever the following command is used: | |
6120 | ||
6121 | @table @kbd | |
6122 | @kindex C-c C-x g | |
6123 | @item C-c C-x g | |
6124 | Collect items from the feeds configured in @code{org-feed-alist} and act upon | |
6125 | them. | |
6126 | @kindex C-c C-x G | |
6127 | @item C-c C-x G | |
6128 | Prompt for a feed name and go to the inbox configured for this feed. | |
6129 | @end table | |
6130 | ||
6131 | Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which | |
6132 | it will store information about the status of items in the feed, to avoid | |
6133 | adding the same item several times. You should add @samp{FEEDSTATUS} to the | |
6134 | list of drawers in that file: | |
6135 | ||
6136 | @example | |
6137 | #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS | |
6138 | @end example | |
6139 | ||
6140 | For more information, see @file{org-feed.el} and the docstring of | |
6141 | @code{org-feed-alist}. | |
6142 | ||
a351880d | 6143 | @node Protocols, Refiling notes, RSS Feeds, Capture - Refile - Archive |
c8d0cf5c CD |
6144 | @section Protocols for external access |
6145 | @cindex protocols, for external access | |
6146 | @cindex emacsserver | |
6147 | ||
6148 | You can set up Org for handling protocol calls from outside applications that | |
6149 | are passed to Emacs through the @file{emacsserver}. For example, you can | |
6150 | configure bookmarks in your web browser to send a link to the current page to | |
6151 | Org and create a note from it using Remember (@pxref{Remember}). Or you | |
6152 | could create a bookmark that will tell Emacs to open the local source file of | |
6153 | a remote website you are looking at with the browser. See | |
6154 | @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed | |
6155 | documentation and setup instructions. | |
6156 | ||
a351880d CD |
6157 | @node Refiling notes, Archiving, Protocols, Capture - Refile - Archive |
6158 | @section Refiling notes | |
6159 | @cindex refiling notes | |
c8d0cf5c | 6160 | |
a351880d CD |
6161 | When reviewing the captured data, you may want to refile some of the entries |
6162 | into a different list, for example into a project. Cutting, finding the | |
6163 | right location, and then pasting the note is cumbersome. To simplify this | |
6164 | process, you can use the following special command: | |
4009494e | 6165 | |
a351880d CD |
6166 | @table @kbd |
6167 | @kindex C-c C-w | |
6168 | @item C-c C-w | |
6169 | @vindex org-reverse-note-order | |
6170 | @vindex org-refile-targets | |
6171 | @vindex org-refile-use-outline-path | |
6172 | @vindex org-outline-path-complete-in-steps | |
6173 | @vindex org-refile-allow-creating-parent-nodes | |
6174 | Refile the entry or region at point. This command offers possible locations | |
6175 | for refiling the entry and lets you select one with completion. The item (or | |
6176 | all items in the region) is filed below the target heading as a subitem. | |
6177 | Depending on @code{org-reverse-note-order}, it will be either the first or | |
6178 | last subitem.@* | |
6179 | By default, all level 1 headlines in the current buffer are considered to be | |
6180 | targets, but you can have more complex definitions across a number of files. | |
6181 | See the variable @code{org-refile-targets} for details. If you would like to | |
6182 | select a location via a file-path-like completion along the outline path, see | |
6183 | the variables @code{org-refile-use-outline-path} and | |
6184 | @code{org-outline-path-complete-in-steps}. If you would like to be able to | |
045b9da7 | 6185 | create new nodes as new parents for refiling on the fly, check the |
a351880d CD |
6186 | variable @code{org-refile-allow-creating-parent-nodes}. |
6187 | @kindex C-u C-c C-w | |
6188 | @item C-u C-c C-w | |
6189 | Use the refile interface to jump to a heading. | |
6190 | @kindex C-u C-u C-c C-w | |
6191 | @item C-u C-u C-c C-w | |
6192 | Jump to the location where @code{org-refile} last moved a tree to. | |
6193 | @item C-2 C-c C-w | |
6194 | Refile as the child of the item currently being clocked. | |
6195 | @end table | |
4009494e | 6196 | |
a351880d CD |
6197 | @node Archiving, , Refiling notes, Capture - Refile - Archive |
6198 | @section Archiving | |
6199 | @cindex archiving | |
4009494e | 6200 | |
a351880d CD |
6201 | When a project represented by a (sub)tree is finished, you may want |
6202 | to move the tree out of the way and to stop it from contributing to the | |
6203 | agenda. Archiving is important to keep your working files compact and global | |
6204 | searches like the construction of agenda views fast. | |
6205 | ||
6206 | @table @kbd | |
6207 | @kindex C-c C-x C-a | |
6208 | @item C-c C-x C-a | |
6209 | @vindex org-archive-default-command | |
6210 | Archive the current entry using the command specified in the variable | |
6211 | @code{org-archive-default-command}. | |
6212 | @end table | |
6213 | ||
6214 | @menu | |
6215 | * Moving subtrees:: Moving a tree to an archive file | |
6216 | * Internal archiving:: Switch off a tree but keep i in the file | |
6217 | @end menu | |
6218 | ||
6219 | @node Moving subtrees, Internal archiving, Archiving, Archiving | |
6220 | @subsection Moving a tree to the archive file | |
6221 | @cindex external archiving | |
6222 | ||
6223 | The most common archiving action is to move a project tree to another file, | |
6224 | the archive file. | |
6225 | ||
6226 | @table @kbd | |
6227 | @kindex C-c $ | |
6228 | @kindex C-c C-x C-s | |
6229 | @item C-c C-x C-s@ @r{or short} @ C-c $ | |
6230 | @vindex org-archive-location | |
6231 | Archive the subtree starting at the cursor position to the location | |
6232 | given by @code{org-archive-location}. | |
6233 | @kindex C-u C-c C-x C-s | |
6234 | @item C-u C-c C-x C-s | |
6235 | Check if any direct children of the current headline could be moved to | |
6236 | the archive. To do this, each subtree is checked for open TODO entries. | |
6237 | If none are found, the command offers to move it to the archive | |
6238 | location. If the cursor is @emph{not} on a headline when this command | |
6239 | is invoked, the level 1 trees will be checked. | |
6240 | @end table | |
6241 | ||
6242 | @cindex archive locations | |
6243 | The default archive location is a file in the same directory as the | |
6244 | current file, with the name derived by appending @file{_archive} to the | |
6245 | current file name. For information and examples on how to change this, | |
6246 | see the documentation string of the variable | |
6247 | @code{org-archive-location}. There is also an in-buffer option for | |
6248 | setting this variable, for example@footnote{For backward compatibility, | |
6249 | the following also works: If there are several such lines in a file, | |
6250 | each specifies the archive location for the text below it. The first | |
6251 | such line also applies to any text before its definition. However, | |
6252 | using this method is @emph{strongly} deprecated as it is incompatible | |
6253 | with the outline structure of the document. The correct method for | |
6254 | setting multiple archive locations in a buffer is using properties.}: | |
6255 | ||
6256 | @cindex #+ARCHIVE | |
6257 | @example | |
6258 | #+ARCHIVE: %s_done:: | |
6259 | @end example | |
6260 | ||
6261 | @cindex property, ARCHIVE | |
6262 | @noindent | |
6263 | If you would like to have a special ARCHIVE location for a single entry | |
6264 | or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the | |
6265 | location as the value (@pxref{Properties and Columns}). | |
6266 | ||
6267 | @vindex org-archive-save-context-info | |
6268 | When a subtree is moved, it receives a number of special properties that | |
6269 | record context information like the file from where the entry came, its | |
6270 | outline path the archiving time etc. Configure the variable | |
6271 | @code{org-archive-save-context-info} to adjust the amount of information | |
6272 | added. | |
6273 | ||
6274 | ||
6275 | @node Internal archiving, , Moving subtrees, Archiving | |
6276 | @subsection Internal archiving | |
6277 | ||
6278 | If you want to just switch off (for agenda views) certain subtrees without | |
6279 | moving them to a different file, you can use the @code{ARCHIVE tag}. | |
6280 | ||
6281 | A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at | |
6282 | its location in the outline tree, but behaves in the following way: | |
6283 | @itemize @minus | |
6284 | @item | |
6285 | @vindex org-cycle-open-archived-trees | |
6286 | It does not open when you attempt to do so with a visibility cycling | |
6287 | command (@pxref{Visibility cycling}). You can force cycling archived | |
6288 | subtrees with @kbd{C-@key{TAB}}, or by setting the option | |
6289 | @code{org-cycle-open-archived-trees}. Also normal outline commands like | |
6290 | @code{show-all} will open archived subtrees. | |
6291 | @item | |
6292 | @vindex org-sparse-tree-open-archived-trees | |
6293 | During sparse tree construction (@pxref{Sparse trees}), matches in | |
6294 | archived subtrees are not exposed, unless you configure the option | |
6295 | @code{org-sparse-tree-open-archived-trees}. | |
6296 | @item | |
6297 | @vindex org-agenda-skip-archived-trees | |
6298 | During agenda view construction (@pxref{Agenda Views}), the content of | |
6299 | archived trees is ignored unless you configure the option | |
6300 | @code{org-agenda-skip-archived-trees}, in which case these trees will always | |
6301 | be included. In the agenda you can press @kbd{v a} to get archives | |
6302 | temporarily included. | |
6303 | @item | |
6304 | @vindex org-export-with-archived-trees | |
6305 | Archived trees are not exported (@pxref{Exporting}), only the headline | |
6306 | is. Configure the details using the variable | |
6307 | @code{org-export-with-archived-trees}. | |
6308 | @item | |
6309 | @vindex org-columns-skip-arrchived-trees | |
6310 | Archived trees are excluded from column view unless the variable | |
6311 | @code{org-columns-skip-arrchived-trees} is configured to @code{nil}. | |
6312 | @end itemize | |
6313 | ||
6314 | The following commands help managing the ARCHIVE tag: | |
6315 | ||
6316 | @table @kbd | |
6317 | @kindex C-c C-x a | |
6318 | @item C-c C-x a | |
6319 | Toggle the ARCHIVE tag for the current headline. When the tag is set, | |
6320 | the headline changes to a shadowed face, and the subtree below it is | |
6321 | hidden. | |
6322 | @kindex C-u C-c C-x a | |
6323 | @item C-u C-c C-x a | |
6324 | Check if any direct children of the current headline should be archived. | |
6325 | To do this, each subtree is checked for open TODO entries. If none are | |
6326 | found, the command offers to set the ARCHIVE tag for the child. If the | |
6327 | cursor is @emph{not} on a headline when this command is invoked, the | |
6328 | level 1 trees will be checked. | |
6329 | @kindex C-@kbd{TAB} | |
6330 | @item C-@kbd{TAB} | |
6331 | Cycle a tree even if it is tagged with ARCHIVE. | |
6332 | @kindex C-c C-x A | |
6333 | @item C-c C-x A | |
6334 | Move the current entry to the @emph{Archive Sibling}. This is a sibling of | |
6335 | the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The | |
6336 | entry becomes a child of that sibling and in this way retains a lot of its | |
6337 | original context, including inherited tags and approximate position in the | |
6338 | outline. | |
6339 | @end table | |
6340 | ||
6341 | ||
6342 | @node Agenda Views, Markup, Capture - Refile - Archive, Top | |
6343 | @chapter Agenda Views | |
6344 | @cindex agenda views | |
6345 | ||
6346 | Due to the way Org works, TODO items, time-stamped items, and | |
6347 | tagged headlines can be scattered throughout a file or even a number of | |
6348 | files. To get an overview of open action items, or of events that are | |
6349 | important for a particular date, this information must be collected, | |
6350 | sorted and displayed in an organized way. | |
6351 | ||
6352 | Org can select items based on various criteria and display them | |
6353 | in a separate buffer. Seven different view types are provided: | |
6354 | ||
6355 | @itemize @bullet | |
6356 | @item | |
6357 | an @emph{agenda} that is like a calendar and shows information | |
6358 | for specific dates, | |
6359 | @item | |
6360 | a @emph{TODO list} that covers all unfinished | |
6361 | action items, | |
6362 | @item | |
6363 | a @emph{match view}, showings headlines based on the tags, properties, and | |
6364 | TODO state associated with them, | |
6365 | @item | |
6366 | a @emph{timeline view} that shows all events in a single Org file, | |
6367 | in time-sorted view, | |
6368 | @item | |
6369 | a @emph{text search view} that shows all entries from multiple files | |
6370 | that contain specified keywords, | |
6371 | @item | |
6372 | a @emph{stuck projects view} showing projects that currently don't move | |
6373 | along, and | |
6374 | @item | |
6375 | @emph{custom views} that are special searches and combinations of different | |
6376 | views. | |
4009494e GM |
6377 | @end itemize |
6378 | ||
6379 | @noindent | |
6380 | The extracted information is displayed in a special @emph{agenda | |
6381 | buffer}. This buffer is read-only, but provides commands to visit the | |
a7808fba | 6382 | corresponding locations in the original Org files, and even to |
28a16a1b | 6383 | edit these files remotely. |
4009494e | 6384 | |
c8d0cf5c CD |
6385 | @vindex org-agenda-window-setup |
6386 | @vindex org-agenda-restore-windows-after-quit | |
4009494e GM |
6387 | Two variables control how the agenda buffer is displayed and whether the |
6388 | window configuration is restored when the agenda exits: | |
6389 | @code{org-agenda-window-setup} and | |
6390 | @code{org-agenda-restore-windows-after-quit}. | |
6391 | ||
6392 | @menu | |
6393 | * Agenda files:: Files being searched for agenda information | |
6394 | * Agenda dispatcher:: Keyboard access to agenda views | |
6395 | * Built-in agenda views:: What is available out of the box? | |
6396 | * Presentation and sorting:: How agenda items are prepared for display | |
a7808fba | 6397 | * Agenda commands:: Remote editing of Org trees |
4009494e | 6398 | * Custom agenda views:: Defining special searches and views |
7006d207 | 6399 | * Exporting Agenda Views:: Writing a view to a file |
a7808fba | 6400 | * Agenda column view:: Using column view for collected entries |
4009494e GM |
6401 | @end menu |
6402 | ||
a7808fba | 6403 | @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views |
4009494e GM |
6404 | @section Agenda files |
6405 | @cindex agenda files | |
6406 | @cindex files for agenda | |
6407 | ||
c8d0cf5c | 6408 | @vindex org-agenda-files |
dbc28aaa CD |
6409 | The information to be shown is normally collected from all @emph{agenda |
6410 | files}, the files listed in the variable | |
6411 | @code{org-agenda-files}@footnote{If the value of that variable is not a | |
6412 | list, but a single file name, then the list of agenda files will be | |
6413 | maintained in that external file.}. If a directory is part of this list, | |
6414 | all files with the extension @file{.org} in this directory will be part | |
6415 | of the list. | |
6416 | ||
c8d0cf5c CD |
6417 | Thus, even if you only work with a single Org file, that file should |
6418 | be put into the list@footnote{When using the dispatcher, pressing | |
dbc28aaa CD |
6419 | @kbd{<} before selecting a command will actually limit the command to |
6420 | the current file, and ignore @code{org-agenda-files} until the next | |
4009494e GM |
6421 | dispatcher command.}. You can customize @code{org-agenda-files}, but |
6422 | the easiest way to maintain it is through the following commands | |
6423 | ||
6424 | @cindex files, adding to agenda list | |
6425 | @table @kbd | |
6426 | @kindex C-c [ | |
6427 | @item C-c [ | |
6428 | Add current file to the list of agenda files. The file is added to | |
6429 | the front of the list. If it was already in the list, it is moved to | |
a7808fba | 6430 | the front. With a prefix argument, file is added/moved to the end. |
4009494e GM |
6431 | @kindex C-c ] |
6432 | @item C-c ] | |
6433 | Remove current file from the list of agenda files. | |
6434 | @kindex C-, | |
6435 | @kindex C-' | |
6436 | @item C-, | |
6437 | @itemx C-' | |
6438 | Cycle through agenda file list, visiting one file after the other. | |
a7808fba CD |
6439 | @kindex M-x org-iswitchb |
6440 | @item M-x org-iswitchb | |
6441 | Command to use an @code{iswitchb}-like interface to switch to and between Org | |
6442 | buffers. | |
4009494e GM |
6443 | @end table |
6444 | ||
6445 | @noindent | |
6446 | The Org menu contains the current list of files and can be used | |
6447 | to visit any of them. | |
6448 | ||
c8d0cf5c CD |
6449 | If you would like to focus the agenda temporarily on a file not in |
6450 | this list, or on just one file in the list, or even on only a subtree in a | |
6451 | file, then this can be done in different ways. For a single agenda command, | |
dbc28aaa CD |
6452 | you may press @kbd{<} once or several times in the dispatcher |
6453 | (@pxref{Agenda dispatcher}). To restrict the agenda scope for an | |
6454 | extended period, use the following commands: | |
6455 | ||
6456 | @table @kbd | |
6457 | @kindex C-c C-x < | |
6458 | @item C-c C-x < | |
6459 | Permanently restrict the agenda to the current subtree. When with a | |
6460 | prefix argument, or with the cursor before the first headline in a file, | |
6461 | the agenda scope is set to the entire file. This restriction remains in | |
6462 | effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<} | |
6463 | or @kbd{>} in the agenda dispatcher. If there is a window displaying an | |
6464 | agenda view, the new restriction takes effect immediately. | |
67df9cfb CD |
6465 | @kindex C-c C-x > |
6466 | @item C-c C-x > | |
dbc28aaa CD |
6467 | Remove the permanent restriction created by @kbd{C-c C-x <}. |
6468 | @end table | |
6469 | ||
6470 | @noindent | |
c8d0cf5c | 6471 | When working with @file{speedbar.el}, you can use the following commands in |
a7808fba | 6472 | the Speedbar frame: |
dbc28aaa CD |
6473 | @table @kbd |
6474 | @kindex < | |
6475 | @item < @r{in the speedbar frame} | |
c8d0cf5c CD |
6476 | Permanently restrict the agenda to the item---either an Org file or a subtree |
6477 | in such a file---at the cursor in the Speedbar frame. | |
dbc28aaa CD |
6478 | If there is a window displaying an agenda view, the new restriction takes |
6479 | effect immediately. | |
67df9cfb | 6480 | @kindex > |
dbc28aaa | 6481 | @item > @r{in the speedbar frame} |
c8d0cf5c | 6482 | Lift the restriction. |
dbc28aaa CD |
6483 | @end table |
6484 | ||
a7808fba | 6485 | @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views |
4009494e GM |
6486 | @section The agenda dispatcher |
6487 | @cindex agenda dispatcher | |
6488 | @cindex dispatching agenda commands | |
c8d0cf5c CD |
6489 | The views are created through a dispatcher, which should be bound to a |
6490 | global key---for example @kbd{C-c a} (@pxref{Installation}). In the | |
4009494e GM |
6491 | following we will assume that @kbd{C-c a} is indeed how the dispatcher |
6492 | is accessed and list keyboard access to commands accordingly. After | |
6493 | pressing @kbd{C-c a}, an additional letter is required to execute a | |
6494 | command. The dispatcher offers the following default commands: | |
6495 | @table @kbd | |
6496 | @item a | |
a7808fba | 6497 | Create the calendar-like agenda (@pxref{Weekly/daily agenda}). |
4009494e GM |
6498 | @item t @r{/} T |
6499 | Create a list of all TODO items (@pxref{Global TODO list}). | |
6500 | @item m @r{/} M | |
6501 | Create a list of headlines matching a TAGS expression (@pxref{Matching | |
6502 | tags and properties}). | |
6503 | @item L | |
6504 | Create the timeline view for the current buffer (@pxref{Timeline}). | |
28a16a1b CD |
6505 | @item s |
6506 | Create a list of entries selected by a boolean expression of keywords | |
6507 | and/or regular expressions that must or must not occur in the entry. | |
dbc28aaa | 6508 | @item / |
c8d0cf5c | 6509 | @vindex org-agenda-text-search-extra-files |
dbc28aaa | 6510 | Search for a regular expression in all agenda files and additionally in |
c8d0cf5c | 6511 | the files listed in @code{org-agenda-text-search-extra-files}. This |
dbc28aaa CD |
6512 | uses the Emacs command @code{multi-occur}. A prefix argument can be |
6513 | used to specify the number of context lines for each match, default is | |
6514 | 1. | |
28a16a1b CD |
6515 | @item # @r{/} ! |
6516 | Create a list of stuck projects (@pxref{Stuck projects}). | |
dbc28aaa CD |
6517 | @item < |
6518 | Restrict an agenda command to the current buffer@footnote{For backward | |
6519 | compatibility, you can also press @kbd{1} to restrict to the current | |
6520 | buffer.}. After pressing @kbd{<}, you still need to press the character | |
6521 | selecting the command. | |
6522 | @item < < | |
4009494e | 6523 | If there is an active region, restrict the following agenda command to |
dbc28aaa CD |
6524 | the region. Otherwise, restrict it to the current subtree@footnote{For |
6525 | backward compatibility, you can also press @kbd{0} to restrict to the | |
c8d0cf5c | 6526 | current region/subtree.}. After pressing @kbd{< <}, you still need to press the |
dbc28aaa | 6527 | character selecting the command. |
4009494e GM |
6528 | @end table |
6529 | ||
6530 | You can also define custom commands that will be accessible through the | |
6531 | dispatcher, just like the default commands. This includes the | |
6532 | possibility to create extended agenda buffers that contain several | |
6533 | blocks together, for example the weekly agenda, the global TODO list and | |
6534 | a number of special tags matches. @xref{Custom agenda views}. | |
6535 | ||
a7808fba | 6536 | @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views |
4009494e GM |
6537 | @section The built-in agenda views |
6538 | ||
6539 | In this section we describe the built-in views. | |
6540 | ||
6541 | @menu | |
a7808fba | 6542 | * Weekly/daily agenda:: The calendar page with current tasks |
4009494e GM |
6543 | * Global TODO list:: All unfinished action items |
6544 | * Matching tags and properties:: Structured information with fine-tuned search | |
6545 | * Timeline:: Time-sorted view for single file | |
a351880d | 6546 | * Search view:: Find entries by searching for text |
4009494e GM |
6547 | * Stuck projects:: Find projects you need to review |
6548 | @end menu | |
6549 | ||
a7808fba | 6550 | @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views |
4009494e GM |
6551 | @subsection The weekly/daily agenda |
6552 | @cindex agenda | |
6553 | @cindex weekly agenda | |
6554 | @cindex daily agenda | |
6555 | ||
6556 | The purpose of the weekly/daily @emph{agenda} is to act like a page of a | |
6557 | paper agenda, showing all the tasks for the current week or day. | |
6558 | ||
6559 | @table @kbd | |
6560 | @cindex org-agenda, command | |
6561 | @kindex C-c a a | |
6562 | @item C-c a a | |
c8d0cf5c CD |
6563 | @vindex org-agenda-ndays |
6564 | Compile an agenda for the current week from a list of Org files. The agenda | |
864c9740 CD |
6565 | shows the entries for each day. With a numeric prefix@footnote{For backward |
6566 | compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be | |
6567 | listed before the agenda. This feature is deprecated, use the dedicated TODO | |
6568 | list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1 | |
6569 | C-c a a}) you may set the number of days to be displayed (see also the | |
6570 | variable @code{org-agenda-ndays}) | |
4009494e GM |
6571 | @end table |
6572 | ||
6573 | Remote editing from the agenda buffer means, for example, that you can | |
6574 | change the dates of deadlines and appointments from the agenda buffer. | |
6575 | The commands available in the Agenda buffer are listed in @ref{Agenda | |
6576 | commands}. | |
6577 | ||
6578 | @subsubheading Calendar/Diary integration | |
6579 | @cindex calendar integration | |
6580 | @cindex diary integration | |
6581 | ||
6582 | Emacs contains the calendar and diary by Edward M. Reingold. The | |
6583 | calendar displays a three-month calendar with holidays from different | |
6584 | countries and cultures. The diary allows you to keep track of | |
6585 | anniversaries, lunar phases, sunrise/set, recurrent appointments | |
6586 | (weekly, monthly) and more. In this way, it is quite complementary to | |
a7808fba | 6587 | Org. It can be very useful to combine output from Org with |
4009494e GM |
6588 | the diary. |
6589 | ||
a7808fba | 6590 | In order to include entries from the Emacs diary into Org mode's |
4009494e GM |
6591 | agenda, you only need to customize the variable |
6592 | ||
6593 | @lisp | |
6594 | (setq org-agenda-include-diary t) | |
6595 | @end lisp | |
6596 | ||
6597 | @noindent After that, everything will happen automatically. All diary | |
c8d0cf5c | 6598 | entries including holidays, anniversaries, etc., will be included in the |
a7808fba | 6599 | agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and |
4009494e GM |
6600 | @key{RET} can be used from the agenda buffer to jump to the diary |
6601 | file in order to edit existing diary entries. The @kbd{i} command to | |
6602 | insert new entries for the current date works in the agenda buffer, as | |
6603 | well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display | |
6604 | Sunrise/Sunset times, show lunar phases and to convert to other | |
6605 | calendars, respectively. @kbd{c} can be used to switch back and forth | |
6606 | between calendar and agenda. | |
6607 | ||
6608 | If you are using the diary only for sexp entries and holidays, it is | |
6609 | faster to not use the above setting, but instead to copy or even move | |
a7808fba | 6610 | the entries into an Org file. Org mode evaluates diary-style sexp |
4009494e GM |
6611 | entries, and does it faster because there is no overhead for first |
6612 | creating the diary display. Note that the sexp entries must start at | |
c8d0cf5c | 6613 | the left margin, no whitespace is allowed before them. For example, |
a7808fba | 6614 | the following segment of an Org file will be processed and entries |
4009494e GM |
6615 | will be made in the agenda: |
6616 | ||
6617 | @example | |
6618 | * Birthdays and similar stuff | |
6619 | #+CATEGORY: Holiday | |
6620 | %%(org-calendar-holiday) ; special function for holiday names | |
6621 | #+CATEGORY: Ann | |
6622 | %%(diary-anniversary 14 5 1956) Arthur Dent is %d years old | |
6623 | %%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old | |
6624 | @end example | |
6625 | ||
c8d0cf5c CD |
6626 | @subsubheading Anniversaries from BBDB |
6627 | @cindex BBDB, anniversaries | |
6628 | @cindex anniversaries, from BBDB | |
6629 | ||
6630 | If you are using the Big Brothers Database to store your contacts, you will | |
6631 | very likely prefer to store anniversaries in BBDB rather than in a | |
6632 | separate Org or diary file. Org supports this and will show BBDB | |
6633 | anniversaries as part of the agenda. All you need to do is to add the | |
6634 | following to one your your agenda files: | |
6635 | ||
6636 | @example | |
6637 | * Anniversaries | |
6638 | :PROPERTIES: | |
6639 | :CATEGORY: Anniv | |
6640 | :END | |
6641 | %%(org-bbdb-anniversaries) | |
6642 | @end example | |
6643 | ||
6644 | You can then go ahead and define anniversaries for a BBDB record. Basically, | |
6645 | you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB | |
6646 | record and then add the date in the format @code{YYYY-MM-DD}, followed by a | |
6647 | space and the class of the anniversary (@samp{birthday} or @samp{wedding}, or | |
6648 | a format string). If you omit the class, it will default to @samp{birthday}. | |
6649 | Here are a few examples, the header for the file @file{org-bbdb.el} contains | |
6650 | more detailed information. | |
6651 | ||
6652 | @example | |
6653 | 1973-06-22 | |
6654 | 1955-08-02 wedding | |
6655 | 2008-04-14 %s released version 6.01 of org-mode, %d years ago | |
6656 | @end example | |
6657 | ||
6658 | After a change to BBDB, or for the first agenda display during an Emacs | |
6659 | session, the agenda display will suffer a short delay as Org updates its | |
6660 | hash with anniversaries. However, from then on things will be very fast---much | |
6661 | faster in fact than a long list of @samp{%%(diary-anniversary)} entries | |
6662 | in an Org or Diary file. | |
6663 | ||
dbc28aaa CD |
6664 | @subsubheading Appointment reminders |
6665 | @cindex @file{appt.el} | |
6666 | @cindex appointment reminders | |
6667 | ||
c8d0cf5c CD |
6668 | Org can interact with Emacs appointments notification facility. To add all |
6669 | the appointments of your agenda files, use the command | |
6670 | @code{org-agenda-to-appt}. This command also lets you filter through the | |
6671 | list of your appointments and add only those belonging to a specific category | |
6672 | or matching a regular expression. See the docstring for details. | |
dbc28aaa | 6673 | |
a7808fba | 6674 | @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views |
4009494e GM |
6675 | @subsection The global TODO list |
6676 | @cindex global TODO list | |
6677 | @cindex TODO list, global | |
6678 | ||
c8d0cf5c | 6679 | The global TODO list contains all unfinished TODO items formatted and |
4009494e GM |
6680 | collected into a single place. |
6681 | ||
6682 | @table @kbd | |
6683 | @kindex C-c a t | |
6684 | @item C-c a t | |
6685 | Show the global TODO list. This collects the TODO items from all | |
a7808fba | 6686 | agenda files (@pxref{Agenda Views}) into a single buffer. The buffer is in |
4009494e GM |
6687 | @code{agenda-mode}, so there are commands to examine and manipulate |
6688 | the TODO entries directly from that buffer (@pxref{Agenda commands}). | |
6689 | @kindex C-c a T | |
6690 | @item C-c a T | |
6691 | @cindex TODO keyword matching | |
c8d0cf5c | 6692 | @vindex org-todo-keywords |
4009494e GM |
6693 | Like the above, but allows selection of a specific TODO keyword. You |
6694 | can also do this by specifying a prefix argument to @kbd{C-c a t}. With | |
6695 | a @kbd{C-u} prefix you are prompted for a keyword, and you may also | |
c8d0cf5c CD |
6696 | specify several keywords by separating them with @samp{|} as the boolean OR |
6697 | operator. With a numeric prefix, the nth keyword in | |
4009494e GM |
6698 | @code{org-todo-keywords} is selected. |
6699 | @kindex r | |
6700 | The @kbd{r} key in the agenda buffer regenerates it, and you can give | |
6701 | a prefix argument to this command to change the selected TODO keyword, | |
6702 | for example @kbd{3 r}. If you often need a search for a specific | |
6703 | keyword, define a custom command for it (@pxref{Agenda dispatcher}).@* | |
6704 | Matching specific TODO keywords can also be done as part of a tags | |
6705 | search (@pxref{Tag searches}). | |
6706 | @end table | |
6707 | ||
6708 | Remote editing of TODO items means that you can change the state of a | |
6709 | TODO entry with a single key press. The commands available in the | |
6710 | TODO list are described in @ref{Agenda commands}. | |
6711 | ||
a7808fba CD |
6712 | @cindex sublevels, inclusion into TODO list |
6713 | Normally the global TODO list simply shows all headlines with TODO | |
4009494e GM |
6714 | keywords. This list can become very long. There are two ways to keep |
6715 | it more compact: | |
6716 | @itemize @minus | |
6717 | @item | |
c8d0cf5c CD |
6718 | @vindex org-agenda-todo-ignore-scheduled |
6719 | @vindex org-agenda-todo-ignore-deadlines | |
6720 | @vindex org-agenda-todo-ignore-with-date | |
6721 | Some people view a TODO item that has been @emph{scheduled} for execution or | |
6722 | have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}. | |
6723 | Configure the variables @code{org-agenda-todo-ignore-scheduled}, | |
6724 | @code{org-agenda-todo-ignore-deadlines}, and/or | |
6725 | @code{org-agenda-todo-ignore-with-date} to exclude such items from the | |
6726 | global TODO list. | |
6727 | @item | |
6728 | @vindex org-agenda-todo-list-sublevels | |
4009494e GM |
6729 | TODO items may have sublevels to break up the task into subtasks. In |
6730 | such cases it may be enough to list only the highest level TODO headline | |
6731 | and omit the sublevels from the global list. Configure the variable | |
6732 | @code{org-agenda-todo-list-sublevels} to get this behavior. | |
6733 | @end itemize | |
6734 | ||
6735 | @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views | |
a7808fba | 6736 | @subsection Matching tags and properties |
4009494e GM |
6737 | @cindex matching, of tags |
6738 | @cindex matching, of properties | |
6739 | @cindex tags view | |
864c9740 | 6740 | @cindex match view |
4009494e | 6741 | |
c8d0cf5c CD |
6742 | If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}), |
6743 | or have properties (@pxref{Properties and Columns}), you can select headlines | |
6744 | based on this metadata and collect them into an agenda buffer. The match | |
6745 | syntax described here also applies when creating sparse trees with @kbd{C-c / | |
6746 | m}. | |
4009494e GM |
6747 | |
6748 | @table @kbd | |
6749 | @kindex C-c a m | |
6750 | @item C-c a m | |
6751 | Produce a list of all headlines that match a given set of tags. The | |
6752 | command prompts for a selection criterion, which is a boolean logic | |
dbc28aaa CD |
6753 | expression with tags, like @samp{+work+urgent-withboss} or |
6754 | @samp{work|home} (@pxref{Tags}). If you often need a specific search, | |
4009494e GM |
6755 | define a custom command for it (@pxref{Agenda dispatcher}). |
6756 | @kindex C-c a M | |
6757 | @item C-c a M | |
c8d0cf5c CD |
6758 | @vindex org-tags-match-list-sublevels |
6759 | @vindex org-agenda-tags-todo-honor-ignore-options | |
6760 | Like @kbd{C-c a m}, but only select headlines that are also TODO items and | |
6761 | force checking subitems (see variable @code{org-tags-match-list-sublevels}). | |
6762 | To exclude scheduled/deadline items, see the variable | |
6763 | @code{org-agenda-tags-todo-honor-ignore-options}. Matching specific TODO | |
6764 | keywords together with a tags match is also possible, see @ref{Tag searches}. | |
4009494e GM |
6765 | @end table |
6766 | ||
6767 | The commands available in the tags list are described in @ref{Agenda | |
6768 | commands}. | |
6769 | ||
c8d0cf5c | 6770 | @subsubheading Match syntax |
4009494e | 6771 | |
c8d0cf5c CD |
6772 | @cindex Boolean logic, for tag/property searches |
6773 | A search string can use Boolean operators @samp{&} for AND and @samp{|} for | |
6774 | OR. @samp{&} binds more strongly than @samp{|}. Parentheses are currently | |
6775 | not implemented. Each element in the search is either a tag, a regular | |
6776 | expression matching tags, or an expression like @code{PROPERTY OPERATOR | |
6777 | VALUE} with a comparison operator, accessing a property value. Each element | |
6778 | may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic | |
6779 | sugar for positive selection. The AND operator @samp{&} is optional when | |
6780 | @samp{+} or @samp{-} is present. Here are some examples, using only tags. | |
4009494e | 6781 | |
c8d0cf5c CD |
6782 | @table @samp |
6783 | @item +work-boss | |
6784 | Select headlines tagged @samp{:work:}, but discard those also tagged | |
6785 | @samp{:boss:}. | |
6786 | @item work|laptop | |
6787 | Selects lines tagged @samp{:work:} or @samp{:laptop:}. | |
6788 | @item work|laptop+night | |
6789 | Like before, but require the @samp{:laptop:} lines to be tagged also | |
6790 | @samp{:night:}. | |
4009494e GM |
6791 | @end table |
6792 | ||
c8d0cf5c CD |
6793 | @cindex regular expressions, with tags search |
6794 | Instead of a tag, you may also specify a regular expression enclosed in curly | |
6795 | braces. For example, | |
6796 | @samp{work+@{^boss.*@}} matches headlines that contain the tag | |
6797 | @samp{:work:} and any tag @i{starting} with @samp{boss}. | |
6798 | ||
6799 | @cindex TODO keyword matching, with tags search | |
6800 | @cindex level, require for tags/property match | |
6801 | @cindex category, require for tags/property match | |
6802 | @vindex org-odd-levels-only | |
6803 | You may also test for properties (@pxref{Properties and Columns}) at the same | |
6804 | time as matching tags. The properties may be real properties, or special | |
6805 | properties that represent other metadata (@pxref{Special properties}). For | |
6806 | example, the ``property'' @code{TODO} represents the TODO keyword of the | |
6807 | entry. Or, the ``property'' @code{LEVEL} represents the level of an entry. | |
6808 | So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines | |
6809 | that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword | |
6810 | DONE. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not | |
6811 | count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc. | |
6812 | ||
6813 | Here are more examples: | |
6814 | @table @samp | |
6815 | @item work+TODO="WAITING" | |
6816 | Select @samp{:work:}-tagged TODO lines with the specific TODO | |
6817 | keyword @samp{WAITING}. | |
6818 | @item work+TODO="WAITING"|home+TODO="WAITING" | |
6819 | Waiting tasks both at work and at home. | |
6820 | @end table | |
6821 | ||
6822 | When matching properties, a number of different operators can be used to test | |
6823 | the value of a property. Here is a complex example: | |
6824 | ||
6825 | @example | |
6826 | +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \ | |
6827 | +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>" | |
6828 | @end example | |
6829 | ||
6830 | @noindent | |
6831 | The type of comparison will depend on how the comparison value is written: | |
6832 | @itemize @minus | |
6833 | @item | |
6834 | If the comparison value is a plain number, a numerical comparison is done, | |
6835 | and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=}, | |
6836 | @samp{>=}, and @samp{<>}. | |
6837 | @item | |
6838 | If the comparison value is enclosed in double-quotes, | |
6839 | a string comparison is done, and the same operators are allowed. | |
6840 | @item | |
6841 | If the comparison value is enclosed in double-quotes @emph{and} angular | |
6842 | brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are | |
6843 | assumed to be date/time specifications in the standard Org way, and the | |
6844 | comparison will be done accordingly. Special values that will be recognized | |
6845 | are @code{"<now>"} for now (including time), and @code{"<today>"}, and | |
a351880d | 6846 | @code{"<tomorrow>"} for these days at 0:00 hours, i.e. without a time |
c8d0cf5c CD |
6847 | specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units |
6848 | @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year, | |
6849 | respectively, can be used. | |
6850 | @item | |
6851 | If the comparison value is enclosed | |
6852 | in curly braces, a regexp match is performed, with @samp{=} meaning that the | |
6853 | regexp matches the property value, and @samp{<>} meaning that it does not | |
6854 | match. | |
6855 | @end itemize | |
6856 | ||
6857 | So the search string in the example finds entries tagged @samp{:work:} but | |
6858 | not @samp{:boss:}, which also have a priority value @samp{A}, a | |
6859 | @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort} | |
6860 | property that is numerically smaller than 2, a @samp{:With:} property that is | |
6861 | matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled | |
6862 | on or after October 11, 2008. | |
6863 | ||
6864 | Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any | |
6865 | other properties will slow down the search. However, once you have paid the | |
6866 | price by accessing one property, testing additional properties is cheap | |
6867 | again. | |
6868 | ||
6869 | You can configure Org mode to use property inheritance during a search, but | |
6870 | beware that this can slow down searches considerably. See @ref{Property | |
6871 | inheritance}, for details. | |
6872 | ||
6873 | For backward compatibility, and also for typing speed, there is also a | |
6874 | different way to test TODO states in a search. For this, terminate the | |
6875 | tags/property part of the search string (which may include several terms | |
6876 | connected with @samp{|}) with a @samp{/} and then specify a Boolean | |
6877 | expression just for TODO keywords. The syntax is then similar to that for | |
6878 | tags, but should be applied with care: for example, a positive | |
6879 | selection on several TODO keywords cannot meaningfully be combined with | |
6880 | boolean AND. However, @emph{negative selection} combined with AND can be | |
6881 | meaningful. To make sure that only lines are checked that actually have any | |
6882 | TODO keyword (resulting in a speed-up), use @kbd{C-c a M}, or equivalently | |
6883 | start the TODO part after the slash with @samp{!}. Examples: | |
6884 | ||
6885 | @table @samp | |
6886 | @item work/WAITING | |
6887 | Same as @samp{work+TODO="WAITING"} | |
6888 | @item work/!-WAITING-NEXT | |
6889 | Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING} | |
6890 | nor @samp{NEXT} | |
6891 | @item work/!+WAITING|+NEXT | |
6892 | Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or | |
6893 | @samp{NEXT}. | |
6894 | @end table | |
6895 | ||
a351880d | 6896 | @node Timeline, Search view, Matching tags and properties, Built-in agenda views |
c8d0cf5c CD |
6897 | @subsection Timeline for a single file |
6898 | @cindex timeline, single file | |
6899 | @cindex time-sorted view | |
6900 | ||
6901 | The timeline summarizes all time-stamped items from a single Org mode | |
6902 | file in a @emph{time-sorted view}. The main purpose of this command is | |
6903 | to give an overview over events in a project. | |
6904 | ||
6905 | @table @kbd | |
6906 | @kindex C-c a L | |
6907 | @item C-c a L | |
6908 | Show a time-sorted view of the Org file, with all time-stamped items. | |
6909 | When called with a @kbd{C-u} prefix, all unfinished TODO entries | |
6910 | (scheduled or not) are also listed under the current date. | |
6911 | @end table | |
6912 | ||
6913 | @noindent | |
6914 | The commands available in the timeline buffer are listed in | |
6915 | @ref{Agenda commands}. | |
6916 | ||
a351880d CD |
6917 | @node Search view, Stuck projects, Timeline, Built-in agenda views |
6918 | @subsection Search view | |
6919 | @cindex search view | |
6920 | @cindex text search | |
6921 | @cindex searching, for text | |
c8d0cf5c CD |
6922 | |
6923 | This agenda view is a general text search facility for Org mode entries. | |
6924 | It is particularly useful to find notes. | |
28a16a1b CD |
6925 | |
6926 | @table @kbd | |
6927 | @kindex C-c a s | |
6928 | @item C-c a s | |
a351880d CD |
6929 | This is a special search that lets you select entries by matching a substring |
6930 | or specific words using a boolean logic. | |
6931 | @end table | |
6932 | For example, the search string @samp{computer equipment} will find entries | |
6933 | that contain @samp{computer equipment} as a substring. If the two words are | |
6934 | separated by more space or a line break, the search will still match. | |
6935 | Search view can also search for specific keywords in the entry, using Boolean | |
6936 | logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}} | |
28a16a1b CD |
6937 | will search for note entries that contain the keywords @code{computer} |
6938 | and @code{wifi}, but not the keyword @code{ethernet}, and which are also | |
6939 | not matched by the regular expression @code{8\.11[bg]}, meaning to | |
6940 | exclude both 8.11b and 8.11g. | |
6941 | ||
c8d0cf5c | 6942 | @vindex org-agenda-text-search-extra-files |
28a16a1b CD |
6943 | Note that in addition to the agenda files, this command will also search |
6944 | the files listed in @code{org-agenda-text-search-extra-files}. | |
28a16a1b | 6945 | |
a351880d | 6946 | @node Stuck projects, , Search view, Built-in agenda views |
4009494e GM |
6947 | @subsection Stuck projects |
6948 | ||
6949 | If you are following a system like David Allen's GTD to organize your | |
6950 | work, one of the ``duties'' you have is a regular review to make sure | |
6951 | that all projects move along. A @emph{stuck} project is a project that | |
6952 | has no defined next actions, so it will never show up in the TODO lists | |
a7808fba | 6953 | Org mode produces. During the review, you need to identify such |
4009494e GM |
6954 | projects and define next actions for them. |
6955 | ||
6956 | @table @kbd | |
6957 | @kindex C-c a # | |
6958 | @item C-c a # | |
6959 | List projects that are stuck. | |
6960 | @kindex C-c a ! | |
6961 | @item C-c a ! | |
c8d0cf5c | 6962 | @vindex org-stuck-projects |
4009494e GM |
6963 | Customize the variable @code{org-stuck-projects} to define what a stuck |
6964 | project is and how to find it. | |
6965 | @end table | |
6966 | ||
6967 | You almost certainly will have to configure this view before it will | |
6968 | work for you. The built-in default assumes that all your projects are | |
6969 | level-2 headlines, and that a project is not stuck if it has at least | |
a7808fba | 6970 | one entry marked with a TODO keyword TODO or NEXT or NEXTACTION. |
4009494e | 6971 | |
864c9740 | 6972 | Let's assume that you, in your own way of using Org mode, identify |
a7808fba | 6973 | projects with a tag PROJECT, and that you use a TODO keyword MAYBE to |
864c9740 | 6974 | indicate a project that should not be considered yet. Let's further |
a7808fba | 6975 | assume that the TODO keyword DONE marks finished projects, and that NEXT |
4009494e GM |
6976 | and TODO indicate next actions. The tag @@SHOP indicates shopping and |
6977 | is a next action even without the NEXT tag. Finally, if the project | |
6978 | contains the special word IGNORE anywhere, it should not be listed | |
6979 | either. In this case you would start by identifying eligible projects | |
c8d0cf5c CD |
6980 | with a tags/todo match@footnote{@xref{Tag searches}.} |
6981 | @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and | |
6982 | IGNORE in the subtree to identify projects that are not stuck. The | |
6983 | correct customization for this is | |
4009494e GM |
6984 | |
6985 | @lisp | |
6986 | (setq org-stuck-projects | |
6987 | '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP") | |
6988 | "\\<IGNORE\\>")) | |
6989 | @end lisp | |
6990 | ||
c8d0cf5c CD |
6991 | Note that if a project is identified as non-stuck, the subtree of this entry |
6992 | will still be searched for stuck projects. | |
4009494e | 6993 | |
a7808fba | 6994 | @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views |
4009494e GM |
6995 | @section Presentation and sorting |
6996 | @cindex presentation, of agenda items | |
6997 | ||
c8d0cf5c | 6998 | @vindex org-agenda-prefix-format |
a7808fba | 6999 | Before displaying items in an agenda view, Org mode visually prepares |
4009494e GM |
7000 | the items and sorts them. Each item occupies a single line. The line |
7001 | starts with a @emph{prefix} that contains the @emph{category} | |
7002 | (@pxref{Categories}) of the item and other important information. You can | |
7003 | customize the prefix using the option @code{org-agenda-prefix-format}. | |
7004 | The prefix is followed by a cleaned-up version of the outline headline | |
7005 | associated with the item. | |
7006 | ||
7007 | @menu | |
7008 | * Categories:: Not all tasks are equal | |
7009 | * Time-of-day specifications:: How the agenda knows the time | |
7010 | * Sorting of agenda items:: The order of things | |
7011 | @end menu | |
7012 | ||
7013 | @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting | |
7014 | @subsection Categories | |
7015 | ||
7016 | @cindex category | |
7017 | The category is a broad label assigned to each agenda item. By default, | |
7018 | the category is simply derived from the file name, but you can also | |
dbc28aaa | 7019 | specify it with a special line in the buffer, like this@footnote{For |
c8d0cf5c | 7020 | backward compatibility, the following also works: if there are several |
dbc28aaa CD |
7021 | such lines in a file, each specifies the category for the text below it. |
7022 | The first category also applies to any text before the first CATEGORY | |
7023 | line. However, using this method is @emph{strongly} deprecated as it is | |
7024 | incompatible with the outline structure of the document. The correct | |
7025 | method for setting multiple categories in a buffer is using a | |
7026 | property.}: | |
4009494e GM |
7027 | |
7028 | @example | |
7029 | #+CATEGORY: Thesis | |
7030 | @end example | |
7031 | ||
dbc28aaa | 7032 | @noindent |
c8d0cf5c | 7033 | @cindex property, CATEGORY |
dbc28aaa | 7034 | If you would like to have a special CATEGORY for a single entry or a |
55e0839d CD |
7035 | (sub)tree, give the entry a @code{:CATEGORY:} property with the |
7036 | special category you want to apply as the value. | |
dbc28aaa CD |
7037 | |
7038 | @noindent | |
7039 | The display in the agenda buffer looks best if the category is not | |
7040 | longer than 10 characters. | |
4009494e GM |
7041 | |
7042 | @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting | |
a7808fba | 7043 | @subsection Time-of-day specifications |
4009494e GM |
7044 | @cindex time-of-day specification |
7045 | ||
a7808fba | 7046 | Org mode checks each agenda item for a time-of-day specification. The |
c8d0cf5c | 7047 | time can be part of the timestamp that triggered inclusion into the |
4009494e | 7048 | agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time |
c8d0cf5c | 7049 | ranges can be specified with two timestamps, like |
4009494e GM |
7050 | @c |
7051 | @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}. | |
7052 | ||
7053 | In the headline of the entry itself, a time(range) may also appear as | |
44ce9197 | 7054 | plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda |
a7808fba | 7055 | integrates the Emacs diary (@pxref{Weekly/daily agenda}), time |
4009494e GM |
7056 | specifications in diary entries are recognized as well. |
7057 | ||
a7808fba | 7058 | For agenda display, Org mode extracts the time and displays it in a |
4009494e GM |
7059 | standard 24 hour format as part of the prefix. The example times in |
7060 | the previous paragraphs would end up in the agenda like this: | |
7061 | ||
7062 | @example | |
7063 | 8:30-13:00 Arthur Dent lies in front of the bulldozer | |
7064 | 12:45...... Ford Prefect arrives and takes Arthur to the pub | |
7065 | 19:00...... The Vogon reads his poem | |
a50253cc | 7066 | 20:30-22:15 Marvin escorts the Hitchhikers to the bridge |
4009494e GM |
7067 | @end example |
7068 | ||
7069 | @cindex time grid | |
7070 | If the agenda is in single-day mode, or for the display of today, the | |
7071 | timed entries are embedded in a time grid, like | |
7072 | ||
7073 | @example | |
7074 | 8:00...... ------------------ | |
7075 | 8:30-13:00 Arthur Dent lies in front of the bulldozer | |
7076 | 10:00...... ------------------ | |
7077 | 12:00...... ------------------ | |
7078 | 12:45...... Ford Prefect arrives and takes Arthur to the pub | |
7079 | 14:00...... ------------------ | |
7080 | 16:00...... ------------------ | |
7081 | 18:00...... ------------------ | |
7082 | 19:00...... The Vogon reads his poem | |
7083 | 20:00...... ------------------ | |
2096a1b6 | 7084 | 20:30-22:15 Marvin escorts the Hitchhikers to the bridge |
4009494e GM |
7085 | @end example |
7086 | ||
c8d0cf5c CD |
7087 | @vindex org-agenda-use-time-grid |
7088 | @vindex org-agenda-time-grid | |
4009494e GM |
7089 | The time grid can be turned on and off with the variable |
7090 | @code{org-agenda-use-time-grid}, and can be configured with | |
7091 | @code{org-agenda-time-grid}. | |
7092 | ||
7093 | @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting | |
7094 | @subsection Sorting of agenda items | |
7095 | @cindex sorting, of agenda items | |
7096 | @cindex priorities, of agenda items | |
7097 | Before being inserted into a view, the items are sorted. How this is | |
7098 | done depends on the type of view. | |
7099 | @itemize @bullet | |
7100 | @item | |
c8d0cf5c | 7101 | @vindex org-agenda-files |
4009494e GM |
7102 | For the daily/weekly agenda, the items for each day are sorted. The |
7103 | default order is to first collect all items containing an explicit | |
7104 | time-of-day specification. These entries will be shown at the beginning | |
7105 | of the list, as a @emph{schedule} for the day. After that, items remain | |
7106 | grouped in categories, in the sequence given by @code{org-agenda-files}. | |
7107 | Within each category, items are sorted by priority (@pxref{Priorities}), | |
7108 | which is composed of the base priority (2000 for priority @samp{A}, 1000 | |
7109 | for @samp{B}, and 0 for @samp{C}), plus additional increments for | |
7110 | overdue scheduled or deadline items. | |
28a16a1b | 7111 | @item |
4009494e GM |
7112 | For the TODO list, items remain in the order of categories, but within |
7113 | each category, sorting takes place according to priority | |
c8d0cf5c CD |
7114 | (@pxref{Priorities}). The priority used for sorting derives from the |
7115 | priority cookie, with additions depending on how close an item is to its due | |
7116 | or scheduled date. | |
4009494e GM |
7117 | @item |
7118 | For tags matches, items are not sorted at all, but just appear in the | |
7119 | sequence in which they are found in the agenda files. | |
7120 | @end itemize | |
7121 | ||
c8d0cf5c | 7122 | @vindex org-agenda-sorting-strategy |
4009494e | 7123 | Sorting can be customized using the variable |
a7808fba | 7124 | @code{org-agenda-sorting-strategy}, and may also include criteria based on |
71d35b24 | 7125 | the estimated effort of an entry (@pxref{Effort estimates}). |
4009494e | 7126 | |
a7808fba | 7127 | @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views |
4009494e GM |
7128 | @section Commands in the agenda buffer |
7129 | @cindex commands, in agenda buffer | |
7130 | ||
c8d0cf5c | 7131 | Entries in the agenda buffer are linked back to the Org file or diary |
4009494e GM |
7132 | file where they originate. You are not allowed to edit the agenda |
7133 | buffer itself, but commands are provided to show and jump to the | |
c8d0cf5c | 7134 | original entry location, and to edit the Org files ``remotely'' from |
4009494e GM |
7135 | the agenda buffer. In this way, all information is stored only once, |
7136 | removing the risk that your agenda and note files may diverge. | |
7137 | ||
7138 | Some commands can be executed with mouse clicks on agenda lines. For | |
7139 | the other commands, the cursor needs to be in the desired line. | |
7140 | ||
7141 | @table @kbd | |
7142 | @tsubheading{Motion} | |
7143 | @cindex motion commands in agenda | |
7144 | @kindex n | |
7145 | @item n | |
dbc28aaa | 7146 | Next line (same as @key{up} and @kbd{C-p}). |
4009494e GM |
7147 | @kindex p |
7148 | @item p | |
dbc28aaa | 7149 | Previous line (same as @key{down} and @kbd{C-n}). |
c8d0cf5c | 7150 | @tsubheading{View/Go to Org file} |
4009494e GM |
7151 | @kindex mouse-3 |
7152 | @kindex @key{SPC} | |
7153 | @item mouse-3 | |
7154 | @itemx @key{SPC} | |
7155 | Display the original location of the item in another window. | |
b6cb4cd5 CD |
7156 | With prefix arg, make sure that the entire entry is made visible in the |
7157 | outline, not only the heading. | |
4009494e GM |
7158 | @c |
7159 | @kindex L | |
7160 | @item L | |
7161 | Display original location and recenter that window. | |
7162 | @c | |
7163 | @kindex mouse-2 | |
7164 | @kindex mouse-1 | |
7165 | @kindex @key{TAB} | |
7166 | @item mouse-2 | |
7167 | @itemx mouse-1 | |
7168 | @itemx @key{TAB} | |
7169 | Go to the original location of the item in another window. Under Emacs | |
7170 | 22, @kbd{mouse-1} will also works for this. | |
7171 | @c | |
7172 | @kindex @key{RET} | |
7173 | @itemx @key{RET} | |
7174 | Go to the original location of the item and delete other windows. | |
7175 | @c | |
6eb02347 CD |
7176 | @kindex F |
7177 | @item F | |
c8d0cf5c | 7178 | @vindex org-agenda-start-with-follow-mode |
4009494e GM |
7179 | Toggle Follow mode. In Follow mode, as you move the cursor through |
7180 | the agenda buffer, the other window always shows the corresponding | |
c8d0cf5c | 7181 | location in the Org file. The initial setting for this mode in new |
4009494e GM |
7182 | agenda buffers can be set with the variable |
7183 | @code{org-agenda-start-with-follow-mode}. | |
7184 | @c | |
6eb02347 CD |
7185 | @kindex C-c C-x b |
7186 | @item C-c C-x b | |
a7808fba CD |
7187 | Display the entire subtree of the current item in an indirect buffer. With a |
7188 | numeric prefix argument N, go up to level N and then take that tree. If N is | |
7189 | negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the | |
7190 | previously used indirect buffer. | |
6eb02347 CD |
7191 | |
7192 | @kindex C-c C-o | |
7193 | @item C-c C-o | |
7194 | Follow a link in the entry. This will offer a selection of any links in the | |
7195 | text belonging to the referenced Org node. If there is only one link, it | |
7196 | will be followed without a selection prompt. | |
4009494e GM |
7197 | |
7198 | @tsubheading{Change display} | |
7199 | @cindex display changing, in agenda | |
7200 | @kindex o | |
7201 | @item o | |
7202 | Delete other windows. | |
7203 | @c | |
c8d0cf5c | 7204 | @kindex v d |
4009494e | 7205 | @kindex d |
c8d0cf5c | 7206 | @kindex v w |
4009494e | 7207 | @kindex w |
c8d0cf5c CD |
7208 | @kindex v m |
7209 | @kindex v y | |
7210 | @item v d @ @r{or short} @ d | |
7211 | @itemx v w @ @r{or short} @ w | |
7212 | @itemx v m | |
7213 | @itemx v y | |
4009494e | 7214 | Switch to day/week/month/year view. When switching to day or week view, |
a7808fba CD |
7215 | this setting becomes the default for subsequent agenda commands. Since |
7216 | month and year views are slow to create, they do not become the default. | |
7217 | A numeric prefix argument may be used to jump directly to a specific day | |
7218 | of the year, ISO week, month, or year, respectively. For example, | |
7219 | @kbd{32 d} jumps to February 1st, @kbd{9 w} to ISO week number 9. When | |
7220 | setting day, week, or month view, a year may be encoded in the prefix | |
7221 | argument as well. For example, @kbd{200712 w} will jump to week 12 in | |
7222 | 2007. If such a year specification has only one or two digits, it will | |
7223 | be mapped to the interval 1938-2037. | |
4009494e | 7224 | @c |
6eb02347 CD |
7225 | @kindex f |
7226 | @item f | |
7227 | @vindex org-agenda-ndays | |
7228 | Go forward in time to display the following @code{org-agenda-ndays} days. | |
7229 | For example, if the display covers a week, switch to the following week. | |
7230 | With prefix arg, go forward that many times @code{org-agenda-ndays} days. | |
7231 | @c | |
7232 | @kindex b | |
7233 | @item b | |
7234 | Go backward in time to display earlier dates. | |
7235 | @c | |
7236 | @kindex . | |
7237 | @item . | |
7238 | Go to today. | |
7239 | @c | |
7240 | @kindex j | |
7241 | @item j | |
7242 | Prompt for a date and go there. | |
7243 | @c | |
4009494e GM |
7244 | @kindex D |
7245 | @item D | |
a7808fba | 7246 | Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}. |
4009494e | 7247 | @c |
6eb02347 CD |
7248 | @kindex v l |
7249 | @kindex l | |
7250 | @item v l @ @r{or short} @ l | |
7251 | @vindex org-log-done | |
7252 | @vindex org-agenda-log-mode-items | |
7253 | Toggle Logbook mode. In Logbook mode, entries that were marked DONE while | |
7254 | logging was on (variable @code{org-log-done}) are shown in the agenda, as are | |
7255 | entries that have been clocked on that day. You can configure the entry | |
7256 | types that should be included in log mode using the variable | |
7257 | @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show | |
7258 | all possible logbook entries, including state changes. When called with two | |
7259 | prefix args @kbd{C-u C-u}, show only logging information, nothing else. | |
7260 | @c | |
7261 | @kindex v [ | |
7262 | @kindex [ | |
7263 | @item v [ @ @r{or short} @ [ | |
7264 | Include inactive timestamps into the current view. Only for weekly/daily | |
7265 | agenda and timeline views. | |
7266 | @c | |
7267 | @kindex v a | |
7268 | @kindex v A | |
7269 | @item v a | |
7270 | @itemx v A | |
7271 | Toggle Archives mode. In Archives mode, trees that are marked | |
7272 | @code{ARCHIVED} are also scanned when producing the agenda. When you use the | |
7273 | capital @kbd{A}, even all archive files are included. To exit archives mode, | |
7274 | press @kbd{v a} again. | |
7275 | @c | |
7276 | @kindex v R | |
7277 | @kindex R | |
7278 | @item v R @ @r{or short} @ R | |
7279 | @vindex org-agenda-start-with-clockreport-mode | |
7280 | Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will | |
7281 | always show a table with the clocked times for the timespan and file scope | |
7282 | covered by the current agenda view. The initial setting for this mode in new | |
7283 | agenda buffers can be set with the variable | |
7284 | @code{org-agenda-start-with-clockreport-mode}. | |
7285 | @c | |
7286 | @kindex v E | |
7287 | @kindex E | |
7288 | @item v E @ @r{or short} @ E | |
7289 | @vindex org-agenda-start-with-entry-text-mode | |
7290 | @vindex org-agenda-entry-text-maxlines | |
7291 | Toggle entry text mode. In entry text mode, a number of lines from the Org | |
7292 | outline node referenced by an agenda line will be displayed below the line. | |
7293 | The maximum number of lines is given by the variable | |
7294 | @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric | |
7295 | prefix argument will temporarily modify that number to the prefix value. | |
7296 | @c | |
28a16a1b CD |
7297 | @kindex G |
7298 | @item G | |
c8d0cf5c CD |
7299 | @vindex org-agenda-use-time-grid |
7300 | @vindex org-agenda-time-grid | |
4009494e GM |
7301 | Toggle the time grid on and off. See also the variables |
7302 | @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}. | |
7303 | @c | |
7304 | @kindex r | |
7305 | @item r | |
560bb6ea | 7306 | Recreate the agenda buffer, for example to reflect the changes after |
3bcfba17 | 7307 | modification of the timestamps of items with @kbd{S-@key{left}} and |
560bb6ea | 7308 | @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix |
4009494e GM |
7309 | argument is interpreted to create a selective list for a specific TODO |
7310 | keyword. | |
28a16a1b CD |
7311 | @kindex g |
7312 | @item g | |
7313 | Same as @kbd{r}. | |
4009494e GM |
7314 | @c |
7315 | @kindex s | |
dbc28aaa | 7316 | @kindex C-x C-s |
4009494e | 7317 | @item s |
dbc28aaa | 7318 | @itemx C-x C-s |
c8d0cf5c CD |
7319 | Save all Org buffers in the current Emacs session, and also the locations of |
7320 | IDs. | |
4009494e | 7321 | @c |
a7808fba CD |
7322 | @kindex C-c C-x C-c |
7323 | @item C-c C-x C-c | |
c8d0cf5c | 7324 | @vindex org-columns-default-format |
a7808fba CD |
7325 | Invoke column view (@pxref{Column view}) in the agenda buffer. The column |
7326 | view format is taken from the entry at point, or (if there is no entry at | |
7327 | point), from the first entry in the agenda view. So whatever the format for | |
7328 | that entry would be in the original buffer (taken from a property, from a | |
7329 | @code{#+COLUMNS} line, or from the default variable | |
7330 | @code{org-columns-default-format}), will be used in the agenda. | |
4009494e | 7331 | |
c8d0cf5c CD |
7332 | @kindex C-c C-x > |
7333 | @item C-c C-x > | |
7334 | Remove the restriction lock on the agenda, if it is currently restricted to a | |
7335 | file or subtree (@pxref{Agenda files}). | |
7336 | ||
864c9740 | 7337 | @tsubheading{Secondary filtering and query editing} |
71d35b24 CD |
7338 | @cindex filtering, by tag and effort, in agenda |
7339 | @cindex tag filtering, in agenda | |
7340 | @cindex effort filtering, in agenda | |
28a16a1b CD |
7341 | @cindex query editing, in agenda |
7342 | ||
864c9740 CD |
7343 | @kindex / |
7344 | @item / | |
c8d0cf5c | 7345 | @vindex org-agenda-filter-preset |
71d35b24 | 7346 | Filter the current agenda view with respect to a tag and/or effort estimates. |
c8d0cf5c | 7347 | The difference between this and a custom agenda command is that filtering is |
71d35b24 | 7348 | very fast, so that you can switch quickly between different filters without |
c8d0cf5c CD |
7349 | having to recreate the agenda@footnote{Custom commands can preset a filter by |
7350 | binding the variable @code{org-agenda-filter-preset} as an option. This | |
7351 | filter will then be applied to the view and persist as a basic filter through | |
7352 | refreshes and more secondary filtering.} | |
71d35b24 | 7353 | |
a351880d CD |
7354 | You will be prompted for a tag selection letter, SPC will mean any tag at |
7355 | all. Pressing @key{TAB} at that prompt will offer use completion to select a | |
7356 | tag (including any tags that do not have a selection character). The command | |
7357 | then hides all entries that do not contain or inherit this tag. When called | |
7358 | with prefix arg, remove the entries that @emph{do} have the tag. A second | |
7359 | @kbd{/} at the prompt will turn off the filter and unhide any hidden entries. | |
7360 | If the first key you press is either @kbd{+} or @kbd{-}, the previous filter | |
7361 | will be narrowed by requiring or forbidding the selected additional tag. | |
7362 | Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also | |
7363 | immediately use the @kbd{\} command. | |
71d35b24 | 7364 | |
c8d0cf5c | 7365 | @vindex org-sort-agenda-noeffort-is-high |
71d35b24 CD |
7366 | In order to filter for effort estimates, you should set-up allowed |
7367 | efforts globally, for example | |
7368 | @lisp | |
7369 | (setq org-global-properties | |
7370 | '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00"))) | |
7371 | @end lisp | |
c8d0cf5c CD |
7372 | You can then filter for an effort by first typing an operator, one of |
7373 | @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort | |
7374 | estimate in your array of allowed values, where @kbd{0} means the 10th value. | |
7375 | The filter will then restrict to entries with effort smaller-or-equal, equal, | |
7376 | or larger-or-equal than the selected value. If the digits 0-9 are not used | |
7377 | as fast access keys to tags, you can also simply press the index digit | |
7378 | directly without an operator. In this case, @kbd{<} will be assumed. For | |
7379 | application of the operator, entries without a defined effort will be treated | |
7380 | according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter | |
7381 | for tasks without effort definition, press @kbd{?} as the operator. | |
71d35b24 | 7382 | |
a351880d CD |
7383 | Org also supports automatic, context-aware tag filtering. If the variable |
7384 | @code{org-agenda-auto-exclude-function} is set to a user-defined function, | |
7385 | that function can decide which tags should be excluded from the agenda | |
7386 | automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET} | |
7387 | as a sub-option key and runs the auto exclusion logic. For example, let's | |
7388 | say you use a @code{Net} tag to identify tasks which need network access, an | |
7389 | @code{Errand} tag for errands in town, and a @code{Call} tag for making phone | |
7390 | calls. You could auto-exclude these tags based on the availability of the | |
7391 | Internet, and outside of business hours, with something like this: | |
7392 | ||
7393 | @lisp | |
7394 | @group | |
7395 | (defun org-my-auto-exclude-function (tag) | |
7396 | (and (cond | |
9360256a GM |
7397 | ((string= tag "Net") |
7398 | (/= 0 (call-process "/sbin/ping" nil nil nil | |
7399 | "-c1" "-q" "-t1" "mail.gnu.org"))) | |
7400 | ((or (string= tag "Errand") (string= tag "Call")) | |
7401 | (let ((hour (nth 2 (decode-time)))) | |
7402 | (or (< hour 8) (> hour 21))))) | |
a351880d CD |
7403 | (concat "-" tag))) |
7404 | ||
7405 | (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function) | |
7406 | @end group | |
7407 | @end lisp | |
7408 | ||
71d35b24 CD |
7409 | @kindex \ |
7410 | @item \ | |
7411 | Narrow the current agenda filter by an additional condition. When called with | |
7412 | prefix arg, remove the entries that @emph{do} have the tag, or that do match | |
7413 | the effort criterion. You can achieve the same effect by pressing @kbd{+} or | |
7414 | @kbd{-} as the first key after the @kbd{/} command. | |
864c9740 | 7415 | |
28a16a1b CD |
7416 | @kindex [ |
7417 | @kindex ] | |
7418 | @kindex @{ | |
7419 | @kindex @} | |
7420 | @item [ ] @{ @} | |
6eb02347 CD |
7421 | @table @i |
7422 | @item @r{in} search view | |
7423 | add new search words (@kbd{[} and @kbd{]}) or new regular expressions | |
7424 | (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will | |
7425 | add a positive search term prefixed by @samp{+}, indicating that this search | |
7426 | term @i{must} occur/match in the entry. The closing bracket/brace will add a | |
7427 | negative search term which @i{must not} occur/match in the entry for it to be | |
864c9740 | 7428 | selected. |
6eb02347 | 7429 | @end table |
28a16a1b | 7430 | |
a351880d | 7431 | @page |
4009494e GM |
7432 | @tsubheading{Remote editing} |
7433 | @cindex remote editing, from agenda | |
7434 | ||
7435 | @item 0-9 | |
7436 | Digit argument. | |
7437 | @c | |
7438 | @cindex undoing remote-editing events | |
7439 | @cindex remote editing, undo | |
7440 | @kindex C-_ | |
7441 | @item C-_ | |
7442 | Undo a change due to a remote editing command. The change is undone | |
7443 | both in the agenda buffer and in the remote buffer. | |
7444 | @c | |
7445 | @kindex t | |
7446 | @item t | |
7447 | Change the TODO state of the item, both in the agenda and in the | |
7448 | original org file. | |
7449 | @c | |
a351880d CD |
7450 | @kindex C-S-@key{right} |
7451 | @kindex C-S-@key{left} | |
7452 | @item C-S-@key{right}@r{/}@key{left} | |
7453 | Switch to the next/previous set of TODO keywords. | |
7454 | @c | |
4009494e GM |
7455 | @kindex C-k |
7456 | @item C-k | |
c8d0cf5c | 7457 | @vindex org-agenda-confirm-kill |
4009494e | 7458 | Delete the current agenda item along with the entire subtree belonging |
a7808fba | 7459 | to it in the original Org file. If the text to be deleted remotely |
4009494e GM |
7460 | is longer than one line, the kill needs to be confirmed by the user. See |
7461 | variable @code{org-agenda-confirm-kill}. | |
7462 | @c | |
c8d0cf5c CD |
7463 | @kindex C-c C-w |
7464 | @item C-c C-w | |
7465 | Refile the entry at point. | |
7466 | @c | |
a351880d | 7467 | @kindex C-c C-x C-a |
a7808fba | 7468 | @kindex a |
a351880d CD |
7469 | @item C-c C-x C-a @ @r{or short} @ a |
7470 | @vindex org-archive-default-command | |
7471 | Archive the subtree corresponding to the entry at point using the default | |
7472 | archiving command set in @code{org-archive-default-command}. When using the | |
7473 | @code{a} key, confirmation will be required. | |
7474 | @c | |
7475 | @kindex C-c C-x a | |
7476 | @item C-c C-x a | |
a7808fba CD |
7477 | Toggle the ARCHIVE tag for the current headline. |
7478 | @c | |
a351880d CD |
7479 | @kindex C-c C-x A |
7480 | @item C-c C-x A | |
c8d0cf5c CD |
7481 | Move the subtree corresponding to the current entry to its @emph{archive |
7482 | sibling}. | |
a7808fba | 7483 | @c |
4009494e | 7484 | @kindex $ |
a351880d CD |
7485 | @kindex C-c C-x C-s |
7486 | @item C-c C-x C-s @ @r{or short} @ $ | |
a7808fba | 7487 | Archive the subtree corresponding to the current headline. This means the |
b349f79f | 7488 | entry will be moved to the configured archive location, most likely a |
a7808fba | 7489 | different file. |
4009494e GM |
7490 | @c |
7491 | @kindex T | |
7492 | @item T | |
c8d0cf5c | 7493 | @vindex org-agenda-show-inherited-tags |
96c8522a CD |
7494 | Show all tags associated with the current item. This is useful if you have |
7495 | turned off @code{org-agenda-show-inherited-tags}, but still want to see all | |
7496 | tags of a headline occasionally. | |
4009494e GM |
7497 | @c |
7498 | @kindex : | |
7499 | @item : | |
dbc28aaa CD |
7500 | Set tags for the current headline. If there is an active region in the |
7501 | agenda, change a tag for all headings in the region. | |
4009494e | 7502 | @c |
4009494e GM |
7503 | @kindex , |
7504 | @item , | |
a7808fba | 7505 | Set the priority for the current item. Org mode prompts for the |
4009494e GM |
7506 | priority character. If you reply with @key{SPC}, the priority cookie |
7507 | is removed from the entry. | |
7508 | @c | |
7509 | @kindex P | |
7510 | @item P | |
7511 | Display weighted priority of current item. | |
7512 | @c | |
7513 | @kindex + | |
7514 | @kindex S-@key{up} | |
7515 | @item + | |
7516 | @itemx S-@key{up} | |
7517 | Increase the priority of the current item. The priority is changed in | |
7518 | the original buffer, but the agenda is not resorted. Use the @kbd{r} | |
7519 | key for this. | |
7520 | @c | |
7521 | @kindex - | |
7522 | @kindex S-@key{down} | |
7523 | @item - | |
7524 | @itemx S-@key{down} | |
7525 | Decrease the priority of the current item. | |
7526 | @c | |
c8d0cf5c CD |
7527 | @kindex z |
7528 | @item z | |
7529 | @vindex org-log-into-drawer | |
7530 | Add a note to the entry. This note will be recorded, and then files to the | |
7531 | same location where state change notes are put. Depending on | |
7532 | @code{org-log-into-drawer}, this maybe inside a drawer. | |
7533 | @c | |
864c9740 CD |
7534 | @kindex C-c C-a |
7535 | @item C-c C-a | |
7536 | Dispatcher for all command related to attachments. | |
7537 | @c | |
4009494e GM |
7538 | @kindex C-c C-s |
7539 | @item C-c C-s | |
7540 | Schedule this item | |
7541 | @c | |
7542 | @kindex C-c C-d | |
7543 | @item C-c C-d | |
7544 | Set a deadline for this item. | |
7545 | @c | |
b349f79f CD |
7546 | @kindex k |
7547 | @item k | |
7548 | Agenda actions, to set dates for selected items to the cursor date. | |
7549 | This command also works in the calendar! The command prompts for an | |
a50253cc | 7550 | additional key: |
b349f79f CD |
7551 | @example |
7552 | m @r{Mark the entry at point for action. You can also make entries} | |
7553 | @r{in Org files with @kbd{C-c C-x C-k}.} | |
7554 | d @r{Set the deadline of the marked entry to the date at point.} | |
7555 | s @r{Schedule the marked entry at the date at point.} | |
7556 | r @r{Call @code{org-remember} with the cursor date as default date.} | |
7557 | @end example | |
c8d0cf5c | 7558 | @noindent |
a50253cc | 7559 | Press @kbd{r} afterward to refresh the agenda and see the effect of the |
b349f79f CD |
7560 | command. |
7561 | @c | |
4009494e GM |
7562 | @kindex S-@key{right} |
7563 | @item S-@key{right} | |
c8d0cf5c | 7564 | Change the timestamp associated with the current line by one day into the |
a7808fba | 7565 | future. With a numeric prefix argument, change it by that many days. For |
c8d0cf5c CD |
7566 | example, @kbd{3 6 5 S-@key{right}} will change it by a year. With a |
7567 | @kbd{C-u} prefix, change the time by one hour. If you immediately repeat the | |
7568 | command, it will continue to change hours even without the prefix arg. With | |
7569 | a double @kbd{C-u C-u} prefix, do the same for changing minutes. The stamp | |
7570 | is changed in the original Org file, but the change is not directly reflected | |
7571 | in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer. | |
4009494e GM |
7572 | @c |
7573 | @kindex S-@key{left} | |
7574 | @item S-@key{left} | |
c8d0cf5c | 7575 | Change the timestamp associated with the current line by one day |
4009494e GM |
7576 | into the past. |
7577 | @c | |
7578 | @kindex > | |
7579 | @item > | |
c8d0cf5c | 7580 | Change the timestamp associated with the current line to today. |
4009494e GM |
7581 | The key @kbd{>} has been chosen, because it is the same as @kbd{S-.} |
7582 | on my keyboard. | |
7583 | @c | |
7584 | @kindex I | |
7585 | @item I | |
7586 | Start the clock on the current item. If a clock is running already, it | |
7587 | is stopped first. | |
7588 | @c | |
7589 | @kindex O | |
7590 | @item O | |
7591 | Stop the previously started clock. | |
7592 | @c | |
7593 | @kindex X | |
7594 | @item X | |
7595 | Cancel the currently running clock. | |
7596 | ||
dbc28aaa CD |
7597 | @kindex J |
7598 | @item J | |
7599 | Jump to the running clock in another window. | |
7600 | ||
c8d0cf5c CD |
7601 | @tsubheading{Bulk remote editing selected entries} |
7602 | @cindex remote editing, bulk, from agenda | |
7603 | ||
7604 | @kindex m | |
7605 | @item s | |
7606 | Mark the entry at point for bulk action. | |
7607 | ||
7608 | @kindex u | |
7609 | @item u | |
7610 | Unmark entry for bulk action. | |
7611 | ||
7612 | @kindex U | |
7613 | @item U | |
7614 | Unmark all marked entries for bulk action. | |
7615 | ||
7616 | @kindex B | |
7617 | @item B | |
7618 | Bulk action: act on all marked entries in the agenda. This will prompt for | |
7619 | another key to select the action to be applied: | |
7620 | @example | |
7621 | r @r{Prompt for a single refile target and move all entries. The entries} | |
7622 | @r{will no longer be in the agenda, refresh (@kbd{g}) to bring them back.} | |
7623 | $ @r{Archive all selected entries.} | |
7624 | A @r{Archive entries by moving them to their respective archive siblings.} | |
7625 | t @r{Change TODO state. This prompts for a single TODO keyword and} | |
7626 | @r{changes the state of all selected entries, bypassing blocking and} | |
7627 | @r{suppressing logging notes (but not time stamps).} | |
7628 | + @r{Add a tag to all selected entries.} | |
7629 | - @r{Remove a tag from all selected entries.} | |
7630 | s @r{Schedule all items to a new date. To shift existing schedule dates} | |
7631 | @r{by a fixed number of days, use something starting with double plus} | |
7632 | @r{at the prompt, for example @samp{++8d} or @samp{++2w}.} | |
7633 | d @r{Set deadline to a specific date.} | |
7634 | @end example | |
7635 | ||
7636 | ||
4009494e GM |
7637 | @tsubheading{Calendar commands} |
7638 | @cindex calendar commands, from agenda | |
7639 | @kindex c | |
7640 | @item c | |
7641 | Open the Emacs calendar and move to the date at the agenda cursor. | |
7642 | @c | |
7643 | @item c | |
a7808fba | 7644 | When in the calendar, compute and show the Org mode agenda for the |
4009494e GM |
7645 | date at the cursor. |
7646 | @c | |
7647 | @cindex diary entries, creating from agenda | |
7648 | @kindex i | |
7649 | @item i | |
a351880d CD |
7650 | @vindex org-agenda-diary-file |
7651 | Insert a new entry into the diary, using the date at the cursor and (for | |
7652 | block entries) the date at the mark. This will add to the Emacs diary | |
7653 | file@footnote{This file is parsed for the agenda when | |
7654 | @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i} | |
7655 | command in the calendar. The diary file will pop up in another window, where | |
7656 | you can add the entry. | |
7657 | ||
7658 | If you configure @code{org-agenda-diary-file} to point to an Org-mode file, | |
7659 | Org will create entries (in org-mode syntax) in that file instead. Most | |
7660 | entries will be stored in a date-based outline tree that will later make it | |
7661 | easy to archive appointments from previous months/years. The tree will be | |
7662 | build under an entry with a @code{DATE_TREE} property, or else with years as | |
7663 | top-level entries. Emacs will prompt you for the entry text - if you specify | |
7664 | it, the entry will be created in @code{org-agenda-diary-file} without further | |
7665 | interaction. If you directly press @key{RET} at the prompt without typing | |
7666 | text, the target file will be shown in another window for you to finish the | |
7667 | entry there. See also the @kbd{k r} command. | |
4009494e GM |
7668 | @c |
7669 | @kindex M | |
7670 | @item M | |
7671 | Show the phases of the moon for the three months around current date. | |
7672 | @c | |
7673 | @kindex S | |
7674 | @item S | |
7675 | Show sunrise and sunset times. The geographical location must be set | |
c8d0cf5c | 7676 | with calendar variables, see the documentation for the Emacs calendar. |
4009494e GM |
7677 | @c |
7678 | @kindex C | |
7679 | @item C | |
7680 | Convert the date at cursor into many other cultural and historic | |
7681 | calendars. | |
7682 | @c | |
7683 | @kindex H | |
7684 | @item H | |
c8d0cf5c | 7685 | Show holidays for three months around the cursor date. |
a7808fba CD |
7686 | |
7687 | @item M-x org-export-icalendar-combine-agenda-files | |
4009494e | 7688 | Export a single iCalendar file containing entries from all agenda files. |
a7808fba | 7689 | This is a globally available command, and also available in the agenda menu. |
4009494e GM |
7690 | |
7691 | @tsubheading{Exporting to a file} | |
7692 | @kindex C-x C-w | |
7693 | @item C-x C-w | |
7694 | @cindex exporting agenda views | |
7695 | @cindex agenda views, exporting | |
c8d0cf5c CD |
7696 | @vindex org-agenda-exporter-settings |
7697 | Write the agenda view to a file. Depending on the extension of the selected | |
7698 | file name, the view will be exported as HTML (extension @file{.html} or | |
7699 | @file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}), | |
a351880d CD |
7700 | and plain text (any other extension). When called with a @kbd{C-u} prefix |
7701 | argument, immediately open the newly created file. Use the variable | |
7702 | @code{org-agenda-exporter-settings} to set options for @file{ps-print} and | |
7703 | for @file{htmlize} to be used during export. | |
4009494e GM |
7704 | |
7705 | @tsubheading{Quit and Exit} | |
7706 | @kindex q | |
7707 | @item q | |
7708 | Quit agenda, remove the agenda buffer. | |
7709 | @c | |
7710 | @kindex x | |
7711 | @cindex agenda files, removing buffers | |
7712 | @item x | |
7713 | Exit agenda, remove the agenda buffer and all buffers loaded by Emacs | |
7714 | for the compilation of the agenda. Buffers created by the user to | |
c8d0cf5c | 7715 | visit Org files will not be removed. |
4009494e GM |
7716 | @end table |
7717 | ||
7718 | ||
c8d0cf5c | 7719 | @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views |
4009494e GM |
7720 | @section Custom agenda views |
7721 | @cindex custom agenda views | |
7722 | @cindex agenda views, custom | |
7723 | ||
7724 | Custom agenda commands serve two purposes: to store and quickly access | |
7725 | frequently used TODO and tags searches, and to create special composite | |
7726 | agenda buffers. Custom agenda commands will be accessible through the | |
7727 | dispatcher (@pxref{Agenda dispatcher}), just like the default commands. | |
7728 | ||
7729 | @menu | |
7730 | * Storing searches:: Type once, use often | |
7731 | * Block agenda:: All the stuff you need in a single buffer | |
7732 | * Setting Options:: Changing the rules | |
4009494e GM |
7733 | @end menu |
7734 | ||
7735 | @node Storing searches, Block agenda, Custom agenda views, Custom agenda views | |
7736 | @subsection Storing searches | |
7737 | ||
7738 | The first application of custom searches is the definition of keyboard | |
7739 | shortcuts for frequently used searches, either creating an agenda | |
7740 | buffer, or a sparse tree (the latter covering of course only the current | |
7741 | buffer). | |
7742 | @kindex C-c a C | |
c8d0cf5c | 7743 | @vindex org-agenda-custom-commands |
4009494e GM |
7744 | Custom commands are configured in the variable |
7745 | @code{org-agenda-custom-commands}. You can customize this variable, for | |
7746 | example by pressing @kbd{C-c a C}. You can also directly set it with | |
7747 | Emacs Lisp in @file{.emacs}. The following example contains all valid | |
7748 | search types: | |
7749 | ||
7750 | @lisp | |
7751 | @group | |
7752 | (setq org-agenda-custom-commands | |
7753 | '(("w" todo "WAITING") | |
7754 | ("W" todo-tree "WAITING") | |
dbc28aaa CD |
7755 | ("u" tags "+boss-urgent") |
7756 | ("v" tags-todo "+boss-urgent") | |
7757 | ("U" tags-tree "+boss-urgent") | |
7758 | ("f" occur-tree "\\<FIXME\\>") | |
7759 | ("h" . "HOME+Name tags searches") ; description for "h" prefix | |
7760 | ("hl" tags "+home+Lisa") | |
7761 | ("hp" tags "+home+Peter") | |
7762 | ("hk" tags "+home+Kim"))) | |
4009494e GM |
7763 | @end group |
7764 | @end lisp | |
7765 | ||
7766 | @noindent | |
dbc28aaa CD |
7767 | The initial string in each entry defines the keys you have to press |
7768 | after the dispatcher command @kbd{C-c a} in order to access the command. | |
7769 | Usually this will be just a single character, but if you have many | |
7770 | similar commands, you can also define two-letter combinations where the | |
7771 | first character is the same in several combinations and serves as a | |
7772 | prefix key@footnote{You can provide a description for a prefix key by | |
7773 | inserting a cons cell with the prefix and the description.}. The second | |
7774 | parameter is the search type, followed by the string or regular | |
7775 | expression to be used for the matching. The example above will | |
7776 | therefore define: | |
4009494e GM |
7777 | |
7778 | @table @kbd | |
7779 | @item C-c a w | |
7780 | as a global search for TODO entries with @samp{WAITING} as the TODO | |
7781 | keyword | |
7782 | @item C-c a W | |
7783 | as the same search, but only in the current buffer and displaying the | |
7784 | results as a sparse tree | |
7785 | @item C-c a u | |
dbc28aaa CD |
7786 | as a global tags search for headlines marked @samp{:boss:} but not |
7787 | @samp{:urgent:} | |
4009494e GM |
7788 | @item C-c a v |
7789 | as the same search as @kbd{C-c a u}, but limiting the search to | |
7790 | headlines that are also TODO items | |
7791 | @item C-c a U | |
7792 | as the same search as @kbd{C-c a u}, but only in the current buffer and | |
7793 | displaying the result as a sparse tree | |
7794 | @item C-c a f | |
7795 | to create a sparse tree (again: current buffer only) with all entries | |
dbc28aaa CD |
7796 | containing the word @samp{FIXME} |
7797 | @item C-c a h | |
7798 | as a prefix command for a HOME tags search where you have to press an | |
7799 | additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa, | |
7800 | Peter, or Kim) as additional tag to match. | |
4009494e GM |
7801 | @end table |
7802 | ||
7803 | @node Block agenda, Setting Options, Storing searches, Custom agenda views | |
7804 | @subsection Block agenda | |
7805 | @cindex block agenda | |
7806 | @cindex agenda, with block views | |
7807 | ||
7808 | Another possibility is the construction of agenda views that comprise | |
7809 | the results of @emph{several} commands, each of which creates a block in | |
7810 | the agenda buffer. The available commands include @code{agenda} for the | |
7811 | daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo} | |
a7808fba | 7812 | for the global TODO list (as constructed with @kbd{C-c a t}), and the |
4009494e GM |
7813 | matching commands discussed above: @code{todo}, @code{tags}, and |
7814 | @code{tags-todo}. Here are two examples: | |
7815 | ||
7816 | @lisp | |
7817 | @group | |
7818 | (setq org-agenda-custom-commands | |
7819 | '(("h" "Agenda and Home-related tasks" | |
28a16a1b | 7820 | ((agenda "") |
dbc28aaa CD |
7821 | (tags-todo "home") |
7822 | (tags "garden"))) | |
4009494e | 7823 | ("o" "Agenda and Office-related tasks" |
28a16a1b | 7824 | ((agenda "") |
dbc28aaa CD |
7825 | (tags-todo "work") |
7826 | (tags "office"))))) | |
4009494e GM |
7827 | @end group |
7828 | @end lisp | |
7829 | ||
7830 | @noindent | |
7831 | This will define @kbd{C-c a h} to create a multi-block view for stuff | |
7832 | you need to attend to at home. The resulting agenda buffer will contain | |
7833 | your agenda for the current week, all TODO items that carry the tag | |
dbc28aaa | 7834 | @samp{home}, and also all lines tagged with @samp{garden}. Finally the |
4009494e GM |
7835 | command @kbd{C-c a o} provides a similar view for office tasks. |
7836 | ||
c8d0cf5c | 7837 | @node Setting Options, , Block agenda, Custom agenda views |
a7808fba | 7838 | @subsection Setting options for custom commands |
4009494e GM |
7839 | @cindex options, for custom agenda views |
7840 | ||
c8d0cf5c | 7841 | @vindex org-agenda-custom-commands |
a7808fba | 7842 | Org mode contains a number of variables regulating agenda construction |
4009494e GM |
7843 | and display. The global variables define the behavior for all agenda |
7844 | commands, including the custom commands. However, if you want to change | |
7845 | some settings just for a single custom view, you can do so. Setting | |
7846 | options requires inserting a list of variable names and values at the | |
7847 | right spot in @code{org-agenda-custom-commands}. For example: | |
7848 | ||
7849 | @lisp | |
7850 | @group | |
7851 | (setq org-agenda-custom-commands | |
7852 | '(("w" todo "WAITING" | |
7853 | ((org-agenda-sorting-strategy '(priority-down)) | |
7854 | (org-agenda-prefix-format " Mixed: "))) | |
dbc28aaa | 7855 | ("U" tags-tree "+boss-urgent" |
4009494e | 7856 | ((org-show-following-heading nil) |
28a16a1b CD |
7857 | (org-show-hierarchy-above nil))) |
7858 | ("N" search "" | |
7859 | ((org-agenda-files '("~org/notes.org")) | |
7860 | (org-agenda-text-search-extra-files nil))))) | |
4009494e GM |
7861 | @end group |
7862 | @end lisp | |
7863 | ||
7864 | @noindent | |
7865 | Now the @kbd{C-c a w} command will sort the collected entries only by | |
dbc28aaa | 7866 | priority, and the prefix format is modified to just say @samp{ Mixed: } |
4009494e GM |
7867 | instead of giving the category of the entry. The sparse tags tree of |
7868 | @kbd{C-c a U} will now turn out ultra-compact, because neither the | |
7869 | headline hierarchy above the match, nor the headline following the match | |
28a16a1b CD |
7870 | will be shown. The command @kbd{C-c a N} will do a text search limited |
7871 | to only a single file. | |
4009494e | 7872 | |
c8d0cf5c | 7873 | @vindex org-agenda-custom-commands |
4009494e GM |
7874 | For command sets creating a block agenda, |
7875 | @code{org-agenda-custom-commands} has two separate spots for setting | |
7876 | options. You can add options that should be valid for just a single | |
7877 | command in the set, and options that should be valid for all commands in | |
7878 | the set. The former are just added to the command entry, the latter | |
7879 | must come after the list of command entries. Going back to the block | |
7880 | agenda example (@pxref{Block agenda}), let's change the sorting strategy | |
7881 | for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort | |
7882 | the results for GARDEN tags query in the opposite order, | |
7883 | @code{priority-up}. This would look like this: | |
7884 | ||
7885 | @lisp | |
7886 | @group | |
7887 | (setq org-agenda-custom-commands | |
7888 | '(("h" "Agenda and Home-related tasks" | |
7889 | ((agenda) | |
dbc28aaa CD |
7890 | (tags-todo "home") |
7891 | (tags "garden" | |
4009494e GM |
7892 | ((org-agenda-sorting-strategy '(priority-up))))) |
7893 | ((org-agenda-sorting-strategy '(priority-down)))) | |
7894 | ("o" "Agenda and Office-related tasks" | |
7895 | ((agenda) | |
dbc28aaa CD |
7896 | (tags-todo "work") |
7897 | (tags "office"))))) | |
4009494e GM |
7898 | @end group |
7899 | @end lisp | |
7900 | ||
c8d0cf5c CD |
7901 | As you see, the values and parentheses setting is a little complex. |
7902 | When in doubt, use the customize interface to set this variable---it | |
7903 | fully supports its structure. Just one caveat: when setting options in | |
7904 | this interface, the @emph{values} are just Lisp expressions. So if the | |
7905 | value is a string, you need to add the double-quotes around the value | |
4009494e GM |
7906 | yourself. |
7907 | ||
7908 | ||
c8d0cf5c CD |
7909 | @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views |
7910 | @section Exporting Agenda Views | |
4009494e GM |
7911 | @cindex agenda views, exporting |
7912 | ||
3da3282e CD |
7913 | If you are away from your computer, it can be very useful to have a printed |
7914 | version of some agenda views to carry around. Org mode can export custom | |
7915 | agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's | |
c8d0cf5c CD |
7916 | @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the |
7917 | ghostscript @file{ps2pdf} utility must be installed on the system. Selecting | |
7918 | a PDF file with also create the postscript file.}, and iCalendar files. If | |
7919 | you want to do this only occasionally, use the command | |
4009494e GM |
7920 | |
7921 | @table @kbd | |
7922 | @kindex C-x C-w | |
7923 | @item C-x C-w | |
7924 | @cindex exporting agenda views | |
7925 | @cindex agenda views, exporting | |
c8d0cf5c | 7926 | @vindex org-agenda-exporter-settings |
7006d207 CD |
7927 | Write the agenda view to a file. Depending on the extension of the selected |
7928 | file name, the view will be exported as HTML (extension @file{.html} or | |
7929 | @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension | |
a351880d CD |
7930 | @file{.ics}), or plain text (any other extension). Use the variable |
7931 | @code{org-agenda-exporter-settings} to set options for @file{ps-print} and | |
7932 | for @file{htmlize} to be used during export, for example | |
28a16a1b | 7933 | |
c8d0cf5c CD |
7934 | @vindex org-agenda-add-entry-text-maxlines |
7935 | @vindex htmlize-output-type | |
7936 | @vindex ps-number-of-columns | |
7937 | @vindex ps-landscape-mode | |
4009494e GM |
7938 | @lisp |
7939 | (setq org-agenda-exporter-settings | |
7940 | '((ps-number-of-columns 2) | |
7941 | (ps-landscape-mode t) | |
c8d0cf5c | 7942 | (org-agenda-add-entry-text-maxlines 5) |
4009494e GM |
7943 | (htmlize-output-type 'css))) |
7944 | @end lisp | |
7945 | @end table | |
7946 | ||
7947 | If you need to export certain agenda views frequently, you can associate | |
7948 | any custom agenda command with a list of output file names | |
7949 | @footnote{If you want to store standard views like the weekly agenda | |
7950 | or the global TODO list as well, you need to define custom commands for | |
28a16a1b | 7951 | them in order to be able to specify file names.}. Here is an example |
c8d0cf5c CD |
7952 | that first defines custom commands for the agenda and the global |
7953 | TODO list, together with a number of files to which to export them. | |
28a16a1b | 7954 | Then we define two block agenda commands and specify file names for them |
4009494e GM |
7955 | as well. File names can be relative to the current working directory, |
7956 | or absolute. | |
7957 | ||
7958 | @lisp | |
7959 | @group | |
7960 | (setq org-agenda-custom-commands | |
7961 | '(("X" agenda "" nil ("agenda.html" "agenda.ps")) | |
7962 | ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps")) | |
7963 | ("h" "Agenda and Home-related tasks" | |
28a16a1b | 7964 | ((agenda "") |
dbc28aaa CD |
7965 | (tags-todo "home") |
7966 | (tags "garden")) | |
4009494e GM |
7967 | nil |
7968 | ("~/views/home.html")) | |
7969 | ("o" "Agenda and Office-related tasks" | |
7970 | ((agenda) | |
dbc28aaa CD |
7971 | (tags-todo "work") |
7972 | (tags "office")) | |
4009494e | 7973 | nil |
28a16a1b | 7974 | ("~/views/office.ps" "~/calendars/office.ics")))) |
4009494e GM |
7975 | @end group |
7976 | @end lisp | |
7977 | ||
7978 | The extension of the file name determines the type of export. If it is | |
a7808fba | 7979 | @file{.html}, Org mode will use the @file{htmlize.el} package to convert |
4009494e GM |
7980 | the buffer to HTML and save it to this file name. If the extension is |
7981 | @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce | |
c8d0cf5c | 7982 | Postscript output. If the extension is @file{.ics}, iCalendar export is |
28a16a1b | 7983 | run export over all files that were used to construct the agenda, and |
c8d0cf5c | 7984 | limit the export to entries listed in the agenda. Any other |
28a16a1b | 7985 | extension produces a plain ASCII file. |
4009494e GM |
7986 | |
7987 | The export files are @emph{not} created when you use one of those | |
28a16a1b CD |
7988 | commands interactively because this might use too much overhead. |
7989 | Instead, there is a special command to produce @emph{all} specified | |
7990 | files in one step: | |
4009494e GM |
7991 | |
7992 | @table @kbd | |
7993 | @kindex C-c a e | |
7994 | @item C-c a e | |
28a16a1b | 7995 | Export all agenda views that have export file names associated with |
4009494e GM |
7996 | them. |
7997 | @end table | |
7998 | ||
7999 | You can use the options section of the custom agenda commands to also | |
8000 | set options for the export commands. For example: | |
8001 | ||
8002 | @lisp | |
8003 | (setq org-agenda-custom-commands | |
8004 | '(("X" agenda "" | |
8005 | ((ps-number-of-columns 2) | |
8006 | (ps-landscape-mode t) | |
8007 | (org-agenda-prefix-format " [ ] ") | |
8008 | (org-agenda-with-colors nil) | |
8009 | (org-agenda-remove-tags t)) | |
8010 | ("theagenda.ps")))) | |
8011 | @end lisp | |
8012 | ||
8013 | @noindent | |
c8d0cf5c CD |
8014 | This command sets two options for the Postscript exporter, to make it |
8015 | print in two columns in landscape format---the resulting page can be cut | |
4009494e GM |
8016 | in two and then used in a paper agenda. The remaining settings modify |
8017 | the agenda prefix to omit category and scheduling information, and | |
8018 | instead include a checkbox to check off items. We also remove the tags | |
8019 | to make the lines compact, and we don't want to use colors for the | |
8020 | black-and-white printer. Settings specified in | |
8021 | @code{org-agenda-exporter-settings} will also apply, but the settings | |
8022 | in @code{org-agenda-custom-commands} take precedence. | |
8023 | ||
8024 | @noindent | |
8025 | From the command line you may also use | |
8026 | @example | |
8027 | emacs -f org-batch-store-agenda-views -kill | |
8028 | @end example | |
8029 | @noindent | |
c8d0cf5c CD |
8030 | or, if you need to modify some parameters@footnote{Quoting depends on the |
8031 | system you use, please check the FAQ for examples.} | |
4009494e GM |
8032 | @example |
8033 | emacs -eval '(org-batch-store-agenda-views \ | |
8034 | org-agenda-ndays 30 \ | |
dbc28aaa | 8035 | org-agenda-start-day "2007-11-01" \ |
4009494e GM |
8036 | org-agenda-include-diary nil \ |
8037 | org-agenda-files (quote ("~/org/project.org")))' \ | |
8038 | -kill | |
8039 | @end example | |
8040 | @noindent | |
8041 | which will create the agenda views restricted to the file | |
c8d0cf5c | 8042 | @file{~/org/project.org}, without diary entries and with a 30-day |
28a16a1b | 8043 | extent. |
4009494e | 8044 | |
c8d0cf5c CD |
8045 | You can also extract agenda information in a way that allows further |
8046 | processing by other programs. See @ref{Extracting agenda information}, for | |
8047 | more information. | |
4009494e | 8048 | |
4009494e | 8049 | |
c8d0cf5c | 8050 | @node Agenda column view, , Exporting Agenda Views, Agenda Views |
a7808fba CD |
8051 | @section Using column view in the agenda |
8052 | @cindex column view, in agenda | |
8053 | @cindex agenda, column view | |
8054 | ||
8055 | Column view (@pxref{Column view}) is normally used to view and edit | |
8056 | properties embedded in the hierarchical structure of an Org file. It can be | |
8057 | quite useful to use column view also from the agenda, where entries are | |
8058 | collected by certain criteria. | |
8059 | ||
8060 | @table @kbd | |
8061 | @kindex C-c C-x C-c | |
8062 | @item C-c C-x C-c | |
8063 | Turn on column view in the agenda. | |
8064 | @end table | |
8065 | ||
8066 | To understand how to use this properly, it is important to realize that the | |
8067 | entries in the agenda are no longer in their proper outline environment. | |
8068 | This causes the following issues: | |
8069 | ||
8070 | @enumerate | |
8071 | @item | |
c8d0cf5c CD |
8072 | @vindex org-columns-default-format |
8073 | @vindex org-overriding-columns-format | |
a7808fba CD |
8074 | Org needs to make a decision which @code{COLUMNS} format to use. Since the |
8075 | entries in the agenda are collected from different files, and different files | |
8076 | may have different @code{COLUMNS} formats, this is a non-trivial problem. | |
8077 | Org first checks if the variable @code{org-overriding-columns-format} is | |
c8d0cf5c | 8078 | currently set, and if so, takes the format from there. Otherwise it takes |
a7808fba | 8079 | the format associated with the first item in the agenda, or, if that item |
c8d0cf5c | 8080 | does not have a specific format (defined in a property, or in its file), it |
a7808fba CD |
8081 | uses @code{org-columns-default-format}. |
8082 | @item | |
c8d0cf5c | 8083 | @cindex property, special, CLOCKSUM |
a7808fba CD |
8084 | If any of the columns has a summary type defined (@pxref{Column attributes}), |
8085 | turning on column view in the agenda will visit all relevant agenda files and | |
8086 | make sure that the computations of this property are up to date. This is | |
8087 | also true for the special @code{CLOCKSUM} property. Org will then sum the | |
8088 | values displayed in the agenda. In the daily/weekly agenda, the sums will | |
8089 | cover a single day, in all other views they cover the entire block. It is | |
8090 | vital to realize that the agenda may show the same entry @emph{twice} (for | |
8091 | example as scheduled and as a deadline), and it may show two entries from the | |
c8d0cf5c | 8092 | same hierarchy (for example a @emph{parent} and its @emph{child}). In these |
a7808fba CD |
8093 | cases, the summation in the agenda will lead to incorrect results because |
8094 | some values will count double. | |
8095 | @item | |
8096 | When the column view in the agenda shows the @code{CLOCKSUM}, that is always | |
8097 | the entire clocked time for this item. So even in the daily/weekly agenda, | |
8098 | the clocksum listed in column view may originate from times outside the | |
8099 | current view. This has the advantage that you can compare these values with | |
c8d0cf5c | 8100 | a column listing the planned total effort for a task---one of the major |
a7808fba CD |
8101 | applications for column view in the agenda. If you want information about |
8102 | clocked time in the displayed period use clock table mode (press @kbd{R} in | |
8103 | the agenda). | |
8104 | @end enumerate | |
8105 | ||
8106 | ||
a351880d CD |
8107 | @node Markup, Exporting, Agenda Views, Top |
8108 | @chapter Markup for rich export | |
4009494e | 8109 | |
a351880d CD |
8110 | When exporting Org-mode documents, the exporter tries to reflect the |
8111 | structure of the document as accurately as possible in the backend. Since | |
8112 | export targets like HTML, La@TeX{}, or DocBook allow much richer formatting, | |
8113 | Org mode has rules on how to prepare text for rich export. This section | |
8114 | summarizes the markup rules used in an Org-mode buffer. | |
4009494e | 8115 | |
a351880d CD |
8116 | @menu |
8117 | * Structural markup elements:: The basic structure as seen by the exporter | |
8118 | * Images and tables:: Tables and Images will be included | |
8119 | * Literal examples:: Source code examples with special formatting | |
8120 | * Include files:: Include additional files into a document | |
8121 | * Macro replacement:: Use macros to create complex output | |
8122 | * Embedded LaTeX:: LaTeX can be freely used inside Org documents | |
8123 | @end menu | |
8124 | ||
8125 | @node Structural markup elements, Images and tables, Markup, Markup | |
8126 | @section Structural markup elements | |
4009494e GM |
8127 | |
8128 | @menu | |
a351880d CD |
8129 | * Document title:: Where the title is taken from |
8130 | * Headings and sections:: The document structure as seen by the exporter | |
8131 | * Table of contents:: The if and where of the table of contents | |
8132 | * Initial text:: Text before the first heading? | |
8133 | * Lists:: Lists | |
8134 | * Paragraphs:: Paragraphs | |
8135 | * Footnote markup:: Footnotes | |
8136 | * Emphasis and monospace:: Bold, italic, etc. | |
8137 | * Horizontal rules:: Make a line | |
8138 | * Comment lines:: What will *not* be exported | |
4009494e GM |
8139 | @end menu |
8140 | ||
a351880d CD |
8141 | @node Document title, Headings and sections, Structural markup elements, Structural markup elements |
8142 | @subheading Document title | |
8143 | @cindex document title, markup rules | |
4009494e | 8144 | |
a351880d CD |
8145 | @noindent |
8146 | The title of the exported document is taken from the special line | |
4009494e | 8147 | |
a351880d | 8148 | @cindex #+TITLE |
4009494e | 8149 | @example |
a351880d | 8150 | #+TITLE: This is the title of the document |
4009494e | 8151 | @end example |
a351880d | 8152 | |
c8d0cf5c | 8153 | @noindent |
a351880d CD |
8154 | If this line does not exist, the title is derived from the first non-empty, |
8155 | non-comment line in the buffer. If no such line exists, or if you have | |
8156 | turned off exporting of the text before the first headline (see below), the | |
8157 | title will be the file name without extension. | |
4009494e | 8158 | |
a351880d CD |
8159 | @cindex property, EXPORT_TITLE |
8160 | If you are exporting only a subtree by marking is as the region, the heading | |
8161 | of the subtree will become the title of the document. If the subtree has a | |
8162 | property @code{EXPORT_TITLE}, that will take precedence. | |
4009494e | 8163 | |
a351880d CD |
8164 | @node Headings and sections, Table of contents, Document title, Structural markup elements |
8165 | @subheading Headings and sections | |
8166 | @cindex headings and sections, markup rules | |
8167 | ||
8168 | @vindex org-export-headline-levels | |
8169 | The outline structure of the document as described in @ref{Document | |
8170 | Structure}, forms the basis for defining sections of the exported document. | |
8171 | However, since the outline structure is also used for (for example) lists of | |
8172 | tasks, only the first three outline levels will be used as headings. Deeper | |
8173 | levels will become itemized lists. You can change the location of this | |
8174 | switch globally by setting the variable @code{org-export-headline-levels}, or on a | |
8175 | per-file basis with a line | |
4009494e | 8176 | |
a351880d | 8177 | @cindex #+OPTIONS |
4009494e | 8178 | @example |
a351880d | 8179 | #+OPTIONS: H:4 |
4009494e GM |
8180 | @end example |
8181 | ||
a351880d CD |
8182 | @node Table of contents, Initial text, Headings and sections, Structural markup elements |
8183 | @subheading Table of contents | |
8184 | @cindex table of contents, markup rules | |
4009494e | 8185 | |
a351880d CD |
8186 | @vindex org-export-with-toc |
8187 | The table of contents is normally inserted directly before the first headline | |
8188 | of the file. If you would like to get it to a different location, insert the | |
8189 | string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired | |
8190 | location. The depth of the table of contents is by default the same as the | |
8191 | number of headline levels, but you can choose a smaller number, or turn off | |
8192 | the table of contents entirely, by configuring the variable | |
8193 | @code{org-export-with-toc}, or on a per-file basis with a line like | |
b349f79f CD |
8194 | |
8195 | @example | |
8196 | #+OPTIONS: toc:2 (only to two levels in TOC) | |
8197 | #+OPTIONS: toc:nil (no TOC at all) | |
8198 | @end example | |
8199 | ||
a351880d | 8200 | @node Initial text, Lists, Table of contents, Structural markup elements |
b349f79f CD |
8201 | @subheading Text before the first headline |
8202 | @cindex text before first headline, markup rules | |
8203 | @cindex #+TEXT | |
8204 | ||
8205 | Org mode normally exports the text before the first headline, and even uses | |
8206 | the first line as the document title. The text will be fully marked up. If | |
c8d0cf5c CD |
8207 | you need to include literal HTML, La@TeX{}, or DocBook code, use the special |
8208 | constructs described below in the sections for the individual exporters. | |
b349f79f | 8209 | |
c8d0cf5c | 8210 | @vindex org-export-skip-text-before-1st-heading |
b349f79f CD |
8211 | Some people like to use the space before the first headline for setup and |
8212 | internal links and therefore would like to control the exported text before | |
8213 | the first headline in a different way. You can do so by setting the variable | |
8214 | @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file | |
8215 | basis, you can get the same effect with @samp{#+OPTIONS: skip:t}. | |
8216 | ||
8217 | @noindent | |
8218 | If you still want to have some text before the first headline, use the | |
8219 | @code{#+TEXT} construct: | |
8220 | ||
8221 | @example | |
8222 | #+OPTIONS: skip:t | |
8223 | #+TEXT: This text will go before the *first* headline. | |
8224 | #+TEXT: [TABLE-OF-CONTENTS] | |
8225 | #+TEXT: This goes between the table of contents and the first headline | |
8226 | @end example | |
8227 | ||
a351880d | 8228 | @node Lists, Paragraphs, Initial text, Structural markup elements |
b349f79f CD |
8229 | @subheading Lists |
8230 | @cindex lists, markup rules | |
8231 | ||
c8d0cf5c CD |
8232 | Plain lists as described in @ref{Plain lists}, are translated to the backend's |
8233 | syntax for such lists. Most backends support unordered, ordered, and | |
b349f79f CD |
8234 | description lists. |
8235 | ||
a351880d | 8236 | @node Paragraphs, Footnote markup, Lists, Structural markup elements |
b349f79f CD |
8237 | @subheading Paragraphs, line breaks, and quoting |
8238 | @cindex paragraphs, markup rules | |
8239 | ||
8240 | Paragraphs are separated by at least one empty line. If you need to enforce | |
8241 | a line break within a paragraph, use @samp{\\} at the end of a line. | |
8242 | ||
8243 | To keep the line breaks in a region, but otherwise use normal formatting, you | |
8244 | can use this construct, which can also be used to format poetry. | |
8245 | ||
c8d0cf5c | 8246 | @cindex #+BEGIN_VERSE |
b349f79f CD |
8247 | @example |
8248 | #+BEGIN_VERSE | |
864c9740 CD |
8249 | Great clouds overhead |
8250 | Tiny black birds rise and fall | |
8251 | Snow covers Emacs | |
96c8522a | 8252 | |
864c9740 | 8253 | -- AlexSchroeder |
b349f79f CD |
8254 | #+END_VERSE |
8255 | @end example | |
8256 | ||
8257 | When quoting a passage from another document, it is customary to format this | |
8258 | as a paragraph that is indented on both the left and the right margin. You | |
c8d0cf5c | 8259 | can include quotations in Org-mode documents like this: |
b349f79f | 8260 | |
c8d0cf5c | 8261 | @cindex #+BEGIN_QUOTE |
b349f79f CD |
8262 | @example |
8263 | #+BEGIN_QUOTE | |
8264 | Everything should be made as simple as possible, | |
8265 | but not any simpler -- Albert Einstein | |
8266 | #+END_QUOTE | |
8267 | @end example | |
8268 | ||
c8d0cf5c CD |
8269 | If you would like to center some text, do it like this: |
8270 | @cindex #+BEGIN_CENTER | |
8271 | @example | |
8272 | #+BEGIN_CENTER | |
8273 | Everything should be made as simple as possible, \\ | |
8274 | but not any simpler | |
8275 | #+END_CENTER | |
8276 | @end example | |
b349f79f | 8277 | |
a351880d CD |
8278 | |
8279 | @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements | |
8280 | @subheading Footnote markup | |
8281 | @cindex footnotes, markup rules | |
8282 | @cindex @file{footnote.el} | |
8283 | ||
8284 | Footnotes defined in the way described in @ref{Footnotes}, will be exported by | |
8285 | all backends. Org allows multiple references to the same note, and | |
8286 | different backends support this to varying degrees. | |
8287 | ||
8288 | @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements | |
8289 | @subheading Emphasis and monospace | |
8290 | ||
8291 | @cindex underlined text, markup rules | |
8292 | @cindex bold text, markup rules | |
8293 | @cindex italic text, markup rules | |
8294 | @cindex verbatim text, markup rules | |
8295 | @cindex code text, markup rules | |
8296 | @cindex strike-through text, markup rules | |
8297 | You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=} | |
8298 | and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text | |
8299 | in the code and verbatim string is not processed for Org-mode specific | |
8300 | syntax, it is exported verbatim. | |
8301 | ||
8302 | @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements | |
8303 | @subheading Horizontal rules | |
8304 | @cindex horizontal rules, markup rules | |
8305 | A line consisting of only dashes, and at least 5 of them, will be | |
8306 | exported as a horizontal line (@samp{<hr/>} in HTML). | |
8307 | ||
8308 | @node Comment lines, , Horizontal rules, Structural markup elements | |
8309 | @subheading Comment lines | |
8310 | @cindex comment lines | |
8311 | @cindex exporting, not | |
8312 | @cindex #+BEGIN_COMMENT | |
8313 | ||
8314 | Lines starting with @samp{#} in column zero are treated as comments and will | |
8315 | never be exported. If you want an indented line to be treated as a comment, | |
8316 | start it with @samp{#+ }. Also entire subtrees starting with the word | |
8317 | @samp{COMMENT} will never be exported. Finally, regions surrounded by | |
8318 | @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported. | |
8319 | ||
8320 | @table @kbd | |
8321 | @kindex C-c ; | |
8322 | @item C-c ; | |
8323 | Toggle the COMMENT keyword at the beginning of an entry. | |
8324 | @end table | |
8325 | ||
8326 | ||
8327 | @node Images and tables, Literal examples, Structural markup elements, Markup | |
8328 | @section Images and Tables | |
8329 | ||
8330 | @cindex tables, markup rules | |
8331 | @cindex #+CAPTION | |
8332 | @cindex #+LABEL | |
8333 | Both the native Org mode tables (@pxref{Tables}) and tables formatted with | |
8334 | the @file{table.el} package will be exported properly. For Org mode tables, | |
8335 | the lines before the first horizontal separator line will become table header | |
8336 | lines. You can use the following lines somewhere before the table to assign | |
8337 | a caption and a label for cross references: | |
8338 | ||
8339 | @example | |
8340 | #+CAPTION: This is the caption for the next table (or link) | |
8341 | #+LABEL: tbl:basic-data | |
8342 | | ... | ...| | |
8343 | |-----|----| | |
8344 | @end example | |
8345 | ||
8346 | @cindex inlined images, markup rules | |
8347 | Some backends (HTML, La@TeX{}, and DocBook) allow you to directly include | |
8348 | images into the exported document. Org does this, if a link to an image | |
8349 | files does not have a description part, for example @code{[[./img/a.jpg]]}. | |
8350 | If you wish to define a caption for the image and maybe a label for internal | |
8351 | cross references, you sure that the link is on a line by itself precede it | |
8352 | with: | |
8353 | ||
8354 | @example | |
8355 | #+CAPTION: This is the caption for the next figure link (or table) | |
8356 | #+LABEL: fig:SED-HR4049 | |
8357 | [[./img/a.jpg]] | |
8358 | @end example | |
8359 | ||
8360 | You may also define additional attributes for the figure. As this is | |
8361 | backend-specific, see the sections about the individual backends for more | |
8362 | information. | |
8363 | ||
8364 | ||
8365 | @node Literal examples, Include files, Images and tables, Markup | |
8366 | @section Literal examples | |
b349f79f | 8367 | @cindex literal examples, markup rules |
c8d0cf5c | 8368 | @cindex code line references, markup rules |
b349f79f CD |
8369 | |
8370 | You can include literal examples that should not be subjected to | |
8371 | markup. Such examples will be typeset in monospace, so this is well suited | |
8372 | for source code and similar examples. | |
8373 | @cindex #+BEGIN_EXAMPLE | |
8374 | ||
8375 | @example | |
8376 | #+BEGIN_EXAMPLE | |
8377 | Some example from a text file. | |
8378 | #+END_EXAMPLE | |
8379 | @end example | |
8380 | ||
c8d0cf5c CD |
8381 | Note that such blocks may be @i{indented} in order to align nicely with |
8382 | indented text and in particular with plain list structure (@pxref{Plain | |
8383 | lists}). For simplicity when using small examples, you can also start the | |
8384 | example lines with a colon followed by a space. There may also be additional | |
55e0839d | 8385 | whitespace before the colon: |
b349f79f CD |
8386 | |
8387 | @example | |
55e0839d CD |
8388 | Here is an example |
8389 | : Some example from a text file. | |
b349f79f CD |
8390 | @end example |
8391 | ||
8392 | @cindex formatting source code, markup rules | |
8393 | If the example is source code from a programming language, or any other text | |
8394 | that can be marked up by font-lock in Emacs, you can ask for the example to | |
6eb02347 CD |
8395 | look like the fontified Emacs buffer@footnote{Currently this works for the |
8396 | HTML backend, and requires the @file{htmlize.el} package version 1.34 or | |
8397 | later. It also works for LaTeX with the listings package, if you turn on the | |
8398 | option @code{org-export-latex-listings} and make sure that the listings | |
8399 | package is included by the LaTeX header.}. This is done with the @samp{src} | |
8400 | block, where you also need to specify the name of the major mode that should | |
8401 | be used to fontify the example: | |
b349f79f CD |
8402 | @cindex #+BEGIN_SRC |
8403 | ||
8404 | @example | |
8405 | #+BEGIN_SRC emacs-lisp | |
8406 | (defun org-xor (a b) | |
8407 | "Exclusive or." | |
8408 | (if a (not b) b)) | |
8409 | #+END_SRC | |
8410 | @end example | |
8411 | ||
55e0839d CD |
8412 | Both in @code{example} and in @code{src} snippets, you can add a @code{-n} |
8413 | switch to the end of the @code{BEGIN} line, to get the lines of the example | |
8414 | numbered. If you use a @code{+n} switch, the numbering from the previous | |
8415 | numbered snippet will be continued in the current one. In literal examples, | |
8416 | Org will interpret strings like @samp{(ref:name)} as labels, and use them as | |
a351880d | 8417 | targets for special hyperlinks like @code{[[(name)]]} (i.e. the reference name |
c8d0cf5c CD |
8418 | enclosed in single parenthesis). In HTML, hovering the mouse over such a |
8419 | link will remote-highlight the corresponding code line, which is kind of | |
8420 | cool. | |
8421 | ||
8422 | You can also add a @code{-r} switch which @i{removes} the labels from the | |
8423 | source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the | |
8424 | labels in the source code while using line numbers for the links, which might | |
8425 | be useful to explain those in an org-mode example code.}. With the @code{-n} | |
8426 | switch, links to these references will be labeled by the line numbers from | |
8427 | the code listing, otherwise links will use the labels with no parentheses. | |
8428 | Here is an example: | |
55e0839d CD |
8429 | |
8430 | @example | |
8431 | #+BEGIN_SRC emacs-lisp -n -r | |
8432 | (save-excursion (ref:sc) | |
8433 | (goto-char (point-min)) (ref:jump) | |
c8d0cf5c CD |
8434 | #+END_SRC |
8435 | In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]] | |
55e0839d CD |
8436 | jumps to point-min. |
8437 | @end example | |
8438 | ||
c8d0cf5c | 8439 | @vindex org-coderef-label-format |
55e0839d CD |
8440 | If the syntax for the label format conflicts with the language syntax, use a |
8441 | @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal | |
8442 | -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}. | |
8443 | ||
c8d0cf5c | 8444 | HTML export also allows examples to be published as text areas, @xref{Text |
2096a1b6 | 8445 | areas in HTML export}. |
55e0839d | 8446 | |
b349f79f CD |
8447 | @table @kbd |
8448 | @kindex C-c ' | |
8449 | @item C-c ' | |
8450 | Edit the source code example at point in its native mode. This works by | |
c8d0cf5c CD |
8451 | switching to a temporary buffer with the source code. You need to exit by |
8452 | pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*} | |
8453 | or @samp{#} will get a comma prepended, to keep them from being interpreted | |
8454 | by Org as outline nodes or special comments. These commas will be striped | |
8455 | for editing with @kbd{C-c '}, and also for export.}, the edited version will | |
8456 | then replace the old version in the Org buffer. Fixed-width regions | |
8457 | (where each line starts with a colon followed by a space) will be edited | |
8458 | using @code{artist-mode}@footnote{You may select a different-mode with the | |
8459 | variable @code{org-edit-fixed-width-region-mode}.} to allow creating ASCII | |
8460 | drawings easily. Using this command in an empty line will create a new | |
864c9740 | 8461 | fixed-width region. |
55e0839d CD |
8462 | @kindex C-c l |
8463 | @item C-c l | |
8464 | Calling @code{org-store-link} while editing a source code example in a | |
8465 | temporary buffer created with @kbd{C-c '} will prompt for a label, make sure | |
8466 | that it is unique in the current buffer, and insert it with the proper | |
8467 | formatting like @samp{(ref:label)} at the end of the current line. Then the | |
8468 | label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}. | |
b349f79f CD |
8469 | @end table |
8470 | ||
8471 | ||
a351880d CD |
8472 | @node Include files, Macro replacement, Literal examples, Markup |
8473 | @section Include files | |
b349f79f CD |
8474 | @cindex include files, markup rules |
8475 | ||
8476 | During export, you can include the content of another file. For example, to | |
c8d0cf5c | 8477 | include your @file{.emacs} file, you could use: |
b349f79f CD |
8478 | @cindex #+INCLUDE |
8479 | ||
8480 | @example | |
8481 | #+INCLUDE: "~/.emacs" src emacs-lisp | |
8482 | @end example | |
c8d0cf5c | 8483 | @noindent |
6eb02347 | 8484 | The optional second and third parameter are the markup (e.g. @samp{quote}, |
b349f79f CD |
8485 | @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the |
8486 | language for formatting the contents. The markup is optional, if it is not | |
8487 | given, the text will be assumed to be in Org mode format and will be | |
44ce9197 CD |
8488 | processed normally. The include line will also allow additional keyword |
8489 | parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the | |
55e0839d CD |
8490 | first line and for each following line, as well as any options accepted by |
8491 | the selected markup. For example, to include a file as an item, use | |
44ce9197 CD |
8492 | |
8493 | @example | |
8494 | #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " " | |
8495 | @end example | |
b349f79f CD |
8496 | |
8497 | @table @kbd | |
8498 | @kindex C-c ' | |
8499 | @item C-c ' | |
8500 | Visit the include file at point. | |
8501 | @end table | |
8502 | ||
b349f79f | 8503 | |
a351880d CD |
8504 | @node Macro replacement, Embedded LaTeX, Include files, Markup |
8505 | @section Macro replacement | |
8506 | @cindex macro replacement, during export | |
8507 | @cindex #+MACRO | |
8508 | ||
8509 | You can define text snippets with | |
8510 | ||
8511 | @example | |
8512 | #+MACRO: name replacement text $1, $2 are arguments | |
8513 | @end example | |
8514 | ||
8515 | @noindent which can be referenced anywhere in the document (even in | |
8516 | code examples) with @code{@{@{@{name(arg1,arg2)@}@}@}}. In addition to | |
8517 | defined macros, @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc., | |
8518 | will reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and | |
8519 | similar lines. Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and | |
8520 | @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time | |
8521 | and to the modification time of the file being exported, respectively. | |
8522 | @var{FORMAT} should be a format string understood by | |
8523 | @code{format-time-string}. | |
8524 | ||
8525 | Macro expansion takes place during export, and some people use it to | |
8526 | construct complex HTML code. | |
8527 | ||
8528 | ||
8529 | @node Embedded LaTeX, , Macro replacement, Markup | |
8530 | @section Embedded La@TeX{} | |
8531 | @cindex @TeX{} interpretation | |
8532 | @cindex La@TeX{} interpretation | |
8533 | ||
8534 | Plain ASCII is normally sufficient for almost all note taking. One | |
8535 | exception, however, are scientific notes which need to be able to contain | |
8536 | mathematical symbols and the occasional formula. La@TeX{}@footnote{La@TeX{} | |
8537 | is a macro system based on Donald E. Knuth's @TeX{} system. Many of the | |
8538 | features described here as ``La@TeX{}'' are really from @TeX{}, but for | |
8539 | simplicity I am blurring this distinction.} is widely used to typeset | |
8540 | scientific documents. Org mode supports embedding La@TeX{} code into its | |
8541 | files, because many academics are used to reading La@TeX{} source code, and | |
8542 | because it can be readily processed into images for HTML production. | |
8543 | ||
8544 | It is not necessary to mark La@TeX{} macros and code in any special way. | |
8545 | If you observe a few conventions, Org mode knows how to find it and what | |
8546 | to do with it. | |
8547 | ||
8548 | @menu | |
8549 | * Special symbols:: Greek letters and other symbols | |
8550 | * Subscripts and superscripts:: Simple syntax for raising/lowering text | |
8551 | * LaTeX fragments:: Complex formulas made easy | |
8552 | * Previewing LaTeX fragments:: What will this snippet look like? | |
8553 | * CDLaTeX mode:: Speed up entering of formulas | |
8554 | @end menu | |
8555 | ||
8556 | @node Special symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX | |
8557 | @subsection Special symbols | |
8558 | @cindex math symbols | |
8559 | @cindex special symbols | |
8560 | @cindex @TeX{} macros | |
8561 | @cindex La@TeX{} fragments, markup rules | |
8562 | @cindex HTML entities | |
8563 | @cindex La@TeX{} entities | |
8564 | ||
8565 | You can use La@TeX{} macros to insert special symbols like @samp{\alpha} to | |
8566 | indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion | |
8567 | for these macros is available, just type @samp{\} and maybe a few letters, | |
8568 | and press @kbd{M-@key{TAB}} to see possible completions. Unlike La@TeX{} | |
8569 | code, Org mode allows these macros to be present without surrounding math | |
8570 | delimiters, for example: | |
8571 | ||
8572 | @example | |
8573 | Angles are written as Greek letters \alpha, \beta and \gamma. | |
8574 | @end example | |
8575 | ||
8576 | @vindex org-html-entities | |
8577 | During export, these symbols will be transformed into the native format of | |
8578 | the exporter backend. Strings like @code{\alpha} will be exported as | |
8579 | @code{α} in the HTML output, and as @code{$\alpha$} in the La@TeX{} | |
8580 | output. Similarly, @code{\nbsp} will become @code{ } in HTML and | |
8581 | @code{~} in La@TeX{}. If you need such a symbol inside a word, terminate it | |
8582 | like this: @samp{\Aacute@{@}stor}. | |
8583 | ||
8584 | A large number of entities is provided, with names taken from both HTML and | |
8585 | La@TeX{}, see the variable @code{org-html-entities} for the complete list. | |
8586 | @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and | |
8587 | @samp{...} are all converted into special commands creating hyphens of | |
8588 | different lengths or a compact set of dots. | |
8589 | ||
8590 | @node Subscripts and superscripts, LaTeX fragments, Special symbols, Embedded LaTeX | |
8591 | @subsection Subscripts and superscripts | |
8592 | @cindex subscript | |
8593 | @cindex superscript | |
8594 | ||
8595 | Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super- | |
8596 | and subscripts. Again, these can be used without embedding them in | |
8597 | math-mode delimiters. To increase the readability of ASCII text, it is | |
8598 | not necessary (but OK) to surround multi-character sub- and superscripts | |
8599 | with curly braces. For example | |
67df9cfb CD |
8600 | |
8601 | @example | |
a351880d CD |
8602 | The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of |
8603 | the sun is R_@{sun@} = 6.96 x 10^8 m. | |
67df9cfb CD |
8604 | @end example |
8605 | ||
a351880d CD |
8606 | @vindex org-export-with-sub-superscripts |
8607 | To avoid interpretation as raised or lowered text, you can quote @samp{^} and | |
8608 | @samp{_} with a backslash: @samp{\^} and @samp{\_}. If you write a text | |
8609 | where the underscore is often used in a different context, Org's convention | |
8610 | to always interpret these as subscripts can get in your way. Configure the | |
8611 | variable @code{org-export-with-sub-superscripts} to globally change this | |
8612 | convention, or use, on a per-file basis: | |
67df9cfb CD |
8613 | |
8614 | @example | |
a351880d | 8615 | #+OPTIONS: ^:@{@} |
67df9cfb | 8616 | @end example |
b349f79f | 8617 | |
67df9cfb | 8618 | |
a351880d CD |
8619 | @node LaTeX fragments, Previewing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX |
8620 | @subsection La@TeX{} fragments | |
8621 | @cindex La@TeX{} fragments | |
b349f79f | 8622 | |
a351880d CD |
8623 | @vindex org-format-latex-header |
8624 | With symbols, sub- and superscripts, HTML is pretty much at its end when | |
8625 | it comes to representing mathematical formulas@footnote{Yes, there is | |
8626 | MathML, but that is not yet fully supported by many browsers, and there | |
8627 | is no decent converter for turning La@TeX{} or ASCII representations of | |
8628 | formulas into MathML. So for the time being, converting formulas into | |
8629 | images seems the way to go.}. More complex expressions need a dedicated | |
8630 | formula processor. To this end, Org mode can contain arbitrary La@TeX{} | |
8631 | fragments. It provides commands to preview the typeset result of these | |
8632 | fragments, and upon export to HTML, all fragments will be converted to | |
8633 | images and inlined into the HTML document@footnote{The La@TeX{} export | |
8634 | will not use images for displaying La@TeX{} fragments but include these | |
8635 | fragments directly into the La@TeX{} code.}. For this to work you | |
8636 | need to be on a system with a working La@TeX{} installation. You also | |
8637 | need the @file{dvipng} program, available at | |
8638 | @url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that | |
8639 | will be used when processing a fragment can be configured with the | |
8640 | variable @code{org-format-latex-header}. | |
b349f79f | 8641 | |
a351880d CD |
8642 | La@TeX{} fragments don't need any special marking at all. The following |
8643 | snippets will be identified as La@TeX{} source code: | |
8644 | @itemize @bullet | |
8645 | @item | |
8646 | Environments of any kind. The only requirement is that the | |
8647 | @code{\begin} statement appears on a new line, preceded by only | |
8648 | whitespace. | |
8649 | @item | |
8650 | Text within the usual La@TeX{} math delimiters. To avoid conflicts with | |
8651 | currency specifications, single @samp{$} characters are only recognized as | |
8652 | math delimiters if the enclosed text contains at most two line breaks, is | |
8653 | directly attached to the @samp{$} characters with no whitespace in between, | |
8654 | and if the closing @samp{$} is followed by whitespace, punctuation or a dash. | |
8655 | For the other delimiters, there is no such restriction, so when in doubt, use | |
8656 | @samp{\(...\)} as inline math delimiters. | |
8657 | @end itemize | |
b349f79f | 8658 | |
a351880d | 8659 | @noindent For example: |
b349f79f | 8660 | |
a351880d CD |
8661 | @example |
8662 | \begin@{equation@} % arbitrary environments, | |
8663 | x=\sqrt@{b@} % even tables, figures | |
8664 | \end@{equation@} % etc | |
b349f79f | 8665 | |
a351880d CD |
8666 | If $a^2=b$ and \( b=2 \), then the solution must be |
8667 | either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \]. | |
8668 | @end example | |
b349f79f | 8669 | |
a351880d CD |
8670 | @noindent |
8671 | @vindex org-format-latex-options | |
8672 | If you need any of the delimiter ASCII sequences for other purposes, you | |
8673 | can configure the option @code{org-format-latex-options} to deselect the | |
8674 | ones you do not wish to have interpreted by the La@TeX{} converter. | |
b349f79f | 8675 | |
a351880d CD |
8676 | @node Previewing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX |
8677 | @subsection Previewing LaTeX fragments | |
8678 | @cindex LaTeX fragments, preview | |
b349f79f | 8679 | |
a351880d CD |
8680 | La@TeX{} fragments can be processed to produce preview images of the |
8681 | typeset expressions: | |
b349f79f CD |
8682 | |
8683 | @table @kbd | |
a351880d CD |
8684 | @kindex C-c C-x C-l |
8685 | @item C-c C-x C-l | |
8686 | Produce a preview image of the La@TeX{} fragment at point and overlay it | |
8687 | over the source code. If there is no fragment at point, process all | |
8688 | fragments in the current entry (between two headlines). When called | |
8689 | with a prefix argument, process the entire subtree. When called with | |
8690 | two prefix arguments, or when the cursor is before the first headline, | |
8691 | process the entire buffer. | |
8692 | @kindex C-c C-c | |
8693 | @item C-c C-c | |
8694 | Remove the overlay preview images. | |
b349f79f CD |
8695 | @end table |
8696 | ||
a351880d CD |
8697 | @vindex org-format-latex-options |
8698 | You can customize the variable @code{org-format-latex-options} to influence | |
8699 | some aspects of the preview. In particular, the @code{:scale} (and for HTML | |
8700 | export, @code{:html-scale}) property can be used to adjust the size of the | |
8701 | preview images. | |
c8d0cf5c | 8702 | |
a351880d CD |
8703 | During HTML export (@pxref{HTML export}), all La@TeX{} fragments are |
8704 | converted into images and inlined into the document if the following | |
8705 | setting is active: | |
c8d0cf5c | 8706 | |
a351880d CD |
8707 | @lisp |
8708 | (setq org-export-with-LaTeX-fragments t) | |
8709 | @end lisp | |
c8d0cf5c | 8710 | |
a351880d CD |
8711 | @node CDLaTeX mode, , Previewing LaTeX fragments, Embedded LaTeX |
8712 | @subsection Using CDLa@TeX{} to enter math | |
8713 | @cindex CDLa@TeX{} | |
8714 | ||
8715 | CDLa@TeX{} mode is a minor mode that is normally used in combination with a | |
8716 | major La@TeX{} mode like AUC@TeX{} in order to speed-up insertion of | |
8717 | environments and math templates. Inside Org mode, you can make use of | |
8718 | some of the features of CDLa@TeX{} mode. You need to install | |
8719 | @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with | |
8720 | AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}. | |
8721 | Don't use CDLa@TeX{} mode itself under Org mode, but use the light | |
8722 | version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it | |
8723 | on for the current buffer with @code{M-x org-cdlatex-mode}, or for all | |
8724 | Org files with | |
8725 | ||
8726 | @lisp | |
8727 | (add-hook 'org-mode-hook 'turn-on-org-cdlatex) | |
8728 | @end lisp | |
8729 | ||
8730 | When this mode is enabled, the following features are present (for more | |
8731 | details see the documentation of CDLa@TeX{} mode): | |
8732 | @itemize @bullet | |
8733 | @kindex C-c @{ | |
8734 | @item | |
8735 | Environment templates can be inserted with @kbd{C-c @{}. | |
8736 | @item | |
8737 | @kindex @key{TAB} | |
8738 | The @key{TAB} key will do template expansion if the cursor is inside a | |
8739 | La@TeX{} fragment@footnote{Org mode has a method to test if the cursor is | |
8740 | inside such a fragment, see the documentation of the function | |
8741 | @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will | |
8742 | expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor | |
8743 | correctly inside the first brace. Another @key{TAB} will get you into | |
8744 | the second brace. Even outside fragments, @key{TAB} will expand | |
8745 | environment abbreviations at the beginning of a line. For example, if | |
8746 | you write @samp{equ} at the beginning of a line and press @key{TAB}, | |
8747 | this abbreviation will be expanded to an @code{equation} environment. | |
8748 | To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}. | |
8749 | @item | |
8750 | @kindex _ | |
8751 | @kindex ^ | |
8752 | @vindex cdlatex-simplify-sub-super-scripts | |
8753 | Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these | |
8754 | characters together with a pair of braces. If you use @key{TAB} to move | |
8755 | out of the braces, and if the braces surround only a single character or | |
8756 | macro, they are removed again (depending on the variable | |
8757 | @code{cdlatex-simplify-sub-super-scripts}). | |
8758 | @item | |
8759 | @kindex ` | |
8760 | Pressing the backquote @kbd{`} followed by a character inserts math | |
8761 | macros, also outside La@TeX{} fragments. If you wait more than 1.5 seconds | |
8762 | after the backquote, a help window will pop up. | |
8763 | @item | |
8764 | @kindex ' | |
8765 | Pressing the single-quote @kbd{'} followed by another character modifies | |
8766 | the symbol before point with an accent or a font. If you wait more than | |
8767 | 1.5 seconds after the backquote, a help window will pop up. Character | |
8768 | modification will work only inside La@TeX{} fragments, outside the quote | |
8769 | is normal. | |
8770 | @end itemize | |
8771 | ||
8772 | @node Exporting, Publishing, Markup, Top | |
8773 | @chapter Exporting | |
8774 | @cindex exporting | |
8775 | ||
8776 | Org-mode documents can be exported into a variety of other formats. For | |
8777 | printing and sharing of notes, ASCII export produces a readable and simple | |
8778 | version of an Org file. HTML export allows you to publish a notes file on | |
8779 | the web, while the XOXO format provides a solid base for exchange with a | |
8780 | broad range of other applications. La@TeX{} export lets you use Org mode and | |
8781 | its structured editing functions to easily create La@TeX{} files. DocBook | |
8782 | export makes it possible to convert Org files to many other formats using | |
8783 | DocBook tools. To incorporate entries with associated times like deadlines | |
8784 | or appointments into a desktop calendar program like iCal, Org mode can also | |
8785 | produce extracts in the iCalendar format. Currently Org mode only supports | |
8786 | export, not import of these different formats. | |
8787 | ||
8788 | Org supports export of selected regions when @code{transient-mark-mode} is | |
8789 | enabled (default in Emacs 23). | |
8790 | ||
8791 | @menu | |
8792 | * Selective export:: Using tags to select and exclude trees | |
8793 | * Export options:: Per-file export settings | |
8794 | * The export dispatcher:: How to access exporter commands | |
8795 | * ASCII export:: Exporting to plain ASCII | |
8796 | * HTML export:: Exporting to HTML | |
8797 | * LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF | |
8798 | * DocBook export:: Exporting to DocBook | |
8799 | * Freemind export:: Exporting to Freemind mind maps | |
8800 | * XOXO export:: Exporting to XOXO | |
8801 | * iCalendar export:: Exporting in iCalendar format | |
8802 | @end menu | |
c8d0cf5c | 8803 | |
a351880d | 8804 | @node Selective export, Export options, Exporting, Exporting |
864c9740 CD |
8805 | @section Selective export |
8806 | @cindex export, selective by tags | |
8807 | ||
c8d0cf5c CD |
8808 | @vindex org-export-select-tags |
8809 | @vindex org-export-exclude-tags | |
864c9740 CD |
8810 | You may use tags to select the parts of a document that should be exported, |
8811 | or to exclude parts from export. This behavior is governed by two variables: | |
8812 | @code{org-export-select-tags} and @code{org-export-exclude-tags}. | |
8813 | ||
8814 | Org first checks if any of the @emph{select} tags is present in the buffer. | |
8815 | If yes, all trees that do not carry one of these tags will be excluded. If a | |
8816 | selected tree is a subtree, the heading hierarchy above it will also be | |
8817 | selected for export, but not the text below those headings. | |
8818 | ||
8819 | @noindent | |
8820 | If none of the select tags is found, the whole buffer will be selected for | |
8821 | export. | |
8822 | ||
8823 | @noindent | |
8824 | Finally, all subtrees that are marked by any of the @emph{exclude} tags will | |
8825 | be removed from the export buffer. | |
8826 | ||
8827 | @node Export options, The export dispatcher, Selective export, Exporting | |
b349f79f CD |
8828 | @section Export options |
8829 | @cindex options, for export | |
8830 | ||
8831 | @cindex completion, of option keywords | |
8832 | The exporter recognizes special lines in the buffer which provide | |
8833 | additional information. These lines may be put anywhere in the file. | |
8834 | The whole set of lines can be inserted into the buffer with @kbd{C-c | |
8835 | C-e t}. For individual lines, a good way to make sure the keyword is | |
8836 | correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion | |
c8d0cf5c CD |
8837 | (@pxref{Completion}). For a summary of other in-buffer settings not |
8838 | specifically related to export, see @ref{In-buffer settings}. | |
8839 | In particular, note that you can place commonly-used (export) options in | |
8840 | a separate file which can be included using @code{#+SETUPFILE}. | |
b349f79f CD |
8841 | |
8842 | @table @kbd | |
8843 | @kindex C-c C-e t | |
8844 | @item C-c C-e t | |
8845 | Insert template with export options, see example below. | |
8846 | @end table | |
8847 | ||
c8d0cf5c CD |
8848 | @cindex #+TITLE |
8849 | @cindex #+AUTHOR | |
8850 | @cindex #+DATE | |
8851 | @cindex #+EMAIL | |
8852 | @cindex #+DESCRIPTION | |
8853 | @cindex #+KEYWORDS | |
8854 | @cindex #+LANGUAGE | |
8855 | @cindex #+TEXT | |
8856 | @cindex #+OPTIONS | |
8857 | @cindex #+BIND | |
8858 | @cindex #+LINK_UP | |
8859 | @cindex #+LINK_HOME | |
8860 | @cindex #+EXPORT_SELECT_TAGS | |
8861 | @cindex #+EXPORT_EXCLUDE_TAGS | |
8862 | @cindex #+LATEX_HEADER | |
8863 | @vindex user-full-name | |
8864 | @vindex user-mail-address | |
8865 | @vindex org-export-default-language | |
8866 | @example | |
8867 | #+TITLE: the title to be shown (default is the buffer name) | |
8868 | #+AUTHOR: the author (default taken from @code{user-full-name}) | |
8869 | #+DATE: a date, fixed, of a format string for @code{format-time-string} | |
8870 | #+EMAIL: his/her email address (default from @code{user-mail-address}) | |
a351880d CD |
8871 | #+DESCRIPTION: the page description, e.g. for the XHTML meta tag |
8872 | #+KEYWORDS: the page keywords, e.g. for the XHTML meta tag | |
8873 | #+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language}) | |
c8d0cf5c CD |
8874 | #+TEXT: Some descriptive text to be inserted at the beginning. |
8875 | #+TEXT: Several lines may be given. | |
8876 | #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ... | |
8877 | #+BIND: lisp-var lisp-val, e.g.: org-export-latex-low-levels itemize | |
8878 | @r{You need to confirm using these, or configure @code{org-export-allow-BIND}} | |
8879 | #+LINK_UP: the ``up'' link of an exported page | |
8880 | #+LINK_HOME: the ``home'' link of an exported page | |
8881 | #+LATEX_HEADER: extra line(s) for the LaTeX header, like \usepackage@{xyz@} | |
864c9740 CD |
8882 | #+EXPORT_SELECT_TAGS: Tags that select a tree for export |
8883 | #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export | |
b349f79f CD |
8884 | @end example |
8885 | ||
8886 | @noindent | |
8887 | The OPTIONS line is a compact@footnote{If you want to configure many options | |
8888 | this way, you can use several OPTIONS lines.} form to specify export settings. Here | |
8889 | you can: | |
8890 | @cindex headline levels | |
8891 | @cindex section-numbers | |
8892 | @cindex table of contents | |
8893 | @cindex line-break preservation | |
8894 | @cindex quoted HTML tags | |
8895 | @cindex fixed-width sections | |
8896 | @cindex tables | |
8897 | @cindex @TeX{}-like syntax for sub- and superscripts | |
8898 | @cindex footnotes | |
8899 | @cindex special strings | |
8900 | @cindex emphasized text | |
8901 | @cindex @TeX{} macros | |
8902 | @cindex La@TeX{} fragments | |
8903 | @cindex author info, in export | |
8904 | @cindex time info, in export | |
8905 | @example | |
8906 | H: @r{set the number of headline levels for export} | |
8907 | num: @r{turn on/off section-numbers} | |
8908 | toc: @r{turn on/off table of contents, or set level limit (integer)} | |
8909 | \n: @r{turn on/off line-break-preservation} | |
8910 | @@: @r{turn on/off quoted HTML tags} | |
8911 | :: @r{turn on/off fixed-width sections} | |
8912 | |: @r{turn on/off tables} | |
8913 | ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If} | |
8914 | @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but} | |
8915 | @r{the simple @code{a_b} will be left as it is.} | |
8916 | -: @r{turn on/off conversion of special strings.} | |
8917 | f: @r{turn on/off footnotes like this[1].} | |
96c8522a CD |
8918 | todo: @r{turn on/off inclusion of TODO keywords into exported text} |
8919 | pri: @r{turn on/off priority cookies} | |
8920 | tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}} | |
8921 | <: @r{turn on/off inclusion of any time/date stamps like DEADLINES} | |
b349f79f CD |
8922 | *: @r{turn on/off emphasized text (bold, italic, underlined)} |
8923 | TeX: @r{turn on/off simple @TeX{} macros in plain text} | |
8924 | LaTeX: @r{turn on/off La@TeX{} fragments} | |
8925 | skip: @r{turn on/off skipping the text before the first heading} | |
8926 | author: @r{turn on/off inclusion of author name/email into exported file} | |
dd12e1c6 | 8927 | creator: @r{turn on/off inclusion of creator info into exported file} |
b349f79f CD |
8928 | timestamp: @r{turn on/off inclusion creation time into exported file} |
8929 | d: @r{turn on/off inclusion of drawers} | |
8930 | @end example | |
c8d0cf5c | 8931 | @noindent |
b349f79f CD |
8932 | These options take effect in both the HTML and La@TeX{} export, except |
8933 | for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and | |
8934 | @code{nil} for the La@TeX{} export. | |
8935 | ||
8936 | When exporting only a single subtree by selecting it with @kbd{C-c @@} before | |
8937 | calling an export command, the subtree can overrule some of the file's export | |
8938 | settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE}, | |
c8d0cf5c CD |
8939 | @code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and |
8940 | @code{EXPORT_OPTIONS}. | |
b349f79f CD |
8941 | |
8942 | @node The export dispatcher, ASCII export, Export options, Exporting | |
8943 | @section The export dispatcher | |
8944 | @cindex dispatcher, for export commands | |
8945 | ||
8946 | All export commands can be reached using the export dispatcher, which is a | |
8947 | prefix key that prompts for an additional key specifying the command. | |
8948 | Normally the entire file is exported, but if there is an active region that | |
8949 | contains one outline tree, the first heading is used as document title and | |
8950 | the subtrees are exported. | |
4009494e GM |
8951 | |
8952 | @table @kbd | |
8953 | @kindex C-c C-e | |
8954 | @item C-c C-e | |
c8d0cf5c | 8955 | @vindex org-export-run-in-background |
4009494e GM |
8956 | Dispatcher for export and publishing commands. Displays a help-window |
8957 | listing the additional key(s) needed to launch an export or publishing | |
64fb801f CD |
8958 | command. The prefix arg is passed through to the exporter. A double prefix |
8959 | @kbd{C-u C-u} causes most commands to be executed in the background, in a | |
c8d0cf5c | 8960 | separate Emacs process@footnote{To make this behavior the default, customize |
64fb801f | 8961 | the variable @code{org-export-run-in-background}.}. |
b349f79f CD |
8962 | @kindex C-c C-e v |
8963 | @item C-c C-e v | |
8964 | Like @kbd{C-c C-e}, but only export the text that is currently visible | |
a351880d | 8965 | (i.e. not hidden by outline visibility). |
a7808fba CD |
8966 | @kindex C-u C-u C-c C-e |
8967 | @item C-u C-u C-c C-e | |
c8d0cf5c | 8968 | @vindex org-export-run-in-background |
a7808fba | 8969 | Call an the exporter, but reverse the setting of |
a351880d | 8970 | @code{org-export-run-in-background}, i.e. request background processing if |
c8d0cf5c | 8971 | not set, or force processing in the current Emacs process if set. |
4009494e GM |
8972 | @end table |
8973 | ||
b349f79f | 8974 | @node ASCII export, HTML export, The export dispatcher, Exporting |
4009494e GM |
8975 | @section ASCII export |
8976 | @cindex ASCII export | |
8977 | ||
c8d0cf5c | 8978 | ASCII export produces a simple and very readable version of an Org-mode |
4009494e GM |
8979 | file. |
8980 | ||
8981 | @cindex region, active | |
8982 | @cindex active region | |
b6cb4cd5 | 8983 | @cindex transient-mark-mode |
4009494e GM |
8984 | @table @kbd |
8985 | @kindex C-c C-e a | |
8986 | @item C-c C-e a | |
c8d0cf5c CD |
8987 | @cindex property, EXPORT_FILE_NAME |
8988 | Export as ASCII file. For an Org file, @file{myfile.org}, the ASCII file | |
4009494e | 8989 | will be @file{myfile.txt}. The file will be overwritten without |
c8d0cf5c CD |
8990 | warning. If there is an active region@footnote{This requires |
8991 | @code{transient-mark-mode} be turned on.}, only the region will be | |
b349f79f CD |
8992 | exported. If the selected region is a single tree@footnote{To select the |
8993 | current subtree, use @kbd{C-c @@}.}, the tree head will | |
4009494e | 8994 | become the document title. If the tree head entry has or inherits an |
b349f79f | 8995 | @code{EXPORT_FILE_NAME} property, that name will be used for the |
28a16a1b | 8996 | export. |
c8d0cf5c CD |
8997 | @kindex C-c C-e A |
8998 | @item C-c C-e A | |
8999 | Export to a temporary buffer, do not create a file. | |
4009494e GM |
9000 | @kindex C-c C-e v a |
9001 | @item C-c C-e v a | |
9002 | Export only the visible part of the document. | |
9003 | @end table | |
9004 | ||
9005 | @cindex headline levels, for exporting | |
9006 | In the exported version, the first 3 outline levels will become | |
9007 | headlines, defining a general document structure. Additional levels | |
9008 | will be exported as itemized lists. If you want that transition to occur | |
9009 | at a different level, specify it with a prefix argument. For example, | |
9010 | ||
9011 | @example | |
9012 | @kbd{C-1 C-c C-e a} | |
9013 | @end example | |
9014 | ||
9015 | @noindent | |
9016 | creates only top level headlines and does the rest as items. When | |
9017 | headlines are converted to items, the indentation of the text following | |
9018 | the headline is changed to fit nicely under the item. This is done with | |
a7808fba | 9019 | the assumption that the first body line indicates the base indentation of |
4009494e GM |
9020 | the body text. Any indentation larger than this is adjusted to preserve |
9021 | the layout relative to the first line. Should there be lines with less | |
9022 | indentation than the first, these are left alone. | |
9023 | ||
c8d0cf5c CD |
9024 | @vindex org-export-ascii-links-to-notes |
9025 | Links will be exported in a footnote-like style, with the descriptive part in | |
9026 | the text and the link in a note before the next heading. See the variable | |
9027 | @code{org-export-ascii-links-to-notes} for details and other options. | |
9028 | ||
71d35b24 | 9029 | @node HTML export, LaTeX and PDF export, ASCII export, Exporting |
4009494e GM |
9030 | @section HTML export |
9031 | @cindex HTML export | |
9032 | ||
a7808fba | 9033 | Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive |
b6cb4cd5 | 9034 | HTML formatting, in ways similar to John Gruber's @emph{markdown} |
4009494e GM |
9035 | language, but with additional support for tables. |
9036 | ||
9037 | @menu | |
b349f79f | 9038 | * HTML Export commands:: How to invoke HTML export |
a7808fba | 9039 | * Quoting HTML tags:: Using direct HTML in Org mode |
a351880d | 9040 | * Links in HTML export:: How links will be interpreted and formatted |
c8d0cf5c | 9041 | * Tables in HTML export:: How to modify the formatting of tables |
55e0839d CD |
9042 | * Images in HTML export:: How to insert figures into HTML output |
9043 | * Text areas in HTML export:: An alternative way to show an example | |
a7808fba CD |
9044 | * CSS support:: Changing the appearance of the output |
9045 | * Javascript support:: Info and Folding in a web browser | |
4009494e GM |
9046 | @end menu |
9047 | ||
9048 | @node HTML Export commands, Quoting HTML tags, HTML export, HTML export | |
9049 | @subsection HTML export commands | |
9050 | ||
9051 | @cindex region, active | |
9052 | @cindex active region | |
b6cb4cd5 | 9053 | @cindex transient-mark-mode |
4009494e GM |
9054 | @table @kbd |
9055 | @kindex C-c C-e h | |
9056 | @item C-c C-e h | |
c8d0cf5c CD |
9057 | @cindex property, EXPORT_FILE_NAME |
9058 | Export as HTML file @file{myfile.html}. For an Org file @file{myfile.org}, | |
b349f79f | 9059 | the ASCII file will be @file{myfile.html}. The file will be overwritten |
c8d0cf5c CD |
9060 | without warning. If there is an active region@footnote{This requires |
9061 | @code{transient-mark-mode} be turned on.}, only the region will be | |
b349f79f CD |
9062 | exported. If the selected region is a single tree@footnote{To select the |
9063 | current subtree, use @kbd{C-c @@}.}, the tree head will become the document | |
b6cb4cd5 | 9064 | title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME} |
b349f79f | 9065 | property, that name will be used for the export. |
4009494e GM |
9066 | @kindex C-c C-e b |
9067 | @item C-c C-e b | |
9068 | Export as HTML file and immediately open it with a browser. | |
9069 | @kindex C-c C-e H | |
9070 | @item C-c C-e H | |
9071 | Export to a temporary buffer, do not create a file. | |
9072 | @kindex C-c C-e R | |
dbc28aaa | 9073 | @item C-c C-e R |
a7808fba CD |
9074 | Export the active region to a temporary buffer. With a prefix argument, do |
9075 | not produce the file header and footer, but just the plain HTML section for | |
9076 | the region. This is good for cut-and-paste operations. | |
4009494e GM |
9077 | @kindex C-c C-e v h |
9078 | @kindex C-c C-e v b | |
9079 | @kindex C-c C-e v H | |
9080 | @kindex C-c C-e v R | |
9081 | @item C-c C-e v h | |
9082 | @item C-c C-e v b | |
9083 | @item C-c C-e v H | |
9084 | @item C-c C-e v R | |
9085 | Export only the visible part of the document. | |
9086 | @item M-x org-export-region-as-html | |
c8d0cf5c | 9087 | Convert the region to HTML under the assumption that it was Org-mode |
4009494e GM |
9088 | syntax before. This is a global command that can be invoked in any |
9089 | buffer. | |
9090 | @item M-x org-replace-region-by-HTML | |
c8d0cf5c | 9091 | Replace the active region (assumed to be in Org-mode syntax) by HTML |
4009494e GM |
9092 | code. |
9093 | @end table | |
9094 | ||
9095 | @cindex headline levels, for exporting | |
a7808fba CD |
9096 | In the exported version, the first 3 outline levels will become headlines, |
9097 | defining a general document structure. Additional levels will be exported as | |
9098 | itemized lists. If you want that transition to occur at a different level, | |
9099 | specify it with a numeric prefix argument. For example, | |
4009494e GM |
9100 | |
9101 | @example | |
9102 | @kbd{C-2 C-c C-e b} | |
9103 | @end example | |
9104 | ||
9105 | @noindent | |
9106 | creates two levels of headings and does the rest as items. | |
9107 | ||
a351880d | 9108 | @node Quoting HTML tags, Links in HTML export, HTML Export commands, HTML export |
4009494e GM |
9109 | @subsection Quoting HTML tags |
9110 | ||
9111 | Plain @samp{<} and @samp{>} are always transformed to @samp{<} and | |
9112 | @samp{>} in HTML export. If you want to include simple HTML tags | |
9113 | which should be interpreted as such, mark them with @samp{@@} as in | |
9114 | @samp{@@<b>bold text@@</b>}. Note that this really works only for | |
9115 | simple tags. For more extensive HTML that should be copied verbatim to | |
9116 | the exported file use either | |
9117 | ||
c8d0cf5c CD |
9118 | @cindex #+HTML |
9119 | @cindex #+BEGIN_HTML | |
4009494e GM |
9120 | @example |
9121 | #+HTML: Literal HTML code for export | |
9122 | @end example | |
9123 | ||
9124 | @noindent or | |
b349f79f | 9125 | @cindex #+BEGIN_HTML |
4009494e GM |
9126 | |
9127 | @example | |
9128 | #+BEGIN_HTML | |
9129 | All lines between these markers are exported literally | |
9130 | #+END_HTML | |
9131 | @end example | |
9132 | ||
9133 | ||
a351880d CD |
9134 | @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export |
9135 | @subsection Links in HTML export | |
4009494e GM |
9136 | |
9137 | @cindex links, in HTML export | |
9138 | @cindex internal links, in HTML export | |
9139 | @cindex external links, in HTML export | |
55e0839d | 9140 | Internal links (@pxref{Internal links}) will continue to work in HTML. This |
c8d0cf5c | 9141 | includes automatic links created by radio targets (@pxref{Radio |
55e0839d CD |
9142 | targets}). Links to external files will still work if the target file is on |
9143 | the same @i{relative} path as the published Org file. Links to other | |
9144 | @file{.org} files will be translated into HTML links under the assumption | |
9145 | that an HTML version also exists of the linked file, at the same relative | |
9146 | path. @samp{id:} links can then be used to jump to specific entries across | |
9147 | files. For information related to linking files while publishing them to a | |
9148 | publishing directory see @ref{Publishing links}. | |
4009494e | 9149 | |
44ce9197 | 9150 | If you want to specify attributes for links, you can do so using a special |
a50253cc | 9151 | @code{#+ATTR_HTML} line to define attributes that will be added to the |
c8d0cf5c CD |
9152 | @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title} |
9153 | and @code{style} attributes for a link: | |
44ce9197 | 9154 | |
c8d0cf5c | 9155 | @cindex #+ATTR_HTML |
44ce9197 | 9156 | @example |
c8d0cf5c CD |
9157 | #+ATTR_HTML: title="The Org-mode homepage" style="color:red;" |
9158 | [[http://orgmode.org]] | |
9159 | @end example | |
9160 | ||
a351880d | 9161 | @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export |
c8d0cf5c CD |
9162 | @subsection Tables |
9163 | @cindex tables, in HTML | |
9164 | @vindex org-export-html-table-tag | |
9165 | ||
9166 | Org-mode tables are exported to HTML using the table tag defined in | |
9167 | @code{org-export-html-table-tag}. The default setting makes tables without | |
9168 | cell borders and frame. If you would like to change this for individual | |
e1d294ab | 9169 | tables, place something like the following before the table: |
c8d0cf5c CD |
9170 | |
9171 | @cindex #+CAPTION | |
a351880d | 9172 | @cindex #+ATTR_HTML |
c8d0cf5c CD |
9173 | @example |
9174 | #+CAPTION: This is a table with lines around and between cells | |
9175 | #+ATTR_HTML: border="2" rules="all" frame="all" | |
44ce9197 CD |
9176 | @end example |
9177 | ||
c8d0cf5c | 9178 | @node Images in HTML export, Text areas in HTML export, Tables in HTML export, HTML export |
a351880d | 9179 | @subsection Images in HTML export |
4009494e GM |
9180 | |
9181 | @cindex images, inline in HTML | |
9182 | @cindex inlining images in HTML | |
c8d0cf5c | 9183 | @vindex org-export-html-inline-images |
a7808fba | 9184 | HTML export can inline images given as links in the Org file, and |
4009494e | 9185 | it can make an image the clickable part of a link. By |
c8d0cf5c CD |
9186 | default@footnote{But see the variable |
9187 | @code{org-export-html-inline-images}.}, images are inlined if a link does | |
4009494e GM |
9188 | not have a description. So @samp{[[file:myimg.jpg]]} will be inlined, |
9189 | while @samp{[[file:myimg.jpg][the image]]} will just produce a link | |
9190 | @samp{the image} that points to the image. If the description part | |
9191 | itself is a @code{file:} link or a @code{http:} URL pointing to an | |
9192 | image, this image will be inlined and activated so that clicking on the | |
9193 | image will activate the link. For example, to include a thumbnail that | |
9194 | will link to a high resolution version of the image, you could use: | |
9195 | ||
9196 | @example | |
9197 | [[file:highres.jpg][file:thumb.jpg]] | |
9198 | @end example | |
9199 | ||
a351880d CD |
9200 | If you need to add attributes to an inlines image, use a @code{#+ATTR_HTML}. |
9201 | In the example below we specify the @code{alt} and @code{title} attributes to | |
9202 | support text viewers and accessibility, and align it to the right. | |
c8d0cf5c CD |
9203 | |
9204 | @cindex #+CAPTION | |
a351880d | 9205 | @cindex #+ATTR_HTML |
c8d0cf5c CD |
9206 | @example |
9207 | #+CAPTION: A black cat stalking a spider | |
a351880d | 9208 | #+ATTR_HTML: alt="cat/spider image" title="Action!" align="right" |
c8d0cf5c CD |
9209 | [[./img/a.jpg]] |
9210 | @end example | |
9211 | ||
4009494e GM |
9212 | @noindent |
9213 | and you could use @code{http} addresses just as well. | |
9214 | ||
55e0839d | 9215 | @node Text areas in HTML export, CSS support, Images in HTML export, HTML export |
a351880d | 9216 | @subsection Text areas in HTML export |
55e0839d CD |
9217 | |
9218 | @cindex text areas, in HTML | |
9219 | An alternative way to publish literal code examples in HTML is to use text | |
9220 | areas, where the example can even be edited before pasting it into an | |
9221 | application. It is triggered by a @code{-t} switch at an @code{example} or | |
9222 | @code{src} block. Using this switch disables any options for syntax and | |
9223 | label highlighting, and line numbering, which may be present. You may also | |
9224 | use @code{-h} and @code{-w} switches to specify the height and width of the | |
9225 | text area, which default to the number of lines in the example, and 80, | |
9226 | respectively. For example | |
9227 | ||
9228 | @example | |
9229 | #+BEGIN_EXAMPLE -t -w 40 | |
9230 | (defun org-xor (a b) | |
9231 | "Exclusive or." | |
9232 | (if a (not b) b)) | |
9233 | #+END_EXAMPLE | |
9234 | @end example | |
9235 | ||
9236 | ||
9237 | @node CSS support, Javascript support, Text areas in HTML export, HTML export | |
4009494e | 9238 | @subsection CSS support |
a7808fba CD |
9239 | @cindex CSS, for HTML export |
9240 | @cindex HTML export, CSS | |
4009494e | 9241 | |
c8d0cf5c CD |
9242 | @vindex org-export-html-todo-kwd-class-prefix |
9243 | @vindex org-export-html-tag-class-prefix | |
55e0839d | 9244 | You can also give style information for the exported file. The HTML exporter |
c8d0cf5c CD |
9245 | assigns the following special CSS classes@footnote{If the classes on TODO |
9246 | keywords and tags lead to conflicts, use the variables | |
9247 | @code{org-export-html-todo-kwd-class-prefix} and | |
9248 | @code{org-export-html-tag-class-prefix} to make them unique.} to appropriate | |
9249 | parts of the document---your style specifications may change these, in | |
9250 | addition to any of the standard classes like for headlines, tables, etc. | |
9251 | @example | |
9252 | p.author @r{author information, including email} | |
9253 | p.date @r{publishing date} | |
9254 | p.creator @r{creator info, about org-mode version} | |
9255 | .title @r{document title} | |
9256 | .todo @r{TODO keywords, all not-done states} | |
9257 | .done @r{the DONE keywords, all stated the count as done} | |
9258 | .WAITING @r{each TODO keyword also uses a class named after itself} | |
9259 | .timestamp @r{timestamp} | |
9260 | .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED} | |
9261 | .timestamp-wrapper @r{span around keyword plus timestamp} | |
9262 | .tag @r{tag in a headline} | |
9263 | ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"} | |
9264 | .target @r{target for links} | |
9265 | .linenr @r{the line number in a code example} | |
9266 | .code-highlighted @r{for highlighting referenced code lines} | |
9267 | div.outline-N @r{div for outline level N (headline plus text))} | |
9268 | div.outline-text-N @r{extra div for text at outline level N} | |
9269 | .section-number-N @r{section number in headlines, different for each level} | |
9270 | div.figure @r{how to format an inlined image} | |
9271 | pre.src @r{formatted source code} | |
9272 | pre.example @r{normal example} | |
9273 | p.verse @r{verse paragraph} | |
9274 | div.footnotes @r{footnote section headline} | |
9275 | p.footnote @r{footnote definition paragraph, containing a footnote} | |
9276 | .footref @r{a footnote reference number (always a <sup>)} | |
9277 | .footnum @r{footnote number in footnote definition (always <sup>)} | |
9278 | @end example | |
9279 | ||
9280 | @vindex org-export-html-style-default | |
9281 | @vindex org-export-html-style-include-default | |
9282 | @vindex org-export-html-style | |
9283 | @vindex org-export-html-extra | |
9284 | @vindex org-export-html-style-default | |
9285 | Each exported file contains a compact default style that defines these | |
e45e3595 CD |
9286 | classes in a basic way@footnote{This style is defined in the constant |
9287 | @code{org-export-html-style-default}, which you should not modify. To turn | |
9288 | inclusion of these defaults off, customize | |
9289 | @code{org-export-html-style-include-default}}. You may overwrite these | |
9290 | settings, or add to them by using the variables @code{org-export-html-style} | |
9291 | (for Org-wide settings) and @code{org-export-html-style-extra} (for more | |
9292 | granular settings, like file-local settings). To set the latter variable | |
9293 | individually for each file, you can use | |
4009494e | 9294 | |
c8d0cf5c | 9295 | @cindex #+STYLE |
4009494e | 9296 | @example |
864c9740 | 9297 | #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" /> |
4009494e GM |
9298 | @end example |
9299 | ||
864c9740 | 9300 | @noindent |
e45e3595 CD |
9301 | For longer style definitions, you can use several such lines. You could also |
9302 | directly write a @code{<style>} @code{</style>} section in this way, without | |
9303 | referring to an external file. | |
4009494e GM |
9304 | |
9305 | @c FIXME: More about header and footer styles | |
9306 | @c FIXME: Talk about links and targets. | |
9307 | ||
a7808fba CD |
9308 | @node Javascript support, , CSS support, HTML export |
9309 | @subsection Javascript supported display of web pages | |
9310 | ||
c8d0cf5c CD |
9311 | @cindex Rose, Sebastian |
9312 | Sebastian Rose has written a JavaScript program especially designed to | |
a7808fba | 9313 | enhance the web viewing experience of HTML files created with Org. This |
55e0839d CD |
9314 | program allows you to view large files in two different ways. The first one |
9315 | is an @emph{Info}-like mode where each section is displayed separately and | |
a7808fba CD |
9316 | navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys |
9317 | as well, press @kbd{?} for an overview of the available keys). The second | |
55e0839d CD |
9318 | view type is a @emph{folding} view much like Org provides inside Emacs. The |
9319 | script is available at @url{http://orgmode.org/org-info.js} and you can find | |
9320 | the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}. | |
c8d0cf5c | 9321 | We host the script at our site, but if you use it a lot, you might |
55e0839d CD |
9322 | not want to be dependent on @url{orgmode.org} and prefer to install a local |
9323 | copy on your own web server. | |
a7808fba | 9324 | |
b349f79f | 9325 | To use the script, you need to make sure that the @file{org-jsinfo.el} module |
b6cb4cd5 CD |
9326 | gets loaded. It should be loaded by default, but you can try @kbd{M-x |
9327 | customize-variable @key{RET} org-modules @key{RET}} to convince yourself that | |
9328 | this is indeed the case. All it then takes to make use of the program is | |
9329 | adding a single line to the Org file: | |
a7808fba | 9330 | |
c8d0cf5c | 9331 | @cindex #+INFOJS_OPT |
a7808fba | 9332 | @example |
b349f79f | 9333 | #+INFOJS_OPT: view:info toc:nil |
a7808fba CD |
9334 | @end example |
9335 | ||
9336 | @noindent | |
9337 | If this line is found, the HTML header will automatically contain the code | |
9338 | needed to invoke the script. Using the line above, you can set the following | |
9339 | viewing options: | |
9340 | ||
9341 | @example | |
9342 | path: @r{The path to the script. The default is to grab the script from} | |
9343 | @r{@url{http://orgmode.org/org-info.js}, but you might want to have} | |
9344 | @r{a local copy and use a path like @samp{../scripts/org-info.js}.} | |
b349f79f | 9345 | view: @r{Initial view when website is first shown. Possible values are:} |
a7808fba CD |
9346 | info @r{Info-like interface with one section per page.} |
9347 | overview @r{Folding interface, initially showing only top-level.} | |
9348 | content @r{Folding interface, starting with all headlines visible.} | |
9349 | showall @r{Folding interface, all headlines and text visible.} | |
9350 | sdepth: @r{Maximum headline level that will still become an independent} | |
9351 | @r{section for info and folding modes. The default is taken from} | |
7006d207 CD |
9352 | @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).} |
9353 | @r{If this is smaller than in @code{org-export-headline-levels}, each} | |
c8d0cf5c | 9354 | @r{info/folding section can still contain child headlines.} |
a7808fba | 9355 | toc: @r{Should the table of content @emph{initially} be visible?} |
c8d0cf5c | 9356 | @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.} |
a7808fba | 9357 | tdepth: @r{The depth of the table of contents. The defaults are taken from} |
7006d207 | 9358 | @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.} |
c8d0cf5c | 9359 | ftoc: @r{Does the css of the page specify a fixed position for the "toc"?} |
b349f79f | 9360 | @r{If yes, the toc will never be displayed as a section.} |
a7808fba | 9361 | ltoc: @r{Should there be short contents (children) in each section?} |
c8d0cf5c | 9362 | @r{Make this @code{above} if the section should be above initial text.} |
a7808fba CD |
9363 | mouse: @r{Headings are highlighted when the mouse is over them. Should be} |
9364 | @r{@samp{underline} (default) or a background color like @samp{#cccccc}.} | |
9365 | buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the} | |
9366 | @r{default), only one such button will be present.} | |
9367 | @end example | |
c8d0cf5c CD |
9368 | @noindent |
9369 | @vindex org-infojs-options | |
9370 | @vindex org-export-html-use-infojs | |
a7808fba CD |
9371 | You can choose default values for these options by customizing the variable |
9372 | @code{org-infojs-options}. If you always want to apply the script to your | |
9373 | pages, configure the variable @code{org-export-html-use-infojs}. | |
9374 | ||
c8d0cf5c CD |
9375 | @node LaTeX and PDF export, DocBook export, HTML export, Exporting |
9376 | @section La@TeX{} and PDF export | |
9377 | @cindex La@TeX{} export | |
71d35b24 | 9378 | @cindex PDF export |
72d803ad | 9379 | @cindex Guerry, Bastien |
4009494e | 9380 | |
71d35b24 CD |
9381 | Org mode contains a La@TeX{} exporter written by Bastien Guerry. With |
9382 | further processing, this backend is also used to produce PDF output. Since | |
c8d0cf5c | 9383 | the La@TeX{} output uses @file{hyperref} to implement links and cross |
71d35b24 | 9384 | references, the PDF output file will be fully linked. |
4009494e GM |
9385 | |
9386 | @menu | |
a50253cc | 9387 | * LaTeX/PDF export commands:: Which key invokes which commands |
c8d0cf5c CD |
9388 | * Quoting LaTeX code:: Incorporating literal La@TeX{} code |
9389 | * Sectioning structure:: Changing sectioning in La@TeX{} output | |
9390 | * Tables in LaTeX export:: Options for exporting tables to La@TeX{} | |
9391 | * Images in LaTeX export:: How to insert figures into La@TeX{} output | |
4009494e GM |
9392 | @end menu |
9393 | ||
71d35b24 | 9394 | @node LaTeX/PDF export commands, Quoting LaTeX code, LaTeX and PDF export, LaTeX and PDF export |
c8d0cf5c | 9395 | @subsection La@TeX{} export commands |
4009494e | 9396 | |
b6cb4cd5 CD |
9397 | @cindex region, active |
9398 | @cindex active region | |
9399 | @cindex transient-mark-mode | |
4009494e GM |
9400 | @table @kbd |
9401 | @kindex C-c C-e l | |
9402 | @item C-c C-e l | |
c8d0cf5c CD |
9403 | @cindex property EXPORT_FILE_NAME |
9404 | Export as La@TeX{} file @file{myfile.tex}. For an Org file | |
b349f79f | 9405 | @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will |
c8d0cf5c CD |
9406 | be overwritten without warning. If there is an active region@footnote{This |
9407 | requires @code{transient-mark-mode} be turned on.}, only the region will be | |
b6cb4cd5 CD |
9408 | exported. If the selected region is a single tree@footnote{To select the |
9409 | current subtree, use @kbd{C-c @@}.}, the tree head will become the document | |
9410 | title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME} | |
9411 | property, that name will be used for the export. | |
4009494e GM |
9412 | @kindex C-c C-e L |
9413 | @item C-c C-e L | |
9414 | Export to a temporary buffer, do not create a file. | |
9415 | @kindex C-c C-e v l | |
9416 | @kindex C-c C-e v L | |
9417 | @item C-c C-e v l | |
9418 | @item C-c C-e v L | |
9419 | Export only the visible part of the document. | |
9420 | @item M-x org-export-region-as-latex | |
a7808fba | 9421 | Convert the region to La@TeX{} under the assumption that it was Org mode |
4009494e GM |
9422 | syntax before. This is a global command that can be invoked in any |
9423 | buffer. | |
9424 | @item M-x org-replace-region-by-latex | |
a7808fba | 9425 | Replace the active region (assumed to be in Org mode syntax) by La@TeX{} |
4009494e | 9426 | code. |
71d35b24 CD |
9427 | @kindex C-c C-e p |
9428 | @item C-c C-e p | |
c8d0cf5c | 9429 | Export as La@TeX{} and then process to PDF. |
71d35b24 CD |
9430 | @kindex C-c C-e d |
9431 | @item C-c C-e d | |
c8d0cf5c | 9432 | Export as La@TeX{} and then process to PDF, then open the resulting PDF file. |
4009494e GM |
9433 | @end table |
9434 | ||
9435 | @cindex headline levels, for exporting | |
c8d0cf5c | 9436 | @vindex org-latex-low-levels |
4009494e GM |
9437 | In the exported version, the first 3 outline levels will become |
9438 | headlines, defining a general document structure. Additional levels | |
9439 | will be exported as description lists. The exporter can ignore them or | |
9440 | convert them to a custom string depending on | |
9441 | @code{org-latex-low-levels}. | |
9442 | ||
9443 | If you want that transition to occur at a different level, specify it | |
a7808fba | 9444 | with a numeric prefix argument. For example, |
4009494e GM |
9445 | |
9446 | @example | |
9447 | @kbd{C-2 C-c C-e l} | |
9448 | @end example | |
9449 | ||
9450 | @noindent | |
9451 | creates two levels of headings and does the rest as items. | |
9452 | ||
71d35b24 | 9453 | @node Quoting LaTeX code, Sectioning structure, LaTeX/PDF export commands, LaTeX and PDF export |
c8d0cf5c | 9454 | @subsection Quoting La@TeX{} code |
4009494e | 9455 | |
c8d0cf5c | 9456 | Embedded La@TeX{} as described in @ref{Embedded LaTeX}, will be correctly |
55e0839d CD |
9457 | inserted into the La@TeX{} file. This includes simple macros like |
9458 | @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore, | |
9459 | you can add special code that should only be present in La@TeX{} export with | |
9460 | the following constructs: | |
4009494e | 9461 | |
c8d0cf5c CD |
9462 | @cindex #+LaTeX |
9463 | @cindex #+BEGIN_LaTeX | |
4009494e GM |
9464 | @example |
9465 | #+LaTeX: Literal LaTeX code for export | |
9466 | @end example | |
9467 | ||
9468 | @noindent or | |
b349f79f | 9469 | @cindex #+BEGIN_LaTeX |
4009494e GM |
9470 | |
9471 | @example | |
9472 | #+BEGIN_LaTeX | |
9473 | All lines between these markers are exported literally | |
9474 | #+END_LaTeX | |
9475 | @end example | |
dbc28aaa | 9476 | |
55e0839d | 9477 | @node Sectioning structure, Tables in LaTeX export, Quoting LaTeX code, LaTeX and PDF export |
dbc28aaa | 9478 | @subsection Sectioning structure |
c8d0cf5c CD |
9479 | @cindex La@TeX{} class |
9480 | @cindex La@TeX{} sectioning structure | |
dbc28aaa CD |
9481 | |
9482 | By default, the La@TeX{} output uses the class @code{article}. | |
9483 | ||
c8d0cf5c CD |
9484 | @vindex org-export-latex-default-class |
9485 | @vindex org-export-latex-classes | |
9486 | @cindex #+LATEX_HEADER | |
9487 | @cindex #+LATEX_CLASS | |
9488 | @cindex property, LATEX_CLASS | |
dbc28aaa | 9489 | You can change this globally by setting a different value for |
71d35b24 | 9490 | @code{org-export-latex-default-class} or locally by adding an option like |
55e0839d CD |
9491 | @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:} |
9492 | property that applies when exporting a region containing only this (sub)tree. | |
9493 | The class should be listed in @code{org-export-latex-classes}, where you can | |
9494 | also define the sectioning structure for each class, as well as defining | |
c8d0cf5c CD |
9495 | additional classes. You can also use @code{#+LATEX_HEADER: |
9496 | \usepackage@{xyz@}} to add lines to the header. | |
dbc28aaa | 9497 | |
67df9cfb | 9498 | @node Tables in LaTeX export, Images in LaTeX export, Sectioning structure, LaTeX and PDF export |
c8d0cf5c CD |
9499 | @subsection Tables in La@TeX{} export |
9500 | @cindex tables, in La@TeX{} export | |
67df9cfb | 9501 | |
c8d0cf5c | 9502 | For La@TeX{} export of a table, you can specify a label and a caption |
a351880d | 9503 | (@pxref{Images and tables}). You can also use the @code{ATTR_LaTeX} line to |
67df9cfb | 9504 | request a longtable environment for the table, so that it may span several |
c8d0cf5c | 9505 | pages. Finally, you can set the alignment string: |
67df9cfb | 9506 | |
c8d0cf5c CD |
9507 | @cindex #+CAPTION |
9508 | @cindex #+LABEL | |
9509 | @cindex #+ATTR_LaTeX | |
67df9cfb CD |
9510 | @example |
9511 | #+CAPTION: A long table | |
9512 | #+LABEL: tbl:long | |
c8d0cf5c | 9513 | #+ATTR_LaTeX: longtable align=l|lp@{3cm@}r|l |
67df9cfb CD |
9514 | | ..... | ..... | |
9515 | | ..... | ..... | | |
9516 | @end example | |
9517 | ||
9518 | ||
9519 | @node Images in LaTeX export, , Tables in LaTeX export, LaTeX and PDF export | |
c8d0cf5c CD |
9520 | @subsection Images in La@TeX{} export |
9521 | @cindex images, inline in La@TeX{} | |
9522 | @cindex inlining images in La@TeX{} | |
67df9cfb CD |
9523 | |
9524 | Images that are linked to without a description part in the link, like | |
9525 | @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF | |
a351880d | 9526 | output file resulting from La@TeX{} processing. Org will use an |
67df9cfb | 9527 | @code{\includegraphics} macro to insert the image. If you have specified a |
a351880d CD |
9528 | caption and/or a label as described in @ref{Images and tables}, the figure |
9529 | will be wrapped into a @code{figure} environment and thus become a floating | |
9530 | element. You can use an @code{#+ATTR_LaTeX:} line to specify the various | |
67df9cfb | 9531 | options that can be used in the optional argument of the |
a351880d CD |
9532 | @code{\includegraphics} macro. To modify the placement option of the |
9533 | @code{figure} environment, add something like @samp{placement=[h!]} to the | |
9534 | Attributes. | |
9535 | ||
9536 | If you'd like to let text flow around the image, add the word @samp{wrap} to | |
9537 | the @code{#+ATTR_LaTeX:} line, which will make the figure occupy the left | |
9538 | half of the page. To fine-tune, the @code{placement} field will be the | |
9539 | set of additional arguments needed by the @code{wrapfigure} environment. | |
9540 | Note that if you change the size of the image, you need to use compatible | |
9541 | settings for @code{\includegraphics} and @code{wrapfigure}. | |
67df9cfb | 9542 | |
c8d0cf5c CD |
9543 | @cindex #+CAPTION |
9544 | @cindex #+LABEL | |
9545 | @cindex #+ATTR_LaTeX | |
67df9cfb CD |
9546 | @example |
9547 | #+CAPTION: The black-body emission of the disk around HR 4049 | |
9548 | #+LABEL: fig:SED-HR4049 | |
9549 | #+ATTR_LaTeX: width=5cm,angle=90 | |
9550 | [[./img/sed-hr4049.pdf]] | |
a351880d CD |
9551 | |
9552 | #+ATTR_LaTeX: width=0.38\textwidth wrap placement=@{r@}@{0.4\textwidth@} | |
9553 | [[./img/hst.png]] | |
67df9cfb CD |
9554 | @end example |
9555 | ||
55e0839d | 9556 | If you need references to a label created in this way, write |
a351880d | 9557 | @samp{\ref@{fig:SED-HR4049@}} just like in La@TeX{}. |
67df9cfb | 9558 | |
a351880d | 9559 | @node DocBook export, Freemind export, LaTeX and PDF export, Exporting |
c8d0cf5c CD |
9560 | @section DocBook export |
9561 | @cindex DocBook export | |
9562 | @cindex PDF export | |
9563 | @cindex Cui, Baoqui | |
9564 | ||
9565 | Org contains a DocBook exporter written by Baoqiu Cui. Once an Org file is | |
9566 | exported to DocBook format, it can be further processed to produce other | |
9567 | formats, including PDF, HTML, man pages, etc., using many available DocBook | |
9568 | tools and stylesheets. | |
9569 | ||
9570 | Currently DocBook exporter only supports DocBook V5.0. | |
9571 | ||
9572 | @menu | |
9573 | * DocBook export commands:: How to invoke DocBook export | |
9574 | * Quoting DocBook code:: Incorporating DocBook code in Org files | |
9575 | * Recursive sections:: Recursive sections in DocBook | |
9576 | * Tables in DocBook export:: Tables are exported as HTML tables | |
9577 | * Images in DocBook export:: How to insert figures into DocBook output | |
9578 | * Special characters:: How to handle special characters | |
9579 | @end menu | |
9580 | ||
9581 | @node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export | |
9582 | @subsection DocBook export commands | |
9583 | ||
9584 | @cindex region, active | |
9585 | @cindex active region | |
9586 | @cindex transient-mark-mode | |
9587 | @table @kbd | |
9588 | @kindex C-c C-e D | |
9589 | @item C-c C-e D | |
9590 | @cindex property EXPORT_FILE_NAME | |
9591 | Export as DocBook file. For an Org file, @file{myfile.org}, the DocBook XML | |
9592 | file will be @file{myfile.xml}. The file will be overwritten without | |
9593 | warning. If there is an active region@footnote{This requires | |
9594 | @code{transient-mark-mode} to be turned on}, only the region will be | |
9595 | exported. If the selected region is a single tree@footnote{To select the | |
9596 | current subtree, use @kbd{C-c @@}.}, the tree head will become the document | |
9597 | title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME} | |
9598 | property, that name will be used for the export. | |
9599 | @kindex C-c C-e V | |
9600 | @item C-c C-e V | |
9601 | Export as DocBook file, process to PDF, then open the resulting PDF file. | |
9602 | ||
9603 | @vindex org-export-docbook-xslt-proc-command | |
9604 | @vindex org-export-docbook-xsl-fo-proc-command | |
9605 | Note that, in order to produce PDF output based on exported DocBook file, you | |
9606 | need to have XSLT processor and XSL-FO processor software installed on your | |
9607 | system. Check variables @code{org-export-docbook-xslt-proc-command} and | |
9608 | @code{org-export-docbook-xsl-fo-proc-command}. | |
9609 | ||
9610 | @kindex C-c C-e v D | |
9611 | @item C-c C-e v D | |
9612 | Export only the visible part of the document. | |
9613 | @end table | |
9614 | ||
9615 | @node Quoting DocBook code, Recursive sections, DocBook export commands, DocBook export | |
9616 | @subsection Quoting DocBook code | |
9617 | ||
9618 | You can quote DocBook code in Org files and copy it verbatim into exported | |
9619 | DocBook file with the following constructs: | |
9620 | ||
9621 | @cindex #+DOCBOOK | |
9622 | @cindex #+BEGIN_DOCBOOK | |
9623 | @example | |
9624 | #+DOCBOOK: Literal DocBook code for export | |
9625 | @end example | |
9626 | ||
9627 | @noindent or | |
9628 | @cindex #+BEGIN_DOCBOOK | |
9629 | ||
9630 | @example | |
9631 | #+BEGIN_DOCBOOK | |
9632 | All lines between these markers are exported by DocBook exporter | |
9633 | literally. | |
9634 | #+END_DOCBOOK | |
9635 | @end example | |
9636 | ||
9637 | For example, you can use the following lines to include a DocBook warning | |
9638 | admonition. As to what this warning says, you should pay attention to the | |
9639 | document context when quoting DocBook code in Org files. You may make | |
9640 | exported DocBook XML files invalid by not quoting DocBook code correctly. | |
9641 | ||
9642 | @example | |
9643 | #+BEGIN_DOCBOOK | |
9644 | <warning> | |
9645 | <para>You should know what you are doing when quoting DocBook XML code | |
9646 | in your Org file. Invalid DocBook XML file may be generated by | |
9647 | DocBook exporter if you are not careful!</para> | |
9648 | </warning> | |
9649 | #+END_DOCBOOK | |
9650 | @end example | |
9651 | ||
9652 | @node Recursive sections, Tables in DocBook export, Quoting DocBook code, DocBook export | |
9653 | @subsection Recursive sections | |
9654 | @cindex DocBook recursive sections | |
9655 | ||
9656 | DocBook exporter exports Org files as articles using the @code{article} | |
a351880d | 9657 | element in DocBook. Recursive sections, i.e. @code{section} elements, are |
c8d0cf5c CD |
9658 | used in exported articles. Top level headlines in Org files are exported as |
9659 | top level sections, and lower level headlines are exported as nested | |
9660 | sections. The entire structure of Org files will be exported completely, no | |
9661 | matter how many nested levels of headlines there are. | |
9662 | ||
9663 | Using recursive sections makes it easy to port and reuse exported DocBook | |
9664 | code in other DocBook document types like @code{book} or @code{set}. | |
9665 | ||
9666 | @node Tables in DocBook export, Images in DocBook export, Recursive sections, DocBook export | |
9667 | @subsection Tables in DocBook export | |
9668 | @cindex tables, in DocBook export | |
9669 | ||
9670 | Tables in Org files are exported as HTML tables, which have been supported since | |
9671 | DocBook V4.3. | |
9672 | ||
9673 | If a table does not have a caption, an informal table is generated using the | |
9674 | @code{informaltable} element; otherwise, a formal table will be generated | |
9675 | using the @code{table} element. | |
9676 | ||
9677 | @node Images in DocBook export, Special characters, Tables in DocBook export, DocBook export | |
9678 | @subsection Images in DocBook export | |
9679 | @cindex images, inline in DocBook | |
9680 | @cindex inlining images in DocBook | |
9681 | ||
9682 | Images that are linked to without a description part in the link, like | |
9683 | @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, will be exported to DocBook | |
9684 | using @code{mediaobject} elements. Each @code{mediaobject} element contains | |
9685 | an @code{imageobject} that wraps an @code{imagedata} element. If you have | |
a351880d | 9686 | specified a caption for an image as described in @ref{Images and tables}, a |
c8d0cf5c CD |
9687 | @code{caption} element will be added in @code{mediaobject}. If a label is |
9688 | also specified, it will be exported as an @code{xml:id} attribute of the | |
9689 | @code{mediaobject} element. | |
9690 | ||
9691 | @vindex org-export-docbook-default-image-attributes | |
9692 | Image attributes supported by the @code{imagedata} element, like @code{align} | |
9693 | or @code{width}, can be specified in two ways: you can either customize | |
9694 | variable @code{org-export-docbook-default-image-attributes} or use the | |
9695 | @code{#+ATTR_DOCBOOK:} line. Attributes specified in variable | |
9696 | @code{org-export-docbook-default-image-attributes} are applied to all inline | |
9697 | images in the Org file to be exported (unless they are overwritten by image | |
9698 | attributes specified in @code{#+ATTR_DOCBOOK:} lines). | |
9699 | ||
9700 | The @code{#+ATTR_DOCBOOK:} line can be used to specify additional image | |
9701 | attributes or overwrite default image attributes for individual images. If | |
9702 | the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and | |
9703 | variable @code{org-export-docbook-default-image-attributes}, the former | |
9704 | overwrites the latter. Here is an example about how image attributes can be | |
9705 | set: | |
9706 | ||
9707 | @cindex #+CAPTION | |
9708 | @cindex #+LABEL | |
9709 | @cindex #+ATTR_DOCBOOK | |
9710 | @example | |
9711 | #+CAPTION: The logo of Org mode | |
9712 | #+LABEL: unicorn-svg | |
9713 | #+ATTR_DOCBOOK: scalefit="1" width="100%" depth="100%" | |
9714 | [[./img/org-mode-unicorn.svg]] | |
9715 | @end example | |
9716 | ||
9717 | @vindex org-export-docbook-inline-image-extensions | |
9718 | By default, DocBook exporter recognizes the following image file types: | |
9719 | @file{jpeg}, @file{jpg}, @file{png}, @file{gif}, and @file{svg}. You can | |
9720 | customize variable @code{org-export-docbook-inline-image-extensions} to add | |
9721 | more types to this list as long as DocBook supports them. | |
9722 | ||
9723 | @node Special characters, , Images in DocBook export, DocBook export | |
9724 | @subsection Special characters in DocBook export | |
9725 | @cindex Special characters in DocBook export | |
9726 | ||
9727 | @vindex org-export-docbook-doctype | |
9728 | @vindex org-html-entities | |
9729 | Special characters that are written in @TeX{}-like syntax, such as @code{\alpha}, | |
9730 | @code{\Gamma}, and @code{\Zeta}, are supported by DocBook exporter. These | |
9731 | characters are rewritten to XML entities, like @code{α}, | |
9732 | @code{Γ}, and @code{Ζ}, based on the list saved in variable | |
9733 | @code{org-html-entities}. As long as the generated DocBook file includes the | |
9734 | corresponding entities, these special characters are recognized. | |
9735 | ||
9736 | You can customize variable @code{org-export-docbook-doctype} to include the | |
9737 | entities you need. For example, you can set variable | |
9738 | @code{org-export-docbook-doctype} to the following value to recognize all | |
9739 | special characters included in XHTML entities: | |
9740 | ||
9741 | @example | |
9742 | "<!DOCTYPE article [ | |
9743 | <!ENTITY % xhtml1-symbol PUBLIC | |
9744 | \"-//W3C//ENTITIES Symbol for HTML//EN//XML\" | |
9745 | \"http://www.w3.org/2003/entities/2007/xhtml1-symbol.ent\" | |
9746 | > | |
9747 | %xhtml1-symbol; | |
9748 | ]> | |
9749 | " | |
9750 | @end example | |
9751 | ||
a351880d CD |
9752 | @node Freemind export, XOXO export, DocBook export, Exporting |
9753 | @section Freemind export | |
9754 | @cindex Freemind export | |
9755 | @cindex mind map | |
9756 | ||
9757 | The freemind exporter was written by Lennart Borgman. | |
9758 | ||
9759 | @table @kbd | |
9760 | @kindex C-c C-e m | |
9761 | @item C-c C-e m | |
9762 | Export as Freemind mind map @file{myfile.mm}. | |
9763 | @end table | |
9764 | ||
9765 | @node XOXO export, iCalendar export, Freemind export, Exporting | |
4009494e GM |
9766 | @section XOXO export |
9767 | @cindex XOXO export | |
9768 | ||
a7808fba | 9769 | Org mode contains an exporter that produces XOXO-style output. |
4009494e | 9770 | Currently, this exporter only handles the general outline structure and |
c8d0cf5c | 9771 | does not interpret any additional Org-mode features. |
4009494e GM |
9772 | |
9773 | @table @kbd | |
9774 | @kindex C-c C-e x | |
9775 | @item C-c C-e x | |
9776 | Export as XOXO file @file{myfile.html}. | |
9777 | @kindex C-c C-e v | |
9778 | @item C-c C-e v x | |
9779 | Export only the visible part of the document. | |
9780 | @end table | |
9781 | ||
b349f79f | 9782 | @node iCalendar export, , XOXO export, Exporting |
4009494e GM |
9783 | @section iCalendar export |
9784 | @cindex iCalendar export | |
9785 | ||
c8d0cf5c CD |
9786 | @vindex org-icalendar-include-todo |
9787 | @vindex org-icalendar-use-deadline | |
9788 | @vindex org-icalendar-use-scheduled | |
9789 | @vindex org-icalendar-categories | |
9790 | Some people use Org mode for keeping track of projects, but still prefer a | |
9791 | standard calendar application for anniversaries and appointments. In this | |
9792 | case it can be useful to show deadlines and other time-stamped items in Org | |
9793 | files in the calendar application. Org mode can export calendar information | |
9794 | in the standard iCalendar format. If you also want to have TODO entries | |
9795 | included in the export, configure the variable | |
9796 | @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT, | |
9797 | and TODO items as VTODO. It will also create events from deadlines that are | |
9798 | in non-TODO items. Deadlines and scheduling dates in TODO items will be used | |
9799 | to set the start and due dates for the TODO entry@footnote{See the variables | |
9800 | @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}. | |
9801 | As categories, it will use the tags locally defined in the heading, and the | |
9802 | file/tree category@footnote{To add inherited tags or the TODO state, | |
9803 | configure the variable @code{org-icalendar-categories}.}. | |
9804 | ||
9805 | @vindex org-icalendar-store-UID | |
9806 | @cindex property, ID | |
b349f79f CD |
9807 | The iCalendar standard requires each entry to have a globally unique |
9808 | identifier (UID). Org creates these identifiers during export. If you set | |
9809 | the variable @code{org-icalendar-store-UID}, the UID will be stored in the | |
9810 | @code{:ID:} property of the entry and re-used next time you report this | |
9811 | entry. Since a single entry can give rise to multiple iCalendar entries (as | |
9812 | a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds | |
9813 | prefixes to the UID, depending on what triggered the inclusion of the entry. | |
9814 | In this way the UID remains unique, but a synchronization program can still | |
9815 | figure out from which entry all the different instances originate. | |
9816 | ||
4009494e GM |
9817 | @table @kbd |
9818 | @kindex C-c C-e i | |
9819 | @item C-c C-e i | |
9820 | Create iCalendar entries for the current file and store them in the same | |
9821 | directory, using a file extension @file{.ics}. | |
9822 | @kindex C-c C-e I | |
9823 | @item C-c C-e I | |
c8d0cf5c | 9824 | @vindex org-agenda-files |
4009494e GM |
9825 | Like @kbd{C-c C-e i}, but do this for all files in |
9826 | @code{org-agenda-files}. For each of these files, a separate iCalendar | |
9827 | file will be written. | |
9828 | @kindex C-c C-e c | |
9829 | @item C-c C-e c | |
c8d0cf5c | 9830 | @vindex org-combined-agenda-icalendar-file |
4009494e GM |
9831 | Create a single large iCalendar file from all files in |
9832 | @code{org-agenda-files} and write it to the file given by | |
9833 | @code{org-combined-agenda-icalendar-file}. | |
9834 | @end table | |
9835 | ||
c8d0cf5c CD |
9836 | @vindex org-use-property-inheritance |
9837 | @vindex org-icalendar-include-body | |
9838 | @cindex property, SUMMARY | |
9839 | @cindex property, DESCRIPTION | |
9840 | @cindex property, LOCATION | |
96c8522a CD |
9841 | The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION |
9842 | property can be inherited from higher in the hierarchy if you configure | |
9843 | @code{org-use-property-inheritance} accordingly.} properties if the selected | |
9844 | entries have them. If not, the summary will be derived from the headline, | |
9845 | and the description from the body (limited to | |
28a16a1b | 9846 | @code{org-icalendar-include-body} characters). |
dbc28aaa | 9847 | |
c8d0cf5c | 9848 | How this calendar is best read and updated, depends on the application |
4009494e GM |
9849 | you are using. The FAQ covers this issue. |
9850 | ||
4009494e GM |
9851 | @node Publishing, Miscellaneous, Exporting, Top |
9852 | @chapter Publishing | |
9853 | @cindex publishing | |
c8d0cf5c | 9854 | @cindex O'Toole, David |
4009494e | 9855 | |
c8d0cf5c CD |
9856 | Org includes a publishing management system that allows you to configure |
9857 | automatic HTML conversion of @emph{projects} composed of interlinked org | |
9858 | files. You can also configure Org to automatically upload your exported HTML | |
9859 | pages and related attachments, such as images and source code files, to a web | |
9860 | server. | |
4009494e | 9861 | |
c8d0cf5c CD |
9862 | You can also use Org to convert files into PDF, or even combine HTML and PDF |
9863 | conversion so that files are available in both formats on the server. | |
4009494e | 9864 | |
c8d0cf5c | 9865 | Publishing has been contributed to Org by David O'Toole. |
4009494e GM |
9866 | |
9867 | @menu | |
9868 | * Configuration:: Defining projects | |
c8d0cf5c | 9869 | * Uploading files:: How to get files up on the server |
4009494e GM |
9870 | * Sample configuration:: Example projects |
9871 | * Triggering publication:: Publication commands | |
9872 | @end menu | |
9873 | ||
c8d0cf5c | 9874 | @node Configuration, Uploading files, Publishing, Publishing |
4009494e GM |
9875 | @section Configuration |
9876 | ||
9877 | Publishing needs significant configuration to specify files, destination | |
9878 | and many other properties of a project. | |
9879 | ||
9880 | @menu | |
9881 | * Project alist:: The central configuration variable | |
9882 | * Sources and destinations:: From here to there | |
9883 | * Selecting files:: What files are part of the project? | |
9884 | * Publishing action:: Setting the function doing the publishing | |
9885 | * Publishing options:: Tweaking HTML export | |
9886 | * Publishing links:: Which links keep working after publishing? | |
9887 | * Project page index:: Publishing a list of project files | |
9888 | @end menu | |
9889 | ||
9890 | @node Project alist, Sources and destinations, Configuration, Configuration | |
9891 | @subsection The variable @code{org-publish-project-alist} | |
9892 | @cindex org-publish-project-alist | |
9893 | @cindex projects, for publishing | |
9894 | ||
c8d0cf5c CD |
9895 | @vindex org-publish-project-alist |
9896 | Publishing is configured almost entirely through setting the value of one | |
9897 | variable, called @code{org-publish-project-alist}. Each element of the list | |
9898 | configures one project, and may be in one of the two following forms: | |
4009494e GM |
9899 | |
9900 | @lisp | |
c8d0cf5c | 9901 | ("project-name" :property value :property value ...) |
28a16a1b | 9902 | @r{or} |
c8d0cf5c | 9903 | ("project-name" :components ("project-name" "project-name" ...)) |
4009494e GM |
9904 | |
9905 | @end lisp | |
9906 | ||
c8d0cf5c CD |
9907 | In both cases, projects are configured by specifying property values. A |
9908 | project defines the set of files that will be published, as well as the | |
9909 | publishing configuration to use when publishing those files. When a project | |
9910 | takes the second form listed above, the individual members of the | |
9911 | @code{:components} property are taken to be sub-projects, which group | |
9912 | together files requiring different publishing options. When you publish such | |
9913 | a ``meta-project'', all the components will also be published, in the | |
9914 | sequence given. | |
4009494e GM |
9915 | |
9916 | @node Sources and destinations, Selecting files, Project alist, Configuration | |
9917 | @subsection Sources and destinations for files | |
9918 | @cindex directories, for publishing | |
9919 | ||
c8d0cf5c CD |
9920 | Most properties are optional, but some should always be set. In |
9921 | particular, Org needs to know where to look for source files, | |
4009494e GM |
9922 | and where to put published files. |
9923 | ||
9924 | @multitable @columnfractions 0.3 0.7 | |
9925 | @item @code{:base-directory} | |
9926 | @tab Directory containing publishing source files | |
9927 | @item @code{:publishing-directory} | |
c8d0cf5c CD |
9928 | @tab Directory where output files will be published. You can directly |
9929 | publish to a webserver using a file name syntax appropriate for | |
9930 | the Emacs @file{tramp} package. Or you can publish to a local directory and | |
9931 | use external tools to upload your website (@pxref{Uploading files}). | |
4009494e | 9932 | @item @code{:preparation-function} |
c8d0cf5c | 9933 | @tab Function called before starting the publishing process, for example, to |
4009494e | 9934 | run @code{make} for updating files to be published. |
b349f79f | 9935 | @item @code{:completion-function} |
c8d0cf5c | 9936 | @tab Function called after finishing the publishing process, for example, to |
b349f79f | 9937 | change permissions of the resulting files. |
4009494e GM |
9938 | @end multitable |
9939 | @noindent | |
9940 | ||
9941 | @node Selecting files, Publishing action, Sources and destinations, Configuration | |
9942 | @subsection Selecting files | |
9943 | @cindex files, selecting for publishing | |
9944 | ||
9945 | By default, all files with extension @file{.org} in the base directory | |
9946 | are considered part of the project. This can be modified by setting the | |
28a16a1b | 9947 | properties |
4009494e GM |
9948 | @multitable @columnfractions 0.25 0.75 |
9949 | @item @code{:base-extension} | |
9950 | @tab Extension (without the dot!) of source files. This actually is a | |
c8d0cf5c CD |
9951 | regular expression. Set this to the symbol @code{any} if you want to get all |
9952 | files in @code{:base-directory}, even without extension. | |
4009494e | 9953 | |
28a16a1b | 9954 | @item @code{:exclude} |
4009494e GM |
9955 | @tab Regular expression to match file names that should not be |
9956 | published, even though they have been selected on the basis of their | |
9957 | extension. | |
9958 | ||
9959 | @item @code{:include} | |
9960 | @tab List of files to be included regardless of @code{:base-extension} | |
9961 | and @code{:exclude}. | |
9962 | @end multitable | |
9963 | ||
9964 | @node Publishing action, Publishing options, Selecting files, Configuration | |
a7808fba | 9965 | @subsection Publishing action |
4009494e GM |
9966 | @cindex action, for publishing |
9967 | ||
9968 | Publishing means that a file is copied to the destination directory and | |
71d35b24 CD |
9969 | possibly transformed in the process. The default transformation is to export |
9970 | Org files as HTML files, and this is done by the function | |
9971 | @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML | |
c8d0cf5c CD |
9972 | export}). But you also can publish your content as PDF files using |
9973 | @code{org-publish-org-to-pdf}. If you want to publish the Org file itself, | |
9974 | but with @i{archived}, @i{commented}, and @i{tag-excluded} trees removed, use | |
9975 | @code{org-publish-org-to-org} and set the parameters @code{:plain-source} | |
9976 | and/or @code{:htmlized-source}. This will produce @file{file.org} and | |
9977 | @file{file.org.html} in the publishing | |
9978 | directory@footnote{@file{file-source.org} and @file{file-source.org.html} if | |
9979 | source and publishing directories are equal. Note that with this kind of | |
9980 | setup, you need to add @code{:exclude "-source\\.org"} to the project | |
9981 | definition in @code{org-publish-project-alist} to avoid that the published | |
9982 | source files will be considered as new org files the next time the project is | |
9983 | published.}. Other files like images only | |
9984 | need to be copied to the publishing destination, for this you may use | |
9985 | @code{org-publish-attachment}. For non-Org files, you always need to | |
9986 | specify the publishing function: | |
4009494e GM |
9987 | |
9988 | @multitable @columnfractions 0.3 0.7 | |
9989 | @item @code{:publishing-function} | |
9990 | @tab Function executing the publication of a file. This may also be a | |
9991 | list of functions, which will all be called in turn. | |
c8d0cf5c CD |
9992 | @item @code{:plain-source} |
9993 | @tab Non-nil means, publish plain source. | |
9994 | @item @code{:htmlized-source} | |
9995 | @tab Non-nil means, publish htmlized source. | |
4009494e GM |
9996 | @end multitable |
9997 | ||
c8d0cf5c CD |
9998 | The function must accept two arguments: a property list containing at least a |
9999 | @code{:publishing-directory} property, and the name of the file to be | |
10000 | published. It should take the specified file, make the necessary | |
4009494e | 10001 | transformation (if any) and place the result into the destination folder. |
4009494e GM |
10002 | |
10003 | @node Publishing options, Publishing links, Publishing action, Configuration | |
c8d0cf5c | 10004 | @subsection Options for the HTML/La@TeX{} exporters |
4009494e GM |
10005 | @cindex options, for publishing |
10006 | ||
10007 | The property list can be used to set many export options for the HTML | |
10008 | and La@TeX{} exporters. In most cases, these properties correspond to user | |
a7808fba | 10009 | variables in Org. The table below lists these properties along |
4009494e GM |
10010 | with the variable they belong to. See the documentation string for the |
10011 | respective variable for details. | |
10012 | ||
c8d0cf5c CD |
10013 | @vindex org-export-html-link-up |
10014 | @vindex org-export-html-link-home | |
10015 | @vindex org-export-default-language | |
10016 | @vindex org-display-custom-times | |
10017 | @vindex org-export-headline-levels | |
10018 | @vindex org-export-with-section-numbers | |
10019 | @vindex org-export-section-number-format | |
10020 | @vindex org-export-with-toc | |
10021 | @vindex org-export-preserve-breaks | |
10022 | @vindex org-export-with-archived-trees | |
10023 | @vindex org-export-with-emphasize | |
10024 | @vindex org-export-with-sub-superscripts | |
10025 | @vindex org-export-with-special-strings | |
10026 | @vindex org-export-with-footnotes | |
10027 | @vindex org-export-with-drawers | |
10028 | @vindex org-export-with-tags | |
10029 | @vindex org-export-with-todo-keywords | |
10030 | @vindex org-export-with-priority | |
10031 | @vindex org-export-with-TeX-macros | |
10032 | @vindex org-export-with-LaTeX-fragments | |
10033 | @vindex org-export-skip-text-before-1st-heading | |
10034 | @vindex org-export-with-fixed-width | |
10035 | @vindex org-export-with-timestamps | |
10036 | @vindex org-export-author-info | |
10037 | @vindex org-export-creator-info | |
10038 | @vindex org-export-with-tables | |
10039 | @vindex org-export-highlight-first-table-line | |
10040 | @vindex org-export-html-style-include-default | |
10041 | @vindex org-export-html-style | |
10042 | @vindex org-export-html-style-extra | |
10043 | @vindex org-export-html-link-org-files-as-html | |
10044 | @vindex org-export-html-inline-images | |
10045 | @vindex org-export-html-extension | |
10046 | @vindex org-export-html-table-tag | |
10047 | @vindex org-export-html-expand | |
10048 | @vindex org-export-html-with-timestamp | |
10049 | @vindex org-export-publishing-directory | |
10050 | @vindex org-export-html-preamble | |
10051 | @vindex org-export-html-postamble | |
10052 | @vindex org-export-html-auto-preamble | |
10053 | @vindex org-export-html-auto-postamble | |
10054 | @vindex user-full-name | |
10055 | @vindex user-mail-address | |
10056 | @vindex org-export-select-tags | |
10057 | @vindex org-export-exclude-tags | |
10058 | ||
96c8522a CD |
10059 | @multitable @columnfractions 0.32 0.68 |
10060 | @item @code{:link-up} @tab @code{org-export-html-link-up} | |
10061 | @item @code{:link-home} @tab @code{org-export-html-link-home} | |
4009494e | 10062 | @item @code{:language} @tab @code{org-export-default-language} |
96c8522a | 10063 | @item @code{:customtime} @tab @code{org-display-custom-times} |
4009494e GM |
10064 | @item @code{:headline-levels} @tab @code{org-export-headline-levels} |
10065 | @item @code{:section-numbers} @tab @code{org-export-with-section-numbers} | |
96c8522a | 10066 | @item @code{:section-number-format} @tab @code{org-export-section-number-format} |
4009494e | 10067 | @item @code{:table-of-contents} @tab @code{org-export-with-toc} |
96c8522a | 10068 | @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks} |
4009494e GM |
10069 | @item @code{:archived-trees} @tab @code{org-export-with-archived-trees} |
10070 | @item @code{:emphasize} @tab @code{org-export-with-emphasize} | |
10071 | @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts} | |
dbc28aaa | 10072 | @item @code{:special-strings} @tab @code{org-export-with-special-strings} |
96c8522a CD |
10073 | @item @code{:footnotes} @tab @code{org-export-with-footnotes} |
10074 | @item @code{:drawers} @tab @code{org-export-with-drawers} | |
10075 | @item @code{:tags} @tab @code{org-export-with-tags} | |
10076 | @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords} | |
10077 | @item @code{:priority} @tab @code{org-export-with-priority} | |
4009494e GM |
10078 | @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros} |
10079 | @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments} | |
6eb02347 | 10080 | @item @code{:latex-listings} @tab @code{org-export-latex-listings} |
96c8522a | 10081 | @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading} |
4009494e | 10082 | @item @code{:fixed-width} @tab @code{org-export-with-fixed-width} |
44ce9197 CD |
10083 | @item @code{:timestamps} @tab @code{org-export-with-timestamps} |
10084 | @item @code{:author-info} @tab @code{org-export-author-info} | |
10085 | @item @code{:creator-info} @tab @code{org-export-creator-info} | |
4009494e GM |
10086 | @item @code{:tables} @tab @code{org-export-with-tables} |
10087 | @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line} | |
e45e3595 | 10088 | @item @code{:style-include-default} @tab @code{org-export-html-style-include-default} |
4009494e | 10089 | @item @code{:style} @tab @code{org-export-html-style} |
44ce9197 | 10090 | @item @code{:style-extra} @tab @code{org-export-html-style-extra} |
4009494e GM |
10091 | @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html} |
10092 | @item @code{:inline-images} @tab @code{org-export-html-inline-images} | |
96c8522a | 10093 | @item @code{:html-extension} @tab @code{org-export-html-extension} |
c8d0cf5c | 10094 | @item @code{:xml-declaration} @tab @code{org-export-html-xml-declaration} |
96c8522a | 10095 | @item @code{:html-table-tag} @tab @code{org-export-html-table-tag} |
4009494e GM |
10096 | @item @code{:expand-quoted-html} @tab @code{org-export-html-expand} |
10097 | @item @code{:timestamp} @tab @code{org-export-html-with-timestamp} | |
10098 | @item @code{:publishing-directory} @tab @code{org-export-publishing-directory} | |
10099 | @item @code{:preamble} @tab @code{org-export-html-preamble} | |
10100 | @item @code{:postamble} @tab @code{org-export-html-postamble} | |
10101 | @item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble} | |
10102 | @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble} | |
10103 | @item @code{:author} @tab @code{user-full-name} | |
c8d0cf5c | 10104 | @item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..} |
864c9740 CD |
10105 | @item @code{:select-tags} @tab @code{org-export-select-tags} |
10106 | @item @code{:exclude-tags} @tab @code{org-export-exclude-tags} | |
c8d0cf5c | 10107 | @item @code{:latex-image-options} @tab @code{org-export-latex-image-default-option} |
4009494e GM |
10108 | @end multitable |
10109 | ||
10110 | Most of the @code{org-export-with-*} variables have the same effect in | |
10111 | both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and | |
10112 | @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the | |
10113 | La@TeX{} export. | |
10114 | ||
c8d0cf5c | 10115 | @vindex org-publish-project-alist |
dbc28aaa CD |
10116 | When a property is given a value in @code{org-publish-project-alist}, |
10117 | its setting overrides the value of the corresponding user variable (if | |
10118 | any) during publishing. Options set within a file (@pxref{Export | |
4009494e GM |
10119 | options}), however, override everything. |
10120 | ||
10121 | @node Publishing links, Project page index, Publishing options, Configuration | |
10122 | @subsection Links between published files | |
10123 | @cindex links, publishing | |
10124 | ||
a7808fba | 10125 | To create a link from one Org file to another, you would use |
4009494e | 10126 | something like @samp{[[file:foo.org][The foo]]} or simply |
c8d0cf5c | 10127 | @samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link |
4009494e GM |
10128 | becomes a link to @file{foo.html}. In this way, you can interlink the |
10129 | pages of your "org web" project and the links will work as expected when | |
c8d0cf5c CD |
10130 | you publish them to HTML. If you also publish the Org source file and want |
10131 | to link to that, use an @code{http:} link instead of a @code{file:} link, | |
10132 | because @code{file:} links are converted to link to the corresponding | |
10133 | @file{html} file. | |
4009494e | 10134 | |
c8d0cf5c CD |
10135 | You may also link to related files, such as images. Provided you are careful |
10136 | with relative file names, and provided you have also configured Org to upload | |
10137 | the related files, these links will work too. See @ref{Complex example}, for | |
10138 | an example of this usage. | |
4009494e | 10139 | |
c8d0cf5c | 10140 | Sometimes an Org file to be published may contain links that are |
4009494e | 10141 | only valid in your production environment, but not in the publishing |
28a16a1b | 10142 | location. In this case, use the property |
4009494e GM |
10143 | |
10144 | @multitable @columnfractions 0.4 0.6 | |
10145 | @item @code{:link-validation-function} | |
10146 | @tab Function to validate links | |
10147 | @end multitable | |
10148 | ||
10149 | @noindent | |
10150 | to define a function for checking link validity. This function must | |
10151 | accept two arguments, the file name and a directory relative to which | |
10152 | the file name is interpreted in the production environment. If this | |
10153 | function returns @code{nil}, then the HTML generator will only insert a | |
10154 | description into the HTML file, but no link. One option for this | |
10155 | function is @code{org-publish-validate-link} which checks if the given | |
10156 | file is part of any project in @code{org-publish-project-alist}. | |
10157 | ||
10158 | @node Project page index, , Publishing links, Configuration | |
10159 | @subsection Project page index | |
10160 | @cindex index, of published pages | |
10161 | ||
10162 | The following properties may be used to control publishing of an | |
c8d0cf5c | 10163 | index of files or a summary page for a given project. |
4009494e GM |
10164 | |
10165 | @multitable @columnfractions 0.25 0.75 | |
10166 | @item @code{:auto-index} | |
c8d0cf5c CD |
10167 | @tab When non-nil, publish an index during @code{org-publish-current-project} |
10168 | or @code{org-publish-all}. | |
4009494e GM |
10169 | |
10170 | @item @code{:index-filename} | |
c8d0cf5c CD |
10171 | @tab Filename for output of index. Defaults to @file{sitemap.org} (which |
10172 | becomes @file{sitemap.html}). | |
4009494e GM |
10173 | |
10174 | @item @code{:index-title} | |
10175 | @tab Title of index page. Defaults to name of file. | |
10176 | ||
10177 | @item @code{:index-function} | |
a7808fba | 10178 | @tab Plug-in function to use for generation of index. |
4009494e GM |
10179 | Defaults to @code{org-publish-org-index}, which generates a plain list |
10180 | of links to all files in the project. | |
10181 | @end multitable | |
10182 | ||
c8d0cf5c CD |
10183 | @node Uploading files, Sample configuration, Configuration, Publishing |
10184 | @section Uploading files | |
10185 | @cindex rsync | |
10186 | @cindex unison | |
10187 | ||
10188 | For those people already utilizing third party sync tools such as | |
10189 | @command{rsync} or @command{unison}, it might be preferable not to use the built in | |
10190 | @i{remote} publishing facilities of Org mode which rely heavily on | |
10191 | Tramp. Tramp, while very useful and powerful, tends not to be | |
10192 | so efficient for multiple file transfer and has been known to cause problems | |
10193 | under heavy usage. | |
10194 | ||
10195 | Specialized synchronization utilities offer several advantages. In addition | |
10196 | to timestamp comparison, they also do content and permissions/attribute | |
10197 | checks. For this reason you might prefer to publish your web to a local | |
10198 | directory (possibly even @i{in place} with your Org files) and then use | |
10199 | @file{unison} or @file{rsync} to do the synchronization with the remote host. | |
10200 | ||
10201 | Since Unison (for example) can be configured as to which files to transfer to | |
10202 | a certain remote destination, it can greatly simplify the project publishing | |
10203 | definition. Simply keep all files in the correct location, process your Org | |
10204 | files with @code{org-publish} and let the synchronization tool do the rest. | |
10205 | You do not need, in this scenario, to include attachments such as @file{jpg}, | |
10206 | @file{css} or @file{gif} files in the project definition since the 3rd party | |
10207 | tool syncs them. | |
10208 | ||
10209 | Publishing to a local directory is also much faster than to a remote one, so | |
10210 | that you can afford more easily to republish entire projects. If you set | |
10211 | @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main | |
10212 | benefit of re-including any changed external files such as source example | |
10213 | files you might include with @code{#+INCLUDE}. The timestamp mechanism in | |
10214 | Org is not smart enough to detect if included files have been modified. | |
10215 | ||
10216 | @node Sample configuration, Triggering publication, Uploading files, Publishing | |
4009494e GM |
10217 | @section Sample configuration |
10218 | ||
10219 | Below we provide two example configurations. The first one is a simple | |
a7808fba | 10220 | project publishing only a set of Org files. The second example is |
4009494e GM |
10221 | more complex, with a multi-component project. |
10222 | ||
10223 | @menu | |
10224 | * Simple example:: One-component publishing | |
10225 | * Complex example:: A multi-component publishing example | |
10226 | @end menu | |
10227 | ||
10228 | @node Simple example, Complex example, Sample configuration, Sample configuration | |
10229 | @subsection Example: simple publishing configuration | |
10230 | ||
a7808fba | 10231 | This example publishes a set of Org files to the @file{public_html} |
4009494e GM |
10232 | directory on the local machine. |
10233 | ||
10234 | @lisp | |
10235 | (setq org-publish-project-alist | |
28a16a1b | 10236 | '(("org" |
4009494e GM |
10237 | :base-directory "~/org/" |
10238 | :publishing-directory "~/public_html" | |
10239 | :section-numbers nil | |
10240 | :table-of-contents nil | |
e45e3595 | 10241 | :style "<link rel=\"stylesheet\" |
4009494e | 10242 | href=\"../other/mystyle.css\" |
c8d0cf5c | 10243 | type=\"text/css\"/>"))) |
4009494e GM |
10244 | @end lisp |
10245 | ||
10246 | @node Complex example, , Simple example, Sample configuration | |
10247 | @subsection Example: complex publishing configuration | |
10248 | ||
10249 | This more complicated example publishes an entire website, including | |
c8d0cf5c CD |
10250 | Org files converted to HTML, image files, Emacs Lisp source code, and |
10251 | style sheets. The publishing directory is remote and private files are | |
4009494e GM |
10252 | excluded. |
10253 | ||
10254 | To ensure that links are preserved, care should be taken to replicate | |
10255 | your directory structure on the web server, and to use relative file | |
c8d0cf5c | 10256 | paths. For example, if your Org files are kept in @file{~/org} and your |
4009494e GM |
10257 | publishable images in @file{~/images}, you'd link to an image with |
10258 | @c | |
10259 | @example | |
10260 | file:../images/myimage.png | |
10261 | @end example | |
10262 | @c | |
10263 | On the web server, the relative path to the image should be the | |
10264 | same. You can accomplish this by setting up an "images" folder in the | |
a7808fba | 10265 | right place on the web server, and publishing images to it. |
4009494e GM |
10266 | |
10267 | @lisp | |
10268 | (setq org-publish-project-alist | |
10269 | '(("orgfiles" | |
10270 | :base-directory "~/org/" | |
10271 | :base-extension "org" | |
10272 | :publishing-directory "/ssh:user@@host:~/html/notebook/" | |
10273 | :publishing-function org-publish-org-to-html | |
10274 | :exclude "PrivatePage.org" ;; regexp | |
10275 | :headline-levels 3 | |
10276 | :section-numbers nil | |
10277 | :table-of-contents nil | |
e45e3595 | 10278 | :style "<link rel=\"stylesheet\" |
c8d0cf5c | 10279 | href=\"../other/mystyle.css\" type=\"text/css\"/>" |
4009494e GM |
10280 | :auto-preamble t |
10281 | :auto-postamble nil) | |
28a16a1b | 10282 | |
4009494e GM |
10283 | ("images" |
10284 | :base-directory "~/images/" | |
10285 | :base-extension "jpg\\|gif\\|png" | |
10286 | :publishing-directory "/ssh:user@@host:~/html/images/" | |
10287 | :publishing-function org-publish-attachment) | |
28a16a1b | 10288 | |
4009494e GM |
10289 | ("other" |
10290 | :base-directory "~/other/" | |
10291 | :base-extension "css\\|el" | |
10292 | :publishing-directory "/ssh:user@@host:~/html/other/" | |
10293 | :publishing-function org-publish-attachment) | |
10294 | ("website" :components ("orgfiles" "images" "other")))) | |
10295 | @end lisp | |
10296 | ||
10297 | @node Triggering publication, , Sample configuration, Publishing | |
10298 | @section Triggering publication | |
10299 | ||
c8d0cf5c | 10300 | Once properly configured, Org can publish with the following commands: |
4009494e GM |
10301 | |
10302 | @table @kbd | |
c8d0cf5c | 10303 | @kindex C-c C-e C |
4009494e GM |
10304 | @item C-c C-e C |
10305 | Prompt for a specific project and publish all files that belong to it. | |
c8d0cf5c | 10306 | @kindex C-c C-e P |
4009494e GM |
10307 | @item C-c C-e P |
10308 | Publish the project containing the current file. | |
c8d0cf5c | 10309 | @kindex C-c C-e F |
4009494e GM |
10310 | @item C-c C-e F |
10311 | Publish only the current file. | |
c8d0cf5c CD |
10312 | @kindex C-c C-e E |
10313 | @item C-c C-e E | |
10314 | Publish every project. | |
4009494e GM |
10315 | @end table |
10316 | ||
c8d0cf5c CD |
10317 | @vindex org-publish-use-timestamps-flag |
10318 | Org uses timestamps to track when a file has changed. The above functions | |
10319 | normally only publish changed files. You can override this and force | |
10320 | publishing of all files by giving a prefix argument to any of the commands | |
10321 | above, or by customizing the variable @code{org-publish-use-timestamps-flag}. | |
10322 | This may be necessary in particular if files include other files via | |
10323 | @code{#+SETUPFILE:} or @code{#+INCLUDE:}. | |
4009494e | 10324 | |
c8d0cf5c | 10325 | @node Miscellaneous, Hacking, Publishing, Top |
4009494e GM |
10326 | @chapter Miscellaneous |
10327 | ||
10328 | @menu | |
10329 | * Completion:: M-TAB knows what you need | |
17673adf | 10330 | * Speed keys:: Electic commands at the beginning of a headline |
a7808fba | 10331 | * Customization:: Adapting Org to your taste |
4009494e GM |
10332 | * In-buffer settings:: Overview of the #+KEYWORDS |
10333 | * The very busy C-c C-c key:: When in doubt, press C-c C-c | |
10334 | * Clean view:: Getting rid of leading stars in the outline | |
a7808fba | 10335 | * TTY keys:: Using Org on a tty |
4009494e | 10336 | * Interaction:: Other Emacs packages |
4009494e GM |
10337 | @end menu |
10338 | ||
c8d0cf5c | 10339 | |
17673adf | 10340 | @node Completion, Speed keys, Miscellaneous, Miscellaneous |
4009494e GM |
10341 | @section Completion |
10342 | @cindex completion, of @TeX{} symbols | |
10343 | @cindex completion, of TODO keywords | |
10344 | @cindex completion, of dictionary words | |
10345 | @cindex completion, of option keywords | |
10346 | @cindex completion, of tags | |
10347 | @cindex completion, of property keys | |
10348 | @cindex completion, of link abbreviations | |
10349 | @cindex @TeX{} symbol completion | |
10350 | @cindex TODO keywords completion | |
10351 | @cindex dictionary word completion | |
10352 | @cindex option keyword completion | |
10353 | @cindex tag completion | |
10354 | @cindex link abbreviations, completion of | |
10355 | ||
6eb02347 CD |
10356 | Emacs would not be Emacs without completion, and Org-mode uses it whenever it |
10357 | makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for | |
a351880d | 10358 | some of the completion prompts, you can specify your preference by setting at |
6eb02347 CD |
10359 | most one of the variables @code{org-completion-use-iswitchb} |
10360 | @code{org-completion-use-ido}. | |
10361 | ||
a7808fba | 10362 | Org supports in-buffer completion. This type of completion does |
4009494e GM |
10363 | not make use of the minibuffer. You simply type a few letters into |
10364 | the buffer and use the key to complete text right there. | |
10365 | ||
10366 | @table @kbd | |
10367 | @kindex M-@key{TAB} | |
10368 | @item M-@key{TAB} | |
10369 | Complete word at point | |
10370 | @itemize @bullet | |
10371 | @item | |
10372 | At the beginning of a headline, complete TODO keywords. | |
10373 | @item | |
10374 | After @samp{\}, complete @TeX{} symbols supported by the exporter. | |
10375 | @item | |
10376 | After @samp{*}, complete headlines in the current buffer so that they | |
10377 | can be used in search links like @samp{[[*find this headline]]}. | |
10378 | @item | |
10379 | After @samp{:} in a headline, complete tags. The list of tags is taken | |
10380 | from the variable @code{org-tag-alist} (possibly set through the | |
10381 | @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created | |
10382 | dynamically from all tags used in the current buffer. | |
10383 | @item | |
10384 | After @samp{:} and not in a headline, complete property keys. The list | |
10385 | of keys is constructed dynamically from all keys used in the current | |
10386 | buffer. | |
10387 | @item | |
10388 | After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}). | |
10389 | @item | |
10390 | After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or | |
a7808fba | 10391 | @samp{OPTIONS} which set file-specific options for Org mode. When the |
4009494e GM |
10392 | option keyword is already complete, pressing @kbd{M-@key{TAB}} again |
10393 | will insert example settings for this keyword. | |
10394 | @item | |
10395 | In the line after @samp{#+STARTUP: }, complete startup keywords, | |
a351880d | 10396 | i.e. valid keys for this line. |
4009494e | 10397 | @item |
a7808fba | 10398 | Elsewhere, complete dictionary words using Ispell. |
4009494e GM |
10399 | @end itemize |
10400 | @end table | |
10401 | ||
17673adf CD |
10402 | @node Speed keys, Customization, Completion, Miscellaneous |
10403 | @section Speed keys | |
10404 | @cindex speed keys | |
10405 | @vindex org-use-speed-commands | |
10406 | @vindex org-speed-commands-user | |
10407 | ||
10408 | Single keys can be made to execute commands when the cursor is at the | |
10409 | beginning of a headline, i.e. before the first star. Configure the variable | |
10410 | @code{org-use-speed-commands} to activate this feature. There is a | |
10411 | pre-defined list of commands, and you can add more such commands using the | |
10412 | variable @code{org-speed-commands-user}. Speed keys do not only speed up | |
10413 | navigation and other commands, but they also provide an alternative way to | |
10414 | execute commands bound to keys that are not or not easily available on a tty, | |
10415 | or on a small mobile device with a limited keyboard. | |
10416 | ||
10417 | To see which commands are available, activate the feature and press @kbd{?} | |
10418 | with the cursor at the beginning of a headline. | |
10419 | ||
10420 | @node Customization, In-buffer settings, Speed keys, Miscellaneous | |
4009494e GM |
10421 | @section Customization |
10422 | @cindex customization | |
10423 | @cindex options, for customization | |
10424 | @cindex variables, for customization | |
10425 | ||
10426 | There are more than 180 variables that can be used to customize | |
a7808fba | 10427 | Org. For the sake of compactness of the manual, I am not |
4009494e GM |
10428 | describing the variables here. A structured overview of customization |
10429 | variables is available with @kbd{M-x org-customize}. Or select | |
10430 | @code{Browse Org Group} from the @code{Org->Customization} menu. Many | |
10431 | settings can also be activated on a per-file basis, by putting special | |
10432 | lines into the buffer (@pxref{In-buffer settings}). | |
10433 | ||
10434 | @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous | |
10435 | @section Summary of in-buffer settings | |
10436 | @cindex in-buffer settings | |
10437 | @cindex special keywords | |
10438 | ||
a7808fba | 10439 | Org mode uses special lines in the buffer to define settings on a |
4009494e GM |
10440 | per-file basis. These lines start with a @samp{#+} followed by a |
10441 | keyword, a colon, and then individual words defining a setting. Several | |
10442 | setting words can be in the same line, but you can also have multiple | |
10443 | lines for the keyword. While these settings are described throughout | |
10444 | the manual, here is a summary. After changing any of those lines in the | |
10445 | buffer, press @kbd{C-c C-c} with the cursor still in the line to | |
10446 | activate the changes immediately. Otherwise they become effective only | |
10447 | when the file is visited again in a new Emacs session. | |
10448 | ||
c8d0cf5c | 10449 | @vindex org-archive-location |
4009494e GM |
10450 | @table @kbd |
10451 | @item #+ARCHIVE: %s_done:: | |
10452 | This line sets the archive location for the agenda file. It applies for | |
10453 | all subsequent lines until the next @samp{#+ARCHIVE} line, or the end | |
10454 | of the file. The first such line also applies to any entries before it. | |
10455 | The corresponding variable is @code{org-archive-location}. | |
10456 | @item #+CATEGORY: | |
10457 | This line sets the category for the agenda file. The category applies | |
10458 | for all subsequent lines until the next @samp{#+CATEGORY} line, or the | |
10459 | end of the file. The first such line also applies to any entries before it. | |
10460 | @item #+COLUMNS: %25ITEM ..... | |
c8d0cf5c | 10461 | @cindex property, COLUMNS |
4009494e | 10462 | Set the default format for columns view. This format applies when |
c8d0cf5c | 10463 | columns view is invoked in locations where no @code{COLUMNS} property |
dbc28aaa | 10464 | applies. |
4009494e | 10465 | @item #+CONSTANTS: name1=value1 ... |
c8d0cf5c CD |
10466 | @vindex org-table-formula-constants |
10467 | @vindex org-table-formula | |
4009494e GM |
10468 | Set file-local values for constants to be used in table formulas. This |
10469 | line set the local variable @code{org-table-formula-constants-local}. | |
dbc28aaa | 10470 | The global version of this variable is |
4009494e | 10471 | @code{org-table-formula-constants}. |
b349f79f CD |
10472 | @item #+FILETAGS: :tag1:tag2:tag3: |
10473 | Set tags that can be inherited by any entry in the file, including the | |
10474 | top-level entries. | |
dbc28aaa | 10475 | @item #+DRAWERS: NAME1 ..... |
c8d0cf5c | 10476 | @vindex org-drawers |
dbc28aaa CD |
10477 | Set the file-local set of drawers. The corresponding global variable is |
10478 | @code{org-drawers}. | |
4009494e | 10479 | @item #+LINK: linkword replace |
c8d0cf5c | 10480 | @vindex org-link-abbrev-alist |
4009494e GM |
10481 | These lines (several are allowed) specify link abbreviations. |
10482 | @xref{Link abbreviations}. The corresponding variable is | |
10483 | @code{org-link-abbrev-alist}. | |
10484 | @item #+PRIORITIES: highest lowest default | |
c8d0cf5c CD |
10485 | @vindex org-highest-priority |
10486 | @vindex org-lowest-priority | |
10487 | @vindex org-default-priority | |
4009494e GM |
10488 | This line sets the limits and the default for the priorities. All three |
10489 | must be either letters A-Z or numbers 0-9. The highest priority must | |
10490 | have a lower ASCII number that the lowest priority. | |
10491 | @item #+PROPERTY: Property_Name Value | |
10492 | This line sets a default inheritance value for entries in the current | |
10493 | buffer, most useful for specifying the allowed values of a property. | |
c8d0cf5c | 10494 | @cindex #+SETUPFILE |
b349f79f CD |
10495 | @item #+SETUPFILE: file |
10496 | This line defines a file that holds more in-buffer setup. Normally this is | |
10497 | entirely ignored. Only when the buffer is parsed for option-setting lines | |
a351880d | 10498 | (i.e. when starting Org mode for a file, when pressing @kbd{C-c C-c} in a |
b349f79f | 10499 | settings line, or when exporting), then the contents of this file are parsed |
a50253cc | 10500 | as if they had been included in the buffer. In particular, the file can be |
b349f79f CD |
10501 | any other Org mode file with internal setup. You can visit the file the |
10502 | cursor is in the line with @kbd{C-c '}. | |
4009494e | 10503 | @item #+STARTUP: |
c8d0cf5c | 10504 | @cindex #+STARTUP: |
a7808fba | 10505 | This line sets options to be used at startup of Org mode, when an |
c8d0cf5c CD |
10506 | Org file is being visited. |
10507 | ||
10508 | The first set of options deals with the initial visibility of the outline | |
10509 | tree. The corresponding variable for global default settings is | |
10510 | @code{org-startup-folded}, with a default value @code{t}, which means | |
10511 | @code{overview}. | |
10512 | @vindex org-startup-folded | |
4009494e GM |
10513 | @cindex @code{overview}, STARTUP keyword |
10514 | @cindex @code{content}, STARTUP keyword | |
10515 | @cindex @code{showall}, STARTUP keyword | |
7006d207 | 10516 | @cindex @code{showeverything}, STARTUP keyword |
4009494e | 10517 | @example |
7006d207 CD |
10518 | overview @r{top-level headlines only} |
10519 | content @r{all headlines} | |
10520 | showall @r{no folding of any entries} | |
10521 | showeverything @r{show even drawer contents} | |
4009494e | 10522 | @end example |
c8d0cf5c CD |
10523 | |
10524 | @vindex org-startup-indented | |
10525 | @cindex @code{indent}, STARTUP keyword | |
10526 | @cindex @code{noindent}, STARTUP keyword | |
10527 | Dynamic virtual indentation is controlled by the variable | |
10528 | @code{org-startup-indented}@footnote{Emacs 23 and Org-mode 6.29 are required} | |
10529 | @example | |
10530 | indent @r{start with @code{org-indent-mode} turned on} | |
10531 | noindent @r{start with @code{org-indent-mode} turned off} | |
10532 | @end example | |
10533 | ||
10534 | @vindex org-startup-align-all-tables | |
4009494e GM |
10535 | Then there are options for aligning tables upon visiting a file. This |
10536 | is useful in files containing narrowed table columns. The corresponding | |
10537 | variable is @code{org-startup-align-all-tables}, with a default value | |
28a16a1b | 10538 | @code{nil}. |
4009494e GM |
10539 | @cindex @code{align}, STARTUP keyword |
10540 | @cindex @code{noalign}, STARTUP keyword | |
10541 | @example | |
10542 | align @r{align all tables} | |
10543 | noalign @r{don't align tables on startup} | |
10544 | @end example | |
c8d0cf5c CD |
10545 | @vindex org-log-done |
10546 | @vindex org-log-note-clock-out | |
10547 | @vindex org-log-repeat | |
10548 | Logging the closing and reopening of TODO items and clock intervals can be | |
10549 | configured using these options (see variables @code{org-log-done}, | |
10550 | @code{org-log-note-clock-out} and @code{org-log-repeat}) | |
4009494e | 10551 | @cindex @code{logdone}, STARTUP keyword |
4009494e | 10552 | @cindex @code{lognotedone}, STARTUP keyword |
28a16a1b | 10553 | @cindex @code{nologdone}, STARTUP keyword |
4009494e | 10554 | @cindex @code{lognoteclock-out}, STARTUP keyword |
28a16a1b | 10555 | @cindex @code{nolognoteclock-out}, STARTUP keyword |
4009494e | 10556 | @cindex @code{logrepeat}, STARTUP keyword |
28a16a1b | 10557 | @cindex @code{lognoterepeat}, STARTUP keyword |
4009494e | 10558 | @cindex @code{nologrepeat}, STARTUP keyword |
a351880d CD |
10559 | @cindex @code{logreschedule}, STARTUP keyword |
10560 | @cindex @code{lognotereschedule}, STARTUP keyword | |
10561 | @cindex @code{nologreschedule}, STARTUP keyword | |
10562 | @cindex @code{logredeadline}, STARTUP keyword | |
10563 | @cindex @code{lognoteredeadline}, STARTUP keyword | |
10564 | @cindex @code{nologredeadline}, STARTUP keyword | |
4009494e | 10565 | @example |
28a16a1b CD |
10566 | logdone @r{record a timestamp when an item is marked DONE} |
10567 | lognotedone @r{record timestamp and a note when DONE} | |
10568 | nologdone @r{don't record when items are marked DONE} | |
10569 | logrepeat @r{record a time when reinstating a repeating item} | |
10570 | lognoterepeat @r{record a note when reinstating a repeating item} | |
10571 | nologrepeat @r{do not record when reinstating repeating item} | |
10572 | lognoteclock-out @r{record a note when clocking out} | |
10573 | nolognoteclock-out @r{don't record a note when clocking out} | |
a351880d CD |
10574 | logreschedule @r{record a timestamp when scheduling time changes} |
10575 | lognotereschedule @r{record a note when scheduling time changes} | |
10576 | nologreschedule @r{do not record when a scheduling date changes} | |
10577 | logredeadline @r{record a timestamp when deadline changes} | |
10578 | lognoteredeadline @r{record a note when deadline changes} | |
10579 | nologredeadline @r{do not record when a deadline date changes} | |
4009494e | 10580 | @end example |
c8d0cf5c CD |
10581 | @vindex org-hide-leading-stars |
10582 | @vindex org-odd-levels-only | |
b349f79f CD |
10583 | Here are the options for hiding leading stars in outline headings, and for |
10584 | indenting outlines. The corresponding variables are | |
10585 | @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a | |
10586 | default setting @code{nil} (meaning @code{showstars} and @code{oddeven}). | |
4009494e GM |
10587 | @cindex @code{hidestars}, STARTUP keyword |
10588 | @cindex @code{showstars}, STARTUP keyword | |
10589 | @cindex @code{odd}, STARTUP keyword | |
10590 | @cindex @code{even}, STARTUP keyword | |
10591 | @example | |
10592 | hidestars @r{make all but one of the stars starting a headline invisible.} | |
10593 | showstars @r{show all stars starting a headline} | |
b349f79f CD |
10594 | indent @r{virtual indentation according to outline level} |
10595 | noindent @r{no virtual indentation according to outline level} | |
4009494e GM |
10596 | odd @r{allow only odd outline levels (1,3,...)} |
10597 | oddeven @r{allow all outline levels} | |
10598 | @end example | |
c8d0cf5c CD |
10599 | @vindex org-put-time-stamp-overlays |
10600 | @vindex org-time-stamp-overlay-formats | |
10601 | To turn on custom format overlays over timestamps (variables | |
4009494e GM |
10602 | @code{org-put-time-stamp-overlays} and |
10603 | @code{org-time-stamp-overlay-formats}), use | |
10604 | @cindex @code{customtime}, STARTUP keyword | |
10605 | @example | |
10606 | customtime @r{overlay custom time format} | |
10607 | @end example | |
c8d0cf5c | 10608 | @vindex constants-unit-system |
4009494e GM |
10609 | The following options influence the table spreadsheet (variable |
10610 | @code{constants-unit-system}). | |
10611 | @cindex @code{constcgs}, STARTUP keyword | |
10612 | @cindex @code{constSI}, STARTUP keyword | |
10613 | @example | |
10614 | constcgs @r{@file{constants.el} should use the c-g-s unit system} | |
10615 | constSI @r{@file{constants.el} should use the SI unit system} | |
10616 | @end example | |
c8d0cf5c CD |
10617 | @vindex org-footnote-define-inline |
10618 | @vindex org-footnote-auto-label | |
10619 | @vindex org-footnote-auto-adjust | |
55e0839d | 10620 | To influence footnote settings, use the following keywords. The |
c8d0cf5c CD |
10621 | corresponding variables are @code{org-footnote-define-inline}, |
10622 | @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}. | |
55e0839d | 10623 | @cindex @code{fninline}, STARTUP keyword |
c8d0cf5c | 10624 | @cindex @code{nofninline}, STARTUP keyword |
55e0839d CD |
10625 | @cindex @code{fnlocal}, STARTUP keyword |
10626 | @cindex @code{fnprompt}, STARTUP keyword | |
10627 | @cindex @code{fnauto}, STARTUP keyword | |
10628 | @cindex @code{fnconfirm}, STARTUP keyword | |
10629 | @cindex @code{fnplain}, STARTUP keyword | |
c8d0cf5c CD |
10630 | @cindex @code{fnadjust}, STARTUP keyword |
10631 | @cindex @code{nofnadjust}, STARTUP keyword | |
55e0839d CD |
10632 | @example |
10633 | fninline @r{define footnotes inline} | |
10634 | fnnoinline @r{define footnotes in separate section} | |
10635 | fnlocal @r{define footnotes near first reference, but not inline} | |
10636 | fnprompt @r{prompt for footnote labels} | |
10637 | fnauto @r{create [fn:1]-like labels automatically (default)} | |
10638 | fnconfirm @r{offer automatic label for editing or confirmation} | |
10639 | fnplain @r{create [1]-like labels automatically} | |
c8d0cf5c CD |
10640 | fnadjust @r{automatically renumber and sort footnotes} |
10641 | nofnadjust @r{do not renumber and sort automatically} | |
10642 | @end example | |
10643 | @cindex org-hide-block-startup | |
10644 | To hide blocks on startup, use these keywords. The corresponding variable is | |
10645 | @code{org-hide-block-startup}. | |
10646 | @cindex @code{hideblocks}, STARTUP keyword | |
10647 | @cindex @code{nohideblocks}, STARTUP keyword | |
10648 | @example | |
10649 | hideblocks @r{Hide all begin/end blocks on startup} | |
10650 | nohideblocks @r{Do not hide blocks on startup} | |
55e0839d | 10651 | @end example |
4009494e | 10652 | @item #+TAGS: TAG1(c1) TAG2(c2) |
c8d0cf5c | 10653 | @vindex org-tag-alist |
cad1d376 | 10654 | These lines (several such lines are allowed) specify the valid tags in |
4009494e GM |
10655 | this file, and (potentially) the corresponding @emph{fast tag selection} |
10656 | keys. The corresponding variable is @code{org-tag-alist}. | |
10657 | @item #+TBLFM: | |
10658 | This line contains the formulas for the table directly above the line. | |
c8d0cf5c CD |
10659 | @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:, |
10660 | @itemx #+OPTIONS:, #+BIND: | |
10661 | @itemx #+DESCRIPTION:, #+KEYWORDS: | |
10662 | @itemx #+LATEX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:, | |
10663 | @itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS: | |
4009494e GM |
10664 | These lines provide settings for exporting files. For more details see |
10665 | @ref{Export options}. | |
c8d0cf5c CD |
10666 | @item #+TODO: #+SEQ_TODO: #+TYP_TODO: |
10667 | @vindex org-todo-keywords | |
4009494e | 10668 | These lines set the TODO keywords and their interpretation in the |
c8d0cf5c | 10669 | current file. The corresponding variable is @code{org-todo-keywords}. |
4009494e GM |
10670 | @end table |
10671 | ||
10672 | @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous | |
10673 | @section The very busy C-c C-c key | |
10674 | @kindex C-c C-c | |
10675 | @cindex C-c C-c, overview | |
10676 | ||
a7808fba | 10677 | The key @kbd{C-c C-c} has many purposes in Org, which are all |
4009494e GM |
10678 | mentioned scattered throughout this manual. One specific function of |
10679 | this key is to add @emph{tags} to a headline (@pxref{Tags}). In many | |
c8d0cf5c CD |
10680 | other circumstances it means something like @emph{``Hey Org, look |
10681 | here and update according to what you see here''}. Here is a summary of | |
4009494e GM |
10682 | what this means in different contexts. |
10683 | ||
10684 | @itemize @minus | |
10685 | @item | |
10686 | If there are highlights in the buffer from the creation of a sparse | |
10687 | tree, or from clock display, remove these highlights. | |
10688 | @item | |
10689 | If the cursor is in one of the special @code{#+KEYWORD} lines, this | |
10690 | triggers scanning the buffer for these lines and updating the | |
28a16a1b | 10691 | information. |
4009494e GM |
10692 | @item |
10693 | If the cursor is inside a table, realign the table. This command | |
10694 | works even if the automatic table editor has been turned off. | |
10695 | @item | |
10696 | If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to | |
10697 | the entire table. | |
10698 | @item | |
10699 | If the cursor is inside a table created by the @file{table.el} package, | |
10700 | activate that table. | |
10701 | @item | |
c8d0cf5c | 10702 | If the current buffer is a Remember buffer, close the note and file it. |
4009494e GM |
10703 | With a prefix argument, file it, without further interaction, to the |
10704 | default location. | |
10705 | @item | |
10706 | If the cursor is on a @code{<<<target>>>}, update radio targets and | |
10707 | corresponding links in this buffer. | |
10708 | @item | |
10709 | If the cursor is in a property line or at the start or end of a property | |
10710 | drawer, offer property commands. | |
10711 | @item | |
55e0839d CD |
10712 | If the cursor is at a footnote reference, go to the corresponding |
10713 | definition, and vice versa. | |
10714 | @item | |
6eb02347 CD |
10715 | If the cursor is on a statistics cookie, update it. |
10716 | @item | |
4009494e GM |
10717 | If the cursor is in a plain list item with a checkbox, toggle the status |
10718 | of the checkbox. | |
10719 | @item | |
10720 | If the cursor is on a numbered item in a plain list, renumber the | |
10721 | ordered list. | |
dbc28aaa | 10722 | @item |
c8d0cf5c | 10723 | If the cursor is on the @code{#+BEGIN} line of a dynamic block, the |
dbc28aaa | 10724 | block is updated. |
4009494e GM |
10725 | @end itemize |
10726 | ||
10727 | @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous | |
10728 | @section A cleaner outline view | |
10729 | @cindex hiding leading stars | |
b349f79f CD |
10730 | @cindex dynamic indentation |
10731 | @cindex odd-levels-only outlines | |
4009494e GM |
10732 | @cindex clean outline view |
10733 | ||
c8d0cf5c CD |
10734 | Some people find it noisy and distracting that the Org headlines start with a |
10735 | potentially large number of stars, and that text below the headlines is not | |
6eb02347 CD |
10736 | indented. While this is no problem when writing a @emph{book-like} document |
10737 | where the outline headings are really section headings, in a more | |
10738 | @emph{list-oriented} outline, indented structure is a lot cleaner: | |
4009494e GM |
10739 | |
10740 | @example | |
b349f79f CD |
10741 | @group |
10742 | * Top level headline | * Top level headline | |
10743 | ** Second level | * Second level | |
10744 | *** 3rd level | * 3rd level | |
10745 | some text | some text | |
10746 | *** 3rd level | * 3rd level | |
10747 | more text | more text | |
10748 | * Another top level headline | * Another top level headline | |
10749 | @end group | |
4009494e GM |
10750 | @end example |
10751 | ||
10752 | @noindent | |
6eb02347 CD |
10753 | If you are using at least Emacs 23.1.50.3 and version 6.29 of Org, this kind |
10754 | of view can be achieved dynamically at display time using | |
10755 | @code{org-indent-mode}. In this minor mode, all lines are prefixed for | |
10756 | display with the necessary amount of space. Also headlines are prefixed with | |
10757 | additional stars, so that the amount of indentation shifts by | |
10758 | two@footnote{See the variable @code{org-indent-indentation-per-level}.} | |
10759 | spaces per level. All headline stars but the last one are made invisible | |
10760 | using the @code{org-hide} face@footnote{Turning on @code{org-indent-mode} | |
10761 | sets @code{org-hide-leading-stars} to @code{t} and | |
10762 | @code{org-adapt-indentation} to @code{nil}.} - see below under @samp{2.} for | |
10763 | more information on how this works. You can turn on @code{org-indent-mode} | |
10764 | for all files by customizing the variable @code{org-startup-indented}, or you | |
10765 | can turn it on for individual files using | |
c8d0cf5c CD |
10766 | |
10767 | @example | |
10768 | #+STARTUP: indent | |
10769 | @end example | |
10770 | ||
10771 | If you want a similar effect in earlier version of Emacs and/or Org, or if | |
10772 | you want the indentation to be hard space characters so that the plain text | |
10773 | file looks as similar as possible to the Emacs display, Org supports you in | |
10774 | the following way: | |
4009494e | 10775 | |
b349f79f | 10776 | @enumerate |
96c8522a | 10777 | @item |
b349f79f CD |
10778 | @emph{Indentation of text below headlines}@* |
10779 | You may indent text below each headline to make the left boundary line up | |
10780 | with the headline, like | |
4009494e | 10781 | |
b349f79f CD |
10782 | @example |
10783 | *** 3rd level | |
10784 | more text, now indented | |
10785 | @end example | |
10786 | ||
c8d0cf5c CD |
10787 | @vindex org-adapt-indentation |
10788 | Org supports this with paragraph filling, line wrapping, and structure | |
10789 | editing@footnote{See also the variable @code{org-adapt-indentation}.}, | |
10790 | preserving or adapting the indentation as appropriate. | |
b349f79f CD |
10791 | |
10792 | @item | |
c8d0cf5c | 10793 | @vindex org-hide-leading-stars |
b349f79f CD |
10794 | @emph{Hiding leading stars}@* You can modify the display in such a way that |
10795 | all leading stars become invisible. To do this in a global way, configure | |
10796 | the variable @code{org-hide-leading-stars} or change this on a per-file basis | |
10797 | with | |
4009494e GM |
10798 | |
10799 | @example | |
4009494e | 10800 | #+STARTUP: hidestars |
c8d0cf5c | 10801 | #+STARTUP: showstars |
4009494e GM |
10802 | @end example |
10803 | ||
b349f79f | 10804 | With hidden stars, the tree becomes: |
4009494e GM |
10805 | |
10806 | @example | |
b349f79f | 10807 | @group |
4009494e GM |
10808 | * Top level headline |
10809 | * Second level | |
10810 | * 3rd level | |
b349f79f CD |
10811 | ... |
10812 | @end group | |
4009494e GM |
10813 | @end example |
10814 | ||
10815 | @noindent | |
c8d0cf5c CD |
10816 | @vindex org-hide @r{(face)} |
10817 | The leading stars are not truly replaced by whitespace, they are only | |
10818 | fontified with the face @code{org-hide} that uses the background color as | |
10819 | font color. If you are not using either white or black background, you may | |
10820 | have to customize this face to get the wanted effect. Another possibility is | |
10821 | to set this font such that the extra stars are @i{almost} invisible, for | |
10822 | example using the color @code{grey90} on a white background. | |
4009494e | 10823 | |
b349f79f | 10824 | @item |
c8d0cf5c | 10825 | @vindex org-odd-levels-only |
b349f79f CD |
10826 | Things become cleaner still if you skip all the even levels and use only odd |
10827 | levels 1, 3, 5..., effectively adding two stars to go from one outline level | |
c8d0cf5c CD |
10828 | to the next@footnote{When you need to specify a level for a property search |
10829 | or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}. In this | |
10830 | way we get the outline view shown at the beginning of this section. In order | |
10831 | to make the structure editing and export commands handle this convention | |
10832 | correctly, configure the variable @code{org-odd-levels-only}, or set this on | |
10833 | a per-file basis with one of the following lines: | |
4009494e GM |
10834 | |
10835 | @example | |
10836 | #+STARTUP: odd | |
10837 | #+STARTUP: oddeven | |
10838 | @end example | |
10839 | ||
a7808fba | 10840 | You can convert an Org file from single-star-per-level to the |
4009494e GM |
10841 | double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels |
10842 | RET} in that file. The reverse operation is @kbd{M-x | |
10843 | org-convert-to-oddeven-levels}. | |
b349f79f | 10844 | @end enumerate |
4009494e GM |
10845 | |
10846 | @node TTY keys, Interaction, Clean view, Miscellaneous | |
a7808fba CD |
10847 | @section Using Org on a tty |
10848 | @cindex tty key bindings | |
4009494e | 10849 | |
c8d0cf5c | 10850 | Because Org contains a large number of commands, by default many of |
a7808fba | 10851 | Org's core commands are bound to keys that are generally not |
dbc28aaa CD |
10852 | accessible on a tty, such as the cursor keys (@key{left}, @key{right}, |
10853 | @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used | |
10854 | together with modifiers like @key{Meta} and/or @key{Shift}. To access | |
10855 | these commands on a tty when special keys are unavailable, the following | |
10856 | alternative bindings can be used. The tty bindings below will likely be | |
10857 | more cumbersome; you may find for some of the bindings below that a | |
c8d0cf5c CD |
10858 | customized workaround suits you better. For example, changing a timestamp |
10859 | is really only fun with @kbd{S-@key{cursor}} keys, whereas on a | |
dbc28aaa | 10860 | tty you would rather use @kbd{C-c .} to re-insert the timestamp. |
4009494e | 10861 | |
17673adf CD |
10862 | @multitable @columnfractions 0.15 0.2 0.1 0.2 |
10863 | @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2} | |
10864 | @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab | |
10865 | @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}} | |
10866 | @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab | |
10867 | @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}} | |
10868 | @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab | |
10869 | @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}} | |
10870 | @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab | |
10871 | @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}} | |
10872 | @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab | |
10873 | @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab | |
10874 | @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}} | |
10875 | @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab | |
10876 | @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab | |
10877 | @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab | |
10878 | @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab | |
10879 | @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab | |
10880 | @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab | |
10881 | @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab | |
4009494e GM |
10882 | @end multitable |
10883 | ||
c8d0cf5c CD |
10884 | |
10885 | @node Interaction, , TTY keys, Miscellaneous | |
4009494e GM |
10886 | @section Interaction with other packages |
10887 | @cindex packages, interaction with other | |
a7808fba | 10888 | Org lives in the world of GNU Emacs and interacts in various ways |
4009494e GM |
10889 | with other code out there. |
10890 | ||
10891 | @menu | |
a7808fba | 10892 | * Cooperation:: Packages Org cooperates with |
4009494e GM |
10893 | * Conflicts:: Packages that lead to conflicts |
10894 | @end menu | |
10895 | ||
10896 | @node Cooperation, Conflicts, Interaction, Interaction | |
a7808fba | 10897 | @subsection Packages that Org cooperates with |
4009494e GM |
10898 | |
10899 | @table @asis | |
10900 | @cindex @file{calc.el} | |
c8d0cf5c | 10901 | @cindex Gillespie, Dave |
4009494e | 10902 | @item @file{calc.el} by Dave Gillespie |
a7808fba CD |
10903 | Org uses the Calc package for implementing spreadsheet |
10904 | functionality in its tables (@pxref{The spreadsheet}). Org | |
10905 | checks for the availability of Calc by looking for the function | |
c8d0cf5c | 10906 | @code{calc-eval} which will have been autoloaded during setup if Calc has |
a7808fba | 10907 | been installed properly. As of Emacs 22, Calc is part of the Emacs |
4009494e | 10908 | distribution. Another possibility for interaction between the two |
a7808fba CD |
10909 | packages is using Calc for embedded calculations. @xref{Embedded Mode, |
10910 | , Embedded Mode, Calc, GNU Emacs Calc Manual}. | |
4009494e | 10911 | @item @file{constants.el} by Carsten Dominik |
c8d0cf5c CD |
10912 | @cindex @file{constants.el} |
10913 | @cindex Dominik, Carsten | |
10914 | @vindex org-table-formula-constants | |
4009494e GM |
10915 | In a table formula (@pxref{The spreadsheet}), it is possible to use |
10916 | names for natural constants or units. Instead of defining your own | |
10917 | constants in the variable @code{org-table-formula-constants}, install | |
10918 | the @file{constants} package which defines a large number of constants | |
10919 | and units, and lets you use unit prefixes like @samp{M} for | |
c8d0cf5c | 10920 | @samp{Mega}, etc@. You will need version 2.0 of this package, available |
a7808fba | 10921 | at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for |
4009494e GM |
10922 | the function @code{constants-get}, which has to be autoloaded in your |
10923 | setup. See the installation instructions in the file | |
10924 | @file{constants.el}. | |
10925 | @item @file{cdlatex.el} by Carsten Dominik | |
10926 | @cindex @file{cdlatex.el} | |
c8d0cf5c CD |
10927 | @cindex Dominik, Carsten |
10928 | Org mode can make use of the CDLa@TeX{} package to efficiently enter | |
10929 | La@TeX{} fragments into Org files. See @ref{CDLaTeX mode}. | |
dbc28aaa CD |
10930 | @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg |
10931 | @cindex @file{imenu.el} | |
a7808fba | 10932 | Imenu allows menu access to an index of items in a file. Org mode |
c8d0cf5c | 10933 | supports Imenu---all you need to do to get the index is the following: |
dbc28aaa | 10934 | @lisp |
28a16a1b | 10935 | (add-hook 'org-mode-hook |
a7808fba | 10936 | (lambda () (imenu-add-to-menubar "Imenu"))) |
dbc28aaa | 10937 | @end lisp |
c8d0cf5c CD |
10938 | @vindex org-imenu-depth |
10939 | By default the index is two levels deep---you can modify the depth using | |
dbc28aaa | 10940 | the option @code{org-imenu-depth}. |
4009494e GM |
10941 | @item @file{remember.el} by John Wiegley |
10942 | @cindex @file{remember.el} | |
c8d0cf5c | 10943 | @cindex Wiegley, John |
a7808fba | 10944 | Org cooperates with remember, see @ref{Remember}. |
4009494e | 10945 | @file{Remember.el} is not part of Emacs, find it on the web. |
dbc28aaa CD |
10946 | @item @file{speedbar.el} by Eric M. Ludlam |
10947 | @cindex @file{speedbar.el} | |
c8d0cf5c | 10948 | @cindex Ludlam, Eric M. |
dbc28aaa | 10949 | Speedbar is a package that creates a special frame displaying files and |
a7808fba | 10950 | index items in files. Org mode supports Speedbar and allows you to |
c8d0cf5c | 10951 | drill into Org files directly from the Speedbar. It also allows you to |
dbc28aaa | 10952 | restrict the scope of agenda commands to a file or a subtree by using |
a7808fba | 10953 | the command @kbd{<} in the Speedbar frame. |
4009494e GM |
10954 | @cindex @file{table.el} |
10955 | @item @file{table.el} by Takaaki Ota | |
10956 | @kindex C-c C-c | |
10957 | @cindex table editor, @file{table.el} | |
10958 | @cindex @file{table.el} | |
c8d0cf5c | 10959 | @cindex Ota, Takaaki |
4009494e GM |
10960 | |
10961 | Complex ASCII tables with automatic line wrapping, column- and | |
10962 | row-spanning, and alignment can be created using the Emacs table | |
10963 | package by Takaaki Ota (@uref{http://sourceforge.net/projects/table}, | |
10964 | and also part of Emacs 22). | |
a7808fba | 10965 | When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org mode |
4009494e | 10966 | will call @command{table-recognize-table} and move the cursor into the |
a7808fba CD |
10967 | table. Inside a table, the keymap of Org mode is inactive. In order |
10968 | to execute Org mode-related commands, leave the table. | |
4009494e GM |
10969 | |
10970 | @table @kbd | |
10971 | @kindex C-c C-c | |
10972 | @item C-c C-c | |
10973 | Recognize @file{table.el} table. Works when the cursor is in a | |
10974 | table.el table. | |
10975 | @c | |
10976 | @kindex C-c ~ | |
10977 | @item C-c ~ | |
c8d0cf5c CD |
10978 | Insert a @file{table.el} table. If there is already a table at point, this |
10979 | command converts it between the @file{table.el} format and the Org-mode | |
4009494e GM |
10980 | format. See the documentation string of the command |
10981 | @code{org-convert-table} for the restrictions under which this is | |
10982 | possible. | |
10983 | @end table | |
10984 | @file{table.el} is part of Emacs 22. | |
4009494e | 10985 | @item @file{footnote.el} by Steven L. Baur |
c8d0cf5c CD |
10986 | @cindex @file{footnote.el} |
10987 | @cindex Baur, Steven L. | |
55e0839d | 10988 | Org mode recognizes numerical footnotes as provided by this package. |
c8d0cf5c | 10989 | However, Org mode also has its own footnote support (@pxref{Footnotes}), |
55e0839d | 10990 | which makes using @file{footnote.el} unnecessary. |
4009494e GM |
10991 | @end table |
10992 | ||
10993 | @node Conflicts, , Cooperation, Interaction | |
a7808fba | 10994 | @subsection Packages that lead to conflicts with Org mode |
4009494e GM |
10995 | |
10996 | @table @asis | |
10997 | ||
3da3282e | 10998 | @cindex @code{shift-selection-mode} |
c8d0cf5c | 10999 | @vindex org-support-shift-select |
3da3282e CD |
11000 | In Emacs 23, @code{shift-selection-mode} is on by default, meaning that |
11001 | cursor motions combined with the shift key should start or enlarge regions. | |
11002 | This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change | |
11003 | timestamps, TODO keywords, priorities, and item bullet types if the cursor is | |
11004 | at such a location. By default, @kbd{S-@key{cursor}} commands outside | |
11005 | special contexts don't do anything, but you can customize the variable | |
c8d0cf5c | 11006 | @code{org-support-shift-select}. Org mode then tries to accommodate shift |
3da3282e CD |
11007 | selection by (i) using it outside of the special contexts where special |
11008 | commands apply, and by (ii) extending an existing active region even if the | |
11009 | cursor moves across a special context. | |
4009494e | 11010 | |
4009494e | 11011 | @item @file{CUA.el} by Kim. F. Storm |
c8d0cf5c CD |
11012 | @cindex @file{CUA.el} |
11013 | @cindex Storm, Kim. F. | |
11014 | @vindex org-replace-disputed-keys | |
3da3282e | 11015 | Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode |
c8d0cf5c | 11016 | (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the |
3da3282e CD |
11017 | region. In fact, Emacs 23 has this built-in in the form of |
11018 | @code{shift-selection-mode}, see previous paragraph. If you are using Emacs | |
c8d0cf5c | 11019 | 23, you probably don't want to use another package for this purpose. However, |
3da3282e | 11020 | if you prefer to leave these keys to a different package while working in |
c8d0cf5c | 11021 | Org mode, configure the variable @code{org-replace-disputed-keys}. When set, |
3da3282e CD |
11022 | Org will move the following key bindings in Org files, and in the agenda |
11023 | buffer (but not during date selection). | |
4009494e GM |
11024 | |
11025 | @example | |
3da3282e CD |
11026 | S-UP -> M-p S-DOWN -> M-n |
11027 | S-LEFT -> M-- S-RIGHT -> M-+ | |
11028 | C-S-LEFT -> M-S-- C-S-RIGHT -> M-S-+ | |
4009494e GM |
11029 | @end example |
11030 | ||
c8d0cf5c | 11031 | @vindex org-disputed-keys |
4009494e GM |
11032 | Yes, these are unfortunately more difficult to remember. If you want |
11033 | to have other replacement keys, look at the variable | |
11034 | @code{org-disputed-keys}. | |
3da3282e | 11035 | |
c8d0cf5c CD |
11036 | @item @file{yasnippet.el} |
11037 | @cindex @file{yasnippet.el} | |
11038 | The way Org-mode binds the TAB key (binding to @code{[tab]} instead of | |
11039 | @code{"\t"}) overrules yasnippets' access to this key. The following code | |
11040 | fixed this problem: | |
11041 | ||
11042 | @lisp | |
11043 | (add-hook 'org-mode-hook | |
9360256a GM |
11044 | (lambda () |
11045 | (org-set-local 'yas/trigger-key [tab]) | |
11046 | (define-key yas/keymap [tab] 'yas/next-field-group))) | |
c8d0cf5c CD |
11047 | @end lisp |
11048 | ||
4009494e GM |
11049 | @item @file{windmove.el} by Hovav Shacham |
11050 | @cindex @file{windmove.el} | |
c8d0cf5c | 11051 | This package also uses the @kbd{S-<cursor>} keys, so everything written |
4009494e GM |
11052 | in the paragraph above about CUA mode also applies here. |
11053 | ||
a351880d CD |
11054 | @item @file{viper.el} by Michael Kifer |
11055 | @cindex @file{viper.el} | |
11056 | @kindex C-c / | |
11057 | Viper uses @kbd{C-c /} and therefore makes this key not access the | |
11058 | corresponding Org-mode command @code{org-sparse-tree}. You need to find | |
11059 | another key for this command, or override the key in | |
11060 | @code{viper-vi-global-user-map} with | |
11061 | ||
11062 | @lisp | |
11063 | (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree) | |
11064 | @end lisp | |
11065 | ||
4009494e GM |
11066 | @end table |
11067 | ||
7006d207 CD |
11068 | |
11069 | @node Hacking, MobileOrg, Miscellaneous, Top | |
b349f79f | 11070 | @appendix Hacking |
c8d0cf5c | 11071 | @cindex hacking |
b349f79f CD |
11072 | |
11073 | This appendix covers some aspects where users can extend the functionality of | |
a7808fba | 11074 | Org. |
4009494e GM |
11075 | |
11076 | @menu | |
c8d0cf5c CD |
11077 | * Hooks:: Who to reach into Org's internals |
11078 | * Add-on packages:: Available extensions | |
4009494e | 11079 | * Adding hyperlink types:: New custom link types |
c8d0cf5c CD |
11080 | * Context-sensitive commands:: How to add functionality to such commands |
11081 | * Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs | |
4009494e GM |
11082 | * Dynamic blocks:: Automatically filled blocks |
11083 | * Special agenda views:: Customized views | |
c8d0cf5c | 11084 | * Extracting agenda information:: Postprocessing of agenda information |
4009494e | 11085 | * Using the property API:: Writing programs that use entry properties |
b349f79f | 11086 | * Using the mapping API:: Mapping over all or selected entries |
4009494e GM |
11087 | @end menu |
11088 | ||
c8d0cf5c CD |
11089 | @node Hooks, Add-on packages, Hacking, Hacking |
11090 | @section Hooks | |
11091 | @cindex hooks | |
11092 | ||
11093 | Org has a large number of hook variables that can be used to add | |
11094 | functionality. This appendix about hacking is going to illustrate the | |
11095 | use of some of them. A complete list of all hooks with documentation is | |
11096 | maintained by the Worg project and can be found at | |
11097 | @uref{http://orgmode.org/worg/org-configs/org-hooks.php}. | |
11098 | ||
11099 | @node Add-on packages, Adding hyperlink types, Hooks, Hacking | |
11100 | @section Add-on packages | |
11101 | @cindex add-on packages | |
11102 | ||
11103 | A large number of add-on packages have been written by various authors. | |
11104 | These packages are not part of Emacs, but they are distributed as contributed | |
11105 | packages with the separate release available at the Org mode home page at | |
11106 | @uref{http://orgmode.org}. The list of contributed packages, along with | |
11107 | documentation about each package, is maintained by the Worg project at | |
11108 | @uref{http://orgmode.org/worg/org-contrib/}. | |
11109 | ||
11110 | ||
11111 | ||
11112 | @node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking | |
4009494e GM |
11113 | @section Adding hyperlink types |
11114 | @cindex hyperlinks, adding new types | |
11115 | ||
a7808fba | 11116 | Org has a large number of hyperlink types built-in |
c8d0cf5c CD |
11117 | (@pxref{Hyperlinks}). If you would like to add new link types, Org |
11118 | provides an interface for doing so. Let's look at an example file, | |
11119 | @file{org-man.el}, that will add support for creating links like | |
a7808fba | 11120 | @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside |
c8d0cf5c | 11121 | Emacs: |
4009494e GM |
11122 | |
11123 | @lisp | |
a7808fba | 11124 | ;;; org-man.el - Support for links to manpages in Org |
4009494e GM |
11125 | |
11126 | (require 'org) | |
11127 | ||
11128 | (org-add-link-type "man" 'org-man-open) | |
11129 | (add-hook 'org-store-link-functions 'org-man-store-link) | |
11130 | ||
11131 | (defcustom org-man-command 'man | |
11132 | "The Emacs command to be used to display a man page." | |
11133 | :group 'org-link | |
11134 | :type '(choice (const man) (const woman))) | |
11135 | ||
11136 | (defun org-man-open (path) | |
11137 | "Visit the manpage on PATH. | |
11138 | PATH should be a topic that can be thrown at the man command." | |
11139 | (funcall org-man-command path)) | |
11140 | ||
11141 | (defun org-man-store-link () | |
11142 | "Store a link to a manpage." | |
11143 | (when (memq major-mode '(Man-mode woman-mode)) | |
11144 | ;; This is a man page, we do make this link | |
11145 | (let* ((page (org-man-get-page-name)) | |
11146 | (link (concat "man:" page)) | |
11147 | (description (format "Manpage for %s" page))) | |
11148 | (org-store-link-props | |
11149 | :type "man" | |
11150 | :link link | |
11151 | :description description)))) | |
11152 | ||
11153 | (defun org-man-get-page-name () | |
11154 | "Extract the page name from the buffer name." | |
11155 | ;; This works for both `Man-mode' and `woman-mode'. | |
11156 | (if (string-match " \\(\\S-+\\)\\*" (buffer-name)) | |
11157 | (match-string 1 (buffer-name)) | |
11158 | (error "Cannot create link to this man page"))) | |
11159 | ||
11160 | (provide 'org-man) | |
11161 | ||
11162 | ;;; org-man.el ends here | |
11163 | @end lisp | |
11164 | ||
11165 | @noindent | |
11166 | You would activate this new link type in @file{.emacs} with | |
11167 | ||
11168 | @lisp | |
11169 | (require 'org-man) | |
11170 | @end lisp | |
11171 | ||
11172 | @noindent | |
864c9740 | 11173 | Let's go through the file and see what it does. |
4009494e | 11174 | @enumerate |
28a16a1b | 11175 | @item |
4009494e GM |
11176 | It does @code{(require 'org)} to make sure that @file{org.el} has been |
11177 | loaded. | |
11178 | @item | |
11179 | The next line calls @code{org-add-link-type} to define a new link type | |
11180 | with prefix @samp{man}. The call also contains the name of a function | |
11181 | that will be called to follow such a link. | |
11182 | @item | |
c8d0cf5c | 11183 | @vindex org-store-link-functions |
4009494e GM |
11184 | The next line adds a function to @code{org-store-link-functions}, in |
11185 | order to allow the command @kbd{C-c l} to record a useful link in a | |
11186 | buffer displaying a man page. | |
11187 | @end enumerate | |
11188 | ||
11189 | The rest of the file defines the necessary variables and functions. | |
c8d0cf5c | 11190 | First there is a customization variable that determines which Emacs |
a7808fba | 11191 | command should be used to display man pages. There are two options, |
4009494e | 11192 | @code{man} and @code{woman}. Then the function to follow a link is |
c8d0cf5c | 11193 | defined. It gets the link path as an argument---in this case the link |
4009494e GM |
11194 | path is just a topic for the manual command. The function calls the |
11195 | value of @code{org-man-command} to display the man page. | |
11196 | ||
11197 | Finally the function @code{org-man-store-link} is defined. When you try | |
c8d0cf5c | 11198 | to store a link with @kbd{C-c l}, this function will be called to |
4009494e | 11199 | try to make a link. The function must first decide if it is supposed to |
c8d0cf5c | 11200 | create the link for this buffer type; we do this by checking the value |
4009494e | 11201 | of the variable @code{major-mode}. If not, the function must exit and |
a7808fba CD |
11202 | return the value @code{nil}. If yes, the link is created by getting the |
11203 | manual topic from the buffer name and prefixing it with the string | |
4009494e GM |
11204 | @samp{man:}. Then it must call the command @code{org-store-link-props} |
11205 | and set the @code{:type} and @code{:link} properties. Optionally you | |
11206 | can also set the @code{:description} property to provide a default for | |
a7808fba | 11207 | the link description when the link is later inserted into an Org |
4009494e GM |
11208 | buffer with @kbd{C-c C-l}. |
11209 | ||
c8d0cf5c | 11210 | When is makes sense for your new link type, you may also define a function |
a351880d | 11211 | @code{org-PREFIX-complete-link} that implements special (e.g. completion) |
c8d0cf5c CD |
11212 | support for inserting such a link with @kbd{C-c C-l}. Such a function should |
11213 | not accept any arguments, and return the full link with prefix. | |
11214 | ||
11215 | @node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking | |
11216 | @section Context-sensitive commands | |
11217 | @cindex context-sensitive commands, hooks | |
11218 | @cindex add-ons, context-sensitive commands | |
11219 | @vindex org-ctrl-c-ctrl-c-hook | |
11220 | ||
11221 | Org has several commands that act differently depending on context. The most | |
11222 | important example it the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}). | |
11223 | Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property. | |
11224 | ||
11225 | Add-ons can tap into this functionality by providing a function that detects | |
11226 | special context for that add-on and executes functionality appropriate for | |
11227 | the context. Here is an example from Dan Davison's @file{org-R.el} which | |
11228 | allows you to evaluate commands based on the @file{R} programming language. For | |
11229 | this package, special contexts are lines that start with @code{#+R:} or | |
11230 | @code{#+RR:}. | |
11231 | ||
11232 | @lisp | |
11233 | (defun org-R-apply-maybe () | |
11234 | "Detect if this is context for org-R and execute R commands." | |
11235 | (if (save-excursion | |
11236 | (beginning-of-line 1) | |
11237 | (looking-at "#\\+RR?:")) | |
11238 | (progn (call-interactively 'org-R-apply) | |
11239 | t) ;; to signal that we took action | |
11240 | nil)) ;; to signal that we did not | |
11241 | ||
11242 | (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe) | |
11243 | @end lisp | |
11244 | ||
11245 | The function first checks if the cursor is in such a line. If that is the | |
11246 | case, @code{org-R-apply} is called and the function returns @code{t} to | |
11247 | signal that action was taken, and @kbd{C-c C-c} will stop looking for other | |
11248 | contexts. If the function finds it should do nothing locally, it returns @code{nil} so that other, similar functions can have a try. | |
11249 | ||
11250 | ||
11251 | @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking | |
a7808fba | 11252 | @section Tables and lists in arbitrary syntax |
4009494e | 11253 | @cindex tables, in other modes |
dbc28aaa | 11254 | @cindex lists, in other modes |
a7808fba | 11255 | @cindex Orgtbl mode |
4009494e | 11256 | |
a7808fba | 11257 | Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a |
4009494e | 11258 | frequent feature request has been to make it work with native tables in |
dbc28aaa CD |
11259 | specific languages, for example La@TeX{}. However, this is extremely |
11260 | hard to do in a general way, would lead to a customization nightmare, | |
c8d0cf5c | 11261 | and would take away much of the simplicity of the Orgtbl-mode table |
dbc28aaa CD |
11262 | editor. |
11263 | ||
4009494e | 11264 | |
a7808fba | 11265 | This appendix describes a different approach. We keep the Orgtbl mode |
4009494e GM |
11266 | table in its native format (the @i{source table}), and use a custom |
11267 | function to @i{translate} the table to the correct syntax, and to | |
11268 | @i{install} it in the right location (the @i{target table}). This puts | |
11269 | the burden of writing conversion functions on the user, but it allows | |
11270 | for a very flexible system. | |
11271 | ||
dbc28aaa CD |
11272 | Bastien added the ability to do the same with lists. You can use Org's |
11273 | facilities to edit and structure lists by turning @code{orgstruct-mode} | |
11274 | on, then locally exporting such lists in another format (HTML, La@TeX{} | |
a7808fba | 11275 | or Texinfo.) |
dbc28aaa CD |
11276 | |
11277 | ||
4009494e | 11278 | @menu |
6eb02347 | 11279 | * Radio tables:: Sending and receiving radio tables |
4009494e GM |
11280 | * A LaTeX example:: Step by step, almost a tutorial |
11281 | * Translator functions:: Copy and modify | |
a7808fba | 11282 | * Radio lists:: Doing the same for lists |
4009494e GM |
11283 | @end menu |
11284 | ||
11285 | @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax | |
11286 | @subsection Radio tables | |
11287 | @cindex radio tables | |
11288 | ||
11289 | To define the location of the target table, you first need to create two | |
11290 | lines that are comments in the current mode, but contain magic words for | |
a7808fba | 11291 | Orgtbl mode to find. Orgtbl mode will insert the translated table |
4009494e GM |
11292 | between these lines, replacing whatever was there before. For example: |
11293 | ||
11294 | @example | |
11295 | /* BEGIN RECEIVE ORGTBL table_name */ | |
11296 | /* END RECEIVE ORGTBL table_name */ | |
11297 | @end example | |
11298 | ||
11299 | @noindent | |
11300 | Just above the source table, we put a special line that tells | |
a7808fba | 11301 | Orgtbl mode how to translate this table and where to install it. For |
4009494e | 11302 | example: |
c8d0cf5c | 11303 | @cindex #+ORGTBL |
4009494e GM |
11304 | @example |
11305 | #+ORGTBL: SEND table_name translation_function arguments.... | |
11306 | @end example | |
11307 | ||
11308 | @noindent | |
11309 | @code{table_name} is the reference name for the table that is also used | |
11310 | in the receiver lines. @code{translation_function} is the Lisp function | |
11311 | that does the translation. Furthermore, the line can contain a list of | |
11312 | arguments (alternating key and value) at the end. The arguments will be | |
11313 | passed as a property list to the translation function for | |
11314 | interpretation. A few standard parameters are already recognized and | |
11315 | acted upon before the translation function is called: | |
11316 | ||
11317 | @table @code | |
11318 | @item :skip N | |
b349f79f CD |
11319 | Skip the first N lines of the table. Hlines do count as separate lines for |
11320 | this parameter! | |
11321 | ||
4009494e GM |
11322 | @item :skipcols (n1 n2 ...) |
11323 | List of columns that should be skipped. If the table has a column with | |
11324 | calculation marks, that column is automatically discarded as well. | |
11325 | Please note that the translator function sees the table @emph{after} the | |
11326 | removal of these columns, the function never knows that there have been | |
11327 | additional columns. | |
11328 | @end table | |
11329 | ||
11330 | @noindent | |
11331 | The one problem remaining is how to keep the source table in the buffer | |
11332 | without disturbing the normal workings of the file, for example during | |
11333 | compilation of a C file or processing of a La@TeX{} file. There are a | |
11334 | number of different solutions: | |
11335 | ||
11336 | @itemize @bullet | |
11337 | @item | |
11338 | The table could be placed in a block comment if that is supported by the | |
a7808fba | 11339 | language. For example, in C mode you could wrap the table between |
4009494e | 11340 | @samp{/*} and @samp{*/} lines. |
28a16a1b | 11341 | @item |
4009494e | 11342 | Sometimes it is possible to put the table after some kind of @i{END} |
c8d0cf5c | 11343 | statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}} |
4009494e GM |
11344 | in La@TeX{}. |
11345 | @item | |
c8d0cf5c | 11346 | You can just comment the table line-by-line whenever you want to process |
4009494e | 11347 | the file, and uncomment it whenever you need to edit the table. This |
c8d0cf5c CD |
11348 | only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment} |
11349 | makes this comment-toggling very easy, in particular if you bind it to a | |
4009494e GM |
11350 | key. |
11351 | @end itemize | |
11352 | ||
11353 | @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax | |
c8d0cf5c CD |
11354 | @subsection A La@TeX{} example of radio tables |
11355 | @cindex La@TeX{}, and Orgtbl mode | |
4009494e GM |
11356 | |
11357 | The best way to wrap the source table in La@TeX{} is to use the | |
11358 | @code{comment} environment provided by @file{comment.sty}. It has to be | |
11359 | activated by placing @code{\usepackage@{comment@}} into the document | |
a7808fba CD |
11360 | header. Orgtbl mode can insert a radio table skeleton@footnote{By |
11361 | default this works only for La@TeX{}, HTML, and Texinfo. Configure the | |
4009494e GM |
11362 | variable @code{orgtbl-radio-tables} to install templates for other |
11363 | modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will | |
55e0839d | 11364 | be prompted for a table name, let's say we use @samp{salesfigures}. You |
4009494e GM |
11365 | will then get the following template: |
11366 | ||
c8d0cf5c | 11367 | @cindex #+ORGTBL, SEND |
4009494e GM |
11368 | @example |
11369 | % BEGIN RECEIVE ORGTBL salesfigures | |
11370 | % END RECEIVE ORGTBL salesfigures | |
11371 | \begin@{comment@} | |
11372 | #+ORGTBL: SEND salesfigures orgtbl-to-latex | |
11373 | | | | | |
11374 | \end@{comment@} | |
11375 | @end example | |
11376 | ||
11377 | @noindent | |
c8d0cf5c | 11378 | @vindex La@TeX{}-verbatim-environments |
a7808fba | 11379 | The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function |
4009494e GM |
11380 | @code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it |
11381 | into the receiver location with name @code{salesfigures}. You may now | |
11382 | fill in the table, feel free to use the spreadsheet features@footnote{If | |
11383 | the @samp{#+TBLFM} line contains an odd number of dollar characters, | |
c8d0cf5c | 11384 | this may cause problems with font-lock in La@TeX{} mode. As shown in the |
4009494e GM |
11385 | example you can fix this by adding an extra line inside the |
11386 | @code{comment} environment that is used to balance the dollar | |
c8d0cf5c | 11387 | expressions. If you are using AUC@TeX{} with the font-latex library, a |
4009494e GM |
11388 | much better solution is to add the @code{comment} environment to the |
11389 | variable @code{LaTeX-verbatim-environments}.}: | |
11390 | ||
11391 | @example | |
11392 | % BEGIN RECEIVE ORGTBL salesfigures | |
11393 | % END RECEIVE ORGTBL salesfigures | |
11394 | \begin@{comment@} | |
11395 | #+ORGTBL: SEND salesfigures orgtbl-to-latex | |
11396 | | Month | Days | Nr sold | per day | | |
11397 | |-------+------+---------+---------| | |
11398 | | Jan | 23 | 55 | 2.4 | | |
11399 | | Feb | 21 | 16 | 0.8 | | |
11400 | | March | 22 | 278 | 12.6 | | |
11401 | #+TBLFM: $4=$3/$2;%.1f | |
11402 | % $ (optional extra dollar to keep font-lock happy, see footnote) | |
11403 | \end@{comment@} | |
11404 | @end example | |
11405 | ||
11406 | @noindent | |
11407 | When you are done, press @kbd{C-c C-c} in the table to get the converted | |
11408 | table inserted between the two marker lines. | |
11409 | ||
55e0839d | 11410 | Now let's assume you want to make the table header by hand, because you |
c8d0cf5c CD |
11411 | want to control how columns are aligned, etc@. In this case we make sure |
11412 | that the table translator skips the first 2 lines of the source | |
a351880d | 11413 | table, and tell the command to work as a @i{splice}, i.e. to not produce |
4009494e GM |
11414 | header and footer commands of the target table: |
11415 | ||
11416 | @example | |
11417 | \begin@{tabular@}@{lrrr@} | |
11418 | Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\ | |
11419 | % BEGIN RECEIVE ORGTBL salesfigures | |
11420 | % END RECEIVE ORGTBL salesfigures | |
11421 | \end@{tabular@} | |
11422 | % | |
11423 | \begin@{comment@} | |
11424 | #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2 | |
11425 | | Month | Days | Nr sold | per day | | |
11426 | |-------+------+---------+---------| | |
11427 | | Jan | 23 | 55 | 2.4 | | |
11428 | | Feb | 21 | 16 | 0.8 | | |
11429 | | March | 22 | 278 | 12.6 | | |
11430 | #+TBLFM: $4=$3/$2;%.1f | |
11431 | \end@{comment@} | |
11432 | @end example | |
11433 | ||
11434 | The La@TeX{} translator function @code{orgtbl-to-latex} is already part of | |
a7808fba | 11435 | Orgtbl mode. It uses a @code{tabular} environment to typeset the table |
4009494e | 11436 | and marks horizontal lines with @code{\hline}. Furthermore, it |
c8d0cf5c | 11437 | interprets the following parameters (see also @pxref{Translator functions}): |
4009494e GM |
11438 | |
11439 | @table @code | |
11440 | @item :splice nil/t | |
11441 | When set to t, return only table body lines, don't wrap them into a | |
11442 | tabular environment. Default is nil. | |
11443 | ||
11444 | @item :fmt fmt | |
c8d0cf5c | 11445 | A format to be used to wrap each field, it should contain @code{%s} for the |
4009494e GM |
11446 | original field value. For example, to wrap each field value in dollars, |
11447 | you could use @code{:fmt "$%s$"}. This may also be a property list with | |
11448 | column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}. | |
a7808fba CD |
11449 | A function of one argument can be used in place of the strings; the |
11450 | function must return a formatted string. | |
4009494e GM |
11451 | |
11452 | @item :efmt efmt | |
11453 | Use this format to print numbers with exponentials. The format should | |
11454 | have @code{%s} twice for inserting mantissa and exponent, for example | |
11455 | @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This | |
11456 | may also be a property list with column numbers and formats, for example | |
11457 | @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After | |
11458 | @code{efmt} has been applied to a value, @code{fmt} will also be | |
a7808fba CD |
11459 | applied. Similar to @code{fmt}, functions of two arguments can be |
11460 | supplied instead of strings. | |
4009494e GM |
11461 | @end table |
11462 | ||
dbc28aaa | 11463 | @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax |
4009494e | 11464 | @subsection Translator functions |
a7808fba | 11465 | @cindex HTML, and Orgtbl mode |
4009494e GM |
11466 | @cindex translator function |
11467 | ||
b349f79f CD |
11468 | Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv} |
11469 | (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values) | |
11470 | @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}. | |
11471 | Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same | |
11472 | code that produces tables during HTML export.}, these all use a generic | |
11473 | translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex} | |
11474 | itself is a very short function that computes the column definitions for the | |
11475 | @code{tabular} environment, defines a few field and line separators and then | |
c8d0cf5c | 11476 | hands processing over to the generic translator. Here is the entire code: |
4009494e GM |
11477 | |
11478 | @lisp | |
11479 | @group | |
11480 | (defun orgtbl-to-latex (table params) | |
a7808fba | 11481 | "Convert the Orgtbl mode TABLE to LaTeX." |
4009494e GM |
11482 | (let* ((alignment (mapconcat (lambda (x) (if x "r" "l")) |
11483 | org-table-last-alignment "")) | |
11484 | (params2 | |
11485 | (list | |
11486 | :tstart (concat "\\begin@{tabular@}@{" alignment "@}") | |
11487 | :tend "\\end@{tabular@}" | |
11488 | :lstart "" :lend " \\\\" :sep " & " | |
11489 | :efmt "%s\\,(%s)" :hline "\\hline"))) | |
11490 | (orgtbl-to-generic table (org-combine-plists params2 params)))) | |
11491 | @end group | |
11492 | @end lisp | |
11493 | ||
11494 | As you can see, the properties passed into the function (variable | |
11495 | @var{PARAMS}) are combined with the ones newly defined in the function | |
a351880d | 11496 | (variable @var{PARAMS2}). The ones passed into the function (i.e. the |
4009494e GM |
11497 | ones set by the @samp{ORGTBL SEND} line) take precedence. So if you |
11498 | would like to use the La@TeX{} translator, but wanted the line endings to | |
11499 | be @samp{\\[2mm]} instead of the default @samp{\\}, you could just | |
11500 | overrule the default with | |
11501 | ||
11502 | @example | |
11503 | #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]" | |
11504 | @end example | |
11505 | ||
11506 | For a new language, you can either write your own converter function in | |
11507 | analogy with the La@TeX{} translator, or you can use the generic function | |
11508 | directly. For example, if you have a language where a table is started | |
11509 | with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are | |
c8d0cf5c | 11510 | started with @samp{!BL!}, ended with @samp{!EL!}, and where the field |
4009494e GM |
11511 | separator is a TAB, you could call the generic translator like this (on |
11512 | a single line!): | |
11513 | ||
11514 | @example | |
11515 | #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!" | |
11516 | :lstart "!BL! " :lend " !EL!" :sep "\t" | |
11517 | @end example | |
11518 | ||
11519 | @noindent | |
11520 | Please check the documentation string of the function | |
11521 | @code{orgtbl-to-generic} for a full list of parameters understood by | |
c8d0cf5c | 11522 | that function, and remember that you can pass each of them into |
4009494e GM |
11523 | @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function |
11524 | using the generic function. | |
11525 | ||
11526 | Of course you can also write a completely new function doing complicated | |
11527 | things the generic translator cannot do. A translator function takes | |
11528 | two arguments. The first argument is the table, a list of lines, each | |
11529 | line either the symbol @code{hline} or a list of fields. The second | |
11530 | argument is the property list containing all parameters specified in the | |
11531 | @samp{#+ORGTBL: SEND} line. The function must return a single string | |
11532 | containing the formatted table. If you write a generally useful | |
c8d0cf5c | 11533 | translator, please post it on @email{emacs-orgmode@@gnu.org} so that |
4009494e GM |
11534 | others can benefit from your work. |
11535 | ||
dbc28aaa CD |
11536 | @node Radio lists, , Translator functions, Tables in arbitrary syntax |
11537 | @subsection Radio lists | |
11538 | @cindex radio lists | |
11539 | @cindex org-list-insert-radio-list | |
11540 | ||
6eb02347 CD |
11541 | Sending and receiving radio lists works exactly the same way than sending and |
11542 | receiving radio tables (@pxref{Radio tables}). As for radio tables, you can | |
11543 | insert radio lists templates in HTML, La@TeX{} and Texinfo modes by calling | |
11544 | @code{org-list-insert-radio-list}. | |
dbc28aaa CD |
11545 | |
11546 | Here are the differences with radio tables: | |
11547 | ||
11548 | @itemize @minus | |
11549 | @item | |
11550 | Use @code{ORGLST} instead of @code{ORGTBL}. | |
11551 | @item | |
11552 | The available translation functions for radio lists don't take | |
11553 | parameters. | |
28a16a1b | 11554 | @item |
c8d0cf5c | 11555 | @kbd{C-c C-c} will work when pressed on the first item of the list. |
dbc28aaa CD |
11556 | @end itemize |
11557 | ||
11558 | Here is a La@TeX{} example. Let's say that you have this in your | |
11559 | La@TeX{} file: | |
11560 | ||
c8d0cf5c | 11561 | @cindex #+ORGLIST |
dbc28aaa CD |
11562 | @example |
11563 | % BEGIN RECEIVE ORGLST to-buy | |
11564 | % END RECEIVE ORGLST to-buy | |
11565 | \begin@{comment@} | |
11566 | #+ORGLIST: SEND to-buy orgtbl-to-latex | |
11567 | - a new house | |
11568 | - a new computer | |
11569 | + a new keyboard | |
11570 | + a new mouse | |
11571 | - a new life | |
11572 | \end@{comment@} | |
11573 | @end example | |
11574 | ||
11575 | Pressing `C-c C-c' on @code{a new house} and will insert the converted | |
11576 | La@TeX{} list between the two marker lines. | |
11577 | ||
b349f79f | 11578 | @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking |
4009494e GM |
11579 | @section Dynamic blocks |
11580 | @cindex dynamic blocks | |
11581 | ||
a7808fba | 11582 | Org documents can contain @emph{dynamic blocks}. These are |
4009494e GM |
11583 | specially marked regions that are updated by some user-written function. |
11584 | A good example for such a block is the clock table inserted by the | |
11585 | command @kbd{C-c C-x C-r} (@pxref{Clocking work time}). | |
11586 | ||
11587 | Dynamic block are enclosed by a BEGIN-END structure that assigns a name | |
11588 | to the block and can also specify parameters for the function producing | |
11589 | the content of the block. | |
11590 | ||
b349f79f | 11591 | #+BEGIN:dynamic block |
4009494e GM |
11592 | @example |
11593 | #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ... | |
11594 | ||
11595 | #+END: | |
11596 | @end example | |
11597 | ||
11598 | Dynamic blocks are updated with the following commands | |
11599 | ||
11600 | @table @kbd | |
11601 | @kindex C-c C-x C-u | |
11602 | @item C-c C-x C-u | |
11603 | Update dynamic block at point. | |
11604 | @kindex C-u C-c C-x C-u | |
11605 | @item C-u C-c C-x C-u | |
11606 | Update all dynamic blocks in the current file. | |
11607 | @end table | |
11608 | ||
11609 | Updating a dynamic block means to remove all the text between BEGIN and | |
11610 | END, parse the BEGIN line for parameters and then call the specific | |
28a16a1b CD |
11611 | writer function for this block to insert the new content. If you want |
11612 | to use the original content in the writer function, you can use the | |
11613 | extra parameter @code{:content}. | |
11614 | ||
11615 | For a block with name @code{myblock}, the writer function is | |
4009494e GM |
11616 | @code{org-dblock-write:myblock} with as only parameter a property list |
11617 | with the parameters given in the begin line. Here is a trivial example | |
11618 | of a block that keeps track of when the block update function was last | |
11619 | run: | |
11620 | ||
11621 | @example | |
11622 | #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M" | |
11623 | ||
11624 | #+END: | |
11625 | @end example | |
11626 | ||
11627 | @noindent | |
11628 | The corresponding block writer function could look like this: | |
11629 | ||
11630 | @lisp | |
11631 | (defun org-dblock-write:block-update-time (params) | |
11632 | (let ((fmt (or (plist-get params :format) "%d. %m. %Y"))) | |
11633 | (insert "Last block update at: " | |
11634 | (format-time-string fmt (current-time))))) | |
11635 | @end lisp | |
11636 | ||
11637 | If you want to make sure that all dynamic blocks are always up-to-date, | |
11638 | you could add the function @code{org-update-all-dblocks} to a hook, for | |
11639 | example @code{before-save-hook}. @code{org-update-all-dblocks} is | |
c8d0cf5c | 11640 | written in a way such that it does nothing in buffers that are not in |
a7808fba | 11641 | @code{org-mode}. |
4009494e | 11642 | |
c8d0cf5c | 11643 | @node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking |
a7808fba | 11644 | @section Special agenda views |
4009494e GM |
11645 | @cindex agenda views, user-defined |
11646 | ||
a7808fba | 11647 | Org provides a special hook that can be used to narrow down the |
4009494e GM |
11648 | selection made by any of the agenda views. You may specify a function |
11649 | that is used at each match to verify if the match should indeed be part | |
11650 | of the agenda view, and if not, how much should be skipped. | |
11651 | ||
11652 | Let's say you want to produce a list of projects that contain a WAITING | |
11653 | tag anywhere in the project tree. Let's further assume that you have | |
a7808fba CD |
11654 | marked all tree headings that define a project with the TODO keyword |
11655 | PROJECT. In this case you would run a TODO search for the keyword | |
4009494e GM |
11656 | PROJECT, but skip the match unless there is a WAITING tag anywhere in |
11657 | the subtree belonging to the project line. | |
11658 | ||
11659 | To achieve this, you must write a function that searches the subtree for | |
11660 | the tag. If the tag is found, the function must return @code{nil} to | |
11661 | indicate that this match should not be skipped. If there is no such | |
11662 | tag, return the location of the end of the subtree, to indicate that | |
11663 | search should continue from there. | |
11664 | ||
11665 | @lisp | |
11666 | (defun my-skip-unless-waiting () | |
11667 | "Skip trees that are not waiting" | |
11668 | (let ((subtree-end (save-excursion (org-end-of-subtree t)))) | |
dbc28aaa | 11669 | (if (re-search-forward ":waiting:" subtree-end t) |
4009494e GM |
11670 | nil ; tag found, do not skip |
11671 | subtree-end))) ; tag not found, continue after end of subtree | |
11672 | @end lisp | |
11673 | ||
11674 | Now you may use this function in an agenda custom command, for example | |
11675 | like this: | |
11676 | ||
11677 | @lisp | |
11678 | (org-add-agenda-custom-command | |
11679 | '("b" todo "PROJECT" | |
e45e3595 | 11680 | ((org-agenda-skip-function 'my-skip-unless-waiting) |
4009494e GM |
11681 | (org-agenda-overriding-header "Projects waiting for something: ")))) |
11682 | @end lisp | |
11683 | ||
c8d0cf5c | 11684 | @vindex org-agenda-overriding-header |
4009494e GM |
11685 | Note that this also binds @code{org-agenda-overriding-header} to get a |
11686 | meaningful header in the agenda view. | |
11687 | ||
c8d0cf5c CD |
11688 | @vindex org-odd-levels-only |
11689 | @vindex org-agenda-skip-function | |
a7808fba CD |
11690 | A general way to create custom searches is to base them on a search for |
11691 | entries with a certain level limit. If you want to study all entries with | |
c8d0cf5c CD |
11692 | your custom search function, simply do a search for |
11693 | @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a | |
11694 | level number corresponds to order in the hierarchy, not to the number of | |
11695 | stars.}, and then use @code{org-agenda-skip-function} to select the entries | |
11696 | you really want to have. | |
a7808fba | 11697 | |
4009494e GM |
11698 | You may also put a Lisp form into @code{org-agenda-skip-function}. In |
11699 | particular, you may use the functions @code{org-agenda-skip-entry-if} | |
11700 | and @code{org-agenda-skip-subtree-if} in this form, for example: | |
11701 | ||
11702 | @table @code | |
11703 | @item '(org-agenda-skip-entry-if 'scheduled) | |
11704 | Skip current entry if it has been scheduled. | |
11705 | @item '(org-agenda-skip-entry-if 'notscheduled) | |
11706 | Skip current entry if it has not been scheduled. | |
11707 | @item '(org-agenda-skip-entry-if 'deadline) | |
11708 | Skip current entry if it has a deadline. | |
11709 | @item '(org-agenda-skip-entry-if 'scheduled 'deadline) | |
11710 | Skip current entry if it has a deadline, or if it is scheduled. | |
c8d0cf5c CD |
11711 | @item '(org-agenda-skip-entry-if 'timestamp) |
11712 | Skip current entry if it has any timestamp, may also be deadline or scheduled. | |
4009494e | 11713 | @item '(org-agenda-skip-entry 'regexp "regular expression") |
dbc28aaa CD |
11714 | Skip current entry if the regular expression matches in the entry. |
11715 | @item '(org-agenda-skip-entry 'notregexp "regular expression") | |
11716 | Skip current entry unless the regular expression matches. | |
4009494e GM |
11717 | @item '(org-agenda-skip-subtree-if 'regexp "regular expression") |
11718 | Same as above, but check and skip the entire subtree. | |
11719 | @end table | |
11720 | ||
11721 | Therefore we could also have written the search for WAITING projects | |
11722 | like this, even without defining a special function: | |
11723 | ||
11724 | @lisp | |
11725 | (org-add-agenda-custom-command | |
11726 | '("b" todo "PROJECT" | |
11727 | ((org-agenda-skip-function '(org-agenda-skip-subtree-if | |
dbc28aaa | 11728 | 'regexp ":waiting:")) |
4009494e GM |
11729 | (org-agenda-overriding-header "Projects waiting for something: ")))) |
11730 | @end lisp | |
11731 | ||
c8d0cf5c CD |
11732 | @node Extracting agenda information, Using the property API, Special agenda views, Hacking |
11733 | @section Extracting agenda information | |
11734 | @cindex agenda, pipe | |
11735 | @cindex Scripts, for agenda processing | |
11736 | ||
11737 | @vindex org-agenda-custom-commands | |
11738 | Org provides commands to access agenda information for the command | |
11739 | line in Emacs batch mode. This extracted information can be sent | |
11740 | directly to a printer, or it can be read by a program that does further | |
11741 | processing of the data. The first of these commands is the function | |
11742 | @code{org-batch-agenda}, that produces an agenda view and sends it as | |
11743 | ASCII text to STDOUT. The command takes a single string as parameter. | |
11744 | If the string has length 1, it is used as a key to one of the commands | |
11745 | you have configured in @code{org-agenda-custom-commands}, basically any | |
11746 | key you can use after @kbd{C-c a}. For example, to directly print the | |
11747 | current TODO list, you could use | |
11748 | ||
11749 | @example | |
11750 | emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr | |
11751 | @end example | |
11752 | ||
11753 | If the parameter is a string with 2 or more characters, it is used as a | |
11754 | tags/TODO match string. For example, to print your local shopping list | |
11755 | (all items with the tag @samp{shop}, but excluding the tag | |
11756 | @samp{NewYork}), you could use | |
11757 | ||
11758 | @example | |
11759 | emacs -batch -l ~/.emacs \ | |
11760 | -eval '(org-batch-agenda "+shop-NewYork")' | lpr | |
11761 | @end example | |
11762 | ||
11763 | @noindent | |
11764 | You may also modify parameters on the fly like this: | |
11765 | ||
11766 | @example | |
11767 | emacs -batch -l ~/.emacs \ | |
11768 | -eval '(org-batch-agenda "a" \ | |
11769 | org-agenda-ndays 30 \ | |
11770 | org-agenda-include-diary nil \ | |
11771 | org-agenda-files (quote ("~/org/project.org")))' \ | |
11772 | | lpr | |
11773 | @end example | |
11774 | ||
11775 | @noindent | |
11776 | which will produce a 30-day agenda, fully restricted to the Org file | |
11777 | @file{~/org/projects.org}, not even including the diary. | |
11778 | ||
11779 | If you want to process the agenda data in more sophisticated ways, you | |
11780 | can use the command @code{org-batch-agenda-csv} to get a comma-separated | |
11781 | list of values for each agenda item. Each line in the output will | |
11782 | contain a number of fields separated by commas. The fields in a line | |
11783 | are: | |
11784 | ||
11785 | @example | |
11786 | category @r{The category of the item} | |
11787 | head @r{The headline, without TODO keyword, TAGS and PRIORITY} | |
11788 | type @r{The type of the agenda entry, can be} | |
11789 | todo @r{selected in TODO match} | |
11790 | tagsmatch @r{selected in tags match} | |
11791 | diary @r{imported from diary} | |
11792 | deadline @r{a deadline} | |
11793 | scheduled @r{scheduled} | |
11794 | timestamp @r{appointment, selected by timestamp} | |
11795 | closed @r{entry was closed on date} | |
11796 | upcoming-deadline @r{warning about nearing deadline} | |
11797 | past-scheduled @r{forwarded scheduled item} | |
11798 | block @r{entry has date block including date} | |
11799 | todo @r{The TODO keyword, if any} | |
11800 | tags @r{All tags including inherited ones, separated by colons} | |
11801 | date @r{The relevant date, like 2007-2-14} | |
11802 | time @r{The time, like 15:00-16:50} | |
11803 | extra @r{String with extra planning info} | |
11804 | priority-l @r{The priority letter if any was given} | |
11805 | priority-n @r{The computed numerical priority} | |
11806 | @end example | |
11807 | ||
11808 | @noindent | |
11809 | Time and date will only be given if a timestamp (or deadline/scheduled) | |
11810 | led to the selection of the item. | |
11811 | ||
11812 | A CSV list like this is very easy to use in a post-processing script. | |
11813 | For example, here is a Perl program that gets the TODO list from | |
11814 | Emacs/Org and prints all the items, preceded by a checkbox: | |
11815 | ||
11816 | @example | |
11817 | #!/usr/bin/perl | |
11818 | ||
11819 | # define the Emacs command to run | |
11820 | $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'"; | |
11821 | ||
11822 | # run it and capture the output | |
11823 | $agenda = qx@{$cmd 2>/dev/null@}; | |
11824 | ||
11825 | # loop over all lines | |
11826 | foreach $line (split(/\n/,$agenda)) @{ | |
11827 | # get the individual values | |
11828 | ($category,$head,$type,$todo,$tags,$date,$time,$extra, | |
11829 | $priority_l,$priority_n) = split(/,/,$line); | |
11830 | # process and print | |
11831 | print "[ ] $head\n"; | |
11832 | @} | |
11833 | @end example | |
11834 | ||
c8d0cf5c | 11835 | @node Using the property API, Using the mapping API, Extracting agenda information, Hacking |
4009494e GM |
11836 | @section Using the property API |
11837 | @cindex API, for properties | |
11838 | @cindex properties, API | |
11839 | ||
11840 | Here is a description of the functions that can be used to work with | |
11841 | properties. | |
11842 | ||
11843 | @defun org-entry-properties &optional pom which | |
c8d0cf5c | 11844 | Get all properties of the entry at point-or-marker POM.@* |
4009494e GM |
11845 | This includes the TODO keyword, the tags, time strings for deadline, |
11846 | scheduled, and clocking, and any additional properties defined in the | |
11847 | entry. The return value is an alist, keys may occur multiple times | |
c8d0cf5c | 11848 | if the property key was used several times.@* |
4009494e GM |
11849 | POM may also be nil, in which case the current entry is used. |
11850 | If WHICH is nil or `all', get all properties. If WHICH is | |
11851 | `special' or `standard', only get that subclass. | |
11852 | @end defun | |
c8d0cf5c | 11853 | @vindex org-use-property-inheritance |
4009494e | 11854 | @defun org-entry-get pom property &optional inherit |
a7808fba CD |
11855 | Get value of PROPERTY for entry at point-or-marker POM. By default, |
11856 | this only looks at properties defined locally in the entry. If INHERIT | |
11857 | is non-nil and the entry does not have the property, then also check | |
11858 | higher levels of the hierarchy. If INHERIT is the symbol | |
11859 | @code{selective}, use inheritance if and only if the setting of | |
11860 | @code{org-use-property-inheritance} selects PROPERTY for inheritance. | |
4009494e GM |
11861 | @end defun |
11862 | ||
11863 | @defun org-entry-delete pom property | |
11864 | Delete the property PROPERTY from entry at point-or-marker POM. | |
11865 | @end defun | |
11866 | ||
11867 | @defun org-entry-put pom property value | |
11868 | Set PROPERTY to VALUE for entry at point-or-marker POM. | |
11869 | @end defun | |
11870 | ||
11871 | @defun org-buffer-property-keys &optional include-specials | |
11872 | Get all property keys in the current buffer. | |
11873 | @end defun | |
11874 | ||
11875 | @defun org-insert-property-drawer | |
11876 | Insert a property drawer at point. | |
11877 | @end defun | |
11878 | ||
864c9740 CD |
11879 | @defun org-entry-put-multivalued-property pom property &rest values |
11880 | Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of | |
11881 | strings. They will be concatenated, with spaces as separators. | |
11882 | @end defun | |
11883 | ||
11884 | @defun org-entry-get-multivalued-property pom property | |
11885 | Treat the value of the property PROPERTY as a whitespace-separated list of | |
11886 | values and return the values as a list of strings. | |
11887 | @end defun | |
11888 | ||
a7808fba CD |
11889 | @defun org-entry-add-to-multivalued-property pom property value |
11890 | Treat the value of the property PROPERTY as a whitespace-separated list of | |
11891 | values and make sure that VALUE is in this list. | |
11892 | @end defun | |
11893 | ||
11894 | @defun org-entry-remove-from-multivalued-property pom property value | |
11895 | Treat the value of the property PROPERTY as a whitespace-separated list of | |
11896 | values and make sure that VALUE is @emph{not} in this list. | |
11897 | @end defun | |
11898 | ||
11899 | @defun org-entry-member-in-multivalued-property pom property value | |
11900 | Treat the value of the property PROPERTY as a whitespace-separated list of | |
11901 | values and check if VALUE is in this list. | |
11902 | @end defun | |
11903 | ||
b349f79f CD |
11904 | @node Using the mapping API, , Using the property API, Hacking |
11905 | @section Using the mapping API | |
11906 | @cindex API, for mapping | |
11907 | @cindex mapping entries, API | |
11908 | ||
11909 | Org has sophisticated mapping capabilities to find all entries satisfying | |
11910 | certain criteria. Internally, this functionality is used to produce agenda | |
11911 | views, but there is also an API that can be used to execute arbitrary | |
11912 | functions for each or selected entries. The main entry point for this API | |
96c8522a | 11913 | is: |
b349f79f CD |
11914 | |
11915 | @defun org-map-entries func &optional match scope &rest skip | |
11916 | Call FUNC at each headline selected by MATCH in SCOPE. | |
11917 | ||
c8d0cf5c | 11918 | FUNC is a function or a Lisp form. The function will be called without |
b349f79f CD |
11919 | arguments, with the cursor positioned at the beginning of the headline. |
11920 | The return values of all calls to the function will be collected and | |
11921 | returned as a list. | |
11922 | ||
c8d0cf5c CD |
11923 | The call to FUNC will be wrapped into a save-excursion form, so FUNC |
11924 | does not need to preserve point. After evaluation, the cursor will be | |
11925 | moved to the end of the line (presumably of the headline of the | |
11926 | processed entry) and search continues from there. Under some | |
11927 | circumstances, this may not produce the wanted results. For example, | |
a351880d | 11928 | if you have removed (e.g. archived) the current (sub)tree it could |
c8d0cf5c CD |
11929 | mean that the next entry will be skipped entirely. In such cases, you |
11930 | can specify the position from where search should continue by making | |
11931 | FUNC set the variable `org-map-continue-from' to the desired buffer | |
11932 | position. | |
11933 | ||
864c9740 | 11934 | MATCH is a tags/property/todo match as it is used in the agenda match view. |
b349f79f CD |
11935 | Only headlines that are matched by this query will be considered during |
11936 | the iteration. When MATCH is nil or t, all headlines will be | |
11937 | visited by the iteration. | |
11938 | ||
11939 | SCOPE determines the scope of this command. It can be any of: | |
11940 | ||
11941 | @example | |
11942 | nil @r{the current buffer, respecting the restriction if any} | |
11943 | tree @r{the subtree started with the entry at point} | |
11944 | file @r{the current buffer, without restriction} | |
11945 | file-with-archives | |
11946 | @r{the current buffer, and any archives associated with it} | |
11947 | agenda @r{all agenda files} | |
11948 | agenda-with-archives | |
11949 | @r{all agenda files with any archive files associated with them} | |
11950 | (file1 file2 ...) | |
11951 | @r{if this is a list, all files in the list will be scanned} | |
11952 | @end example | |
c8d0cf5c | 11953 | @noindent |
b349f79f CD |
11954 | The remaining args are treated as settings for the skipping facilities of |
11955 | the scanner. The following items can be given here: | |
11956 | ||
c8d0cf5c | 11957 | @vindex org-agenda-skip-function |
b349f79f CD |
11958 | @example |
11959 | archive @r{skip trees with the archive tag} | |
11960 | comment @r{skip trees with the COMMENT keyword} | |
11961 | function or Lisp form | |
11962 | @r{will be used as value for @code{org-agenda-skip-function},} | |
867d4bb3 | 11963 | @r{so whenever the function returns t, FUNC} |
b349f79f CD |
11964 | @r{will not be called for that entry and search will} |
11965 | @r{continue from the point where the function leaves it} | |
11966 | @end example | |
11967 | @end defun | |
11968 | ||
11969 | The function given to that mapping routine can really do anything you like. | |
a50253cc GM |
11970 | It can use the property API (@pxref{Using the property API}) to gather more |
11971 | information about the entry, or in order to change metadata in the entry. | |
b349f79f | 11972 | Here are a couple of functions that might be handy: |
96c8522a | 11973 | |
b349f79f CD |
11974 | @defun org-todo &optional arg |
11975 | Change the TODO state of the entry, see the docstring of the functions for | |
11976 | the many possible values for the argument ARG. | |
11977 | @end defun | |
11978 | ||
11979 | @defun org-priority &optional action | |
11980 | Change the priority of the entry, see the docstring of this function for the | |
11981 | possible values for ACTION. | |
11982 | @end defun | |
11983 | ||
11984 | @defun org-toggle-tag tag &optional onoff | |
11985 | Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on} | |
11986 | or @code{off} will not toggle tag, but ensure that it is either on or off. | |
11987 | @end defun | |
11988 | ||
11989 | @defun org-promote | |
11990 | Promote the current entry. | |
11991 | @end defun | |
11992 | ||
11993 | @defun org-demote | |
11994 | Demote the current entry. | |
11995 | @end defun | |
11996 | ||
11997 | Here is a simple example that will turn all entries in the current file with | |
11998 | a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}. | |
11999 | Entries in comment trees and in archive trees will be ignored. | |
12000 | ||
12001 | @lisp | |
12002 | (org-map-entries | |
12003 | '(org-todo "UPCOMING") | |
12004 | "+TOMORROW" 'file 'archive 'comment) | |
12005 | @end lisp | |
12006 | ||
12007 | The following example counts the number of entries with TODO keyword | |
12008 | @code{WAITING}, in all agenda files. | |
12009 | ||
12010 | @lisp | |
96c8522a | 12011 | (length (org-map-entries t "/+WAITING" 'agenda)) |
b349f79f CD |
12012 | @end lisp |
12013 | ||
7006d207 CD |
12014 | @node MobileOrg, History and Acknowledgments, Hacking, Top |
12015 | @appendix MobileOrg | |
12016 | @cindex iPhone | |
12017 | @cindex MobileOrg | |
12018 | ||
12019 | @i{MobileOrg} is an application for the @i{iPhone/iPod Touch} series of | |
a351880d CD |
12020 | devices, developed by Richard Moreland. @i{MobileOrg} offers offline viewing |
12021 | and capture support for an Org-mode system rooted on a ``real'' computer. It | |
12022 | does also allow you to record changes to existing entries. For information | |
12023 | about @i{MobileOrg}, see @uref{http://mobileorg.ncogni.to/}). | |
7006d207 CD |
12024 | |
12025 | This appendix describes the support Org has for creating agenda views in a | |
12026 | format that can be displayed by @i{MobileOrg}, and for integrating notes | |
a351880d CD |
12027 | captured and changes made by @i{MobileOrg} into the main system. |
12028 | ||
12029 | For changing tags and TODO states in MobileOrg, you should have set up the | |
12030 | customization variables @code{org-todo-keywords} and @code{org-tags-alist} to | |
12031 | cover all important tags and todo keywords, even if individual files use only | |
12032 | part of these. MobileOrg will also offer you states and tags set up with | |
12033 | in-buffer settings, but it will understand the logistics of todo state | |
12034 | @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags | |
12035 | (@pxref{Setting tags}) only for those set in these variables. | |
7006d207 CD |
12036 | |
12037 | @menu | |
12038 | * Setting up the staging area:: Where to interact with the mobile device | |
12039 | * Pushing to MobileOrg:: Uploading Org files and agendas | |
12040 | * Pulling from MobileOrg:: Integrating captured and flagged items | |
12041 | @end menu | |
12042 | ||
12043 | @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg | |
12044 | @section Setting up the staging area | |
12045 | ||
12046 | Org-mode has commands to prepare a directory with files for @i{MobileOrg}, | |
12047 | and to read captured notes from there. If Emacs can directly write to the | |
a351880d CD |
12048 | WebDAV directory accessed by @i{MobileOrg}, just point to this directory |
12049 | using the variable @code{org-mobile-directory}. Using the @file{tramp} | |
12050 | method, @code{org-mobile-directory} may point to a remote directory | |
12051 | accessible through, for example, | |
12052 | @file{ssh/scp}: | |
12053 | ||
12054 | @smallexample | |
12055 | (setq org-mobile-directory "/scpc:user@@remote.host:org/webdav/") | |
12056 | @end smallexample | |
12057 | ||
12058 | If Emacs cannot access the WebDAV directory directly using a @file{tramp} | |
12059 | method, or you prefer to maintain a local copy, you can use a local directory | |
12060 | for staging. Other means must then be used to keep this directory in sync | |
12061 | with the WebDAV directory. In the following example, files are staged in | |
12062 | @file{~/stage}, and Org-mode hooks take care of moving files to and from the | |
12063 | WebDAV directory using @file{scp}. | |
12064 | ||
12065 | @smallexample | |
7006d207 CD |
12066 | (setq org-mobile-directory "~/stage/") |
12067 | (add-hook 'org-mobile-post-push-hook | |
a351880d | 12068 | (lambda () (shell-command "scp -r ~/stage/* user@@wdhost:mobile/"))) |
7006d207 | 12069 | (add-hook 'org-mobile-pre-pull-hook |
a351880d | 12070 | (lambda () (shell-command "scp user@@wdhost:mobile/mobileorg.org ~/stage/ "))) |
7006d207 | 12071 | (add-hook 'org-mobile-post-pull-hook |
a351880d CD |
12072 | (lambda () (shell-command "scp ~/stage/mobileorg.org user@@wdhost:mobile/"))) |
12073 | @end smallexample | |
7006d207 CD |
12074 | |
12075 | @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg | |
12076 | @section Pushing to MobileOrg | |
12077 | ||
12078 | This operation copies all files currently listed in @code{org-mobile-files} | |
12079 | to the directory @code{org-mobile-directory}. By default this list contains | |
12080 | all agenda files (as listed in @code{org-agenda-files}), but additional files | |
a351880d CD |
12081 | can be included by customizing @code{org-mobiles-files}. File names will be |
12082 | staged with path relative to @code{org-directory}, so all files should be | |
12083 | inside this directory. The push operation also creates (in the same | |
12084 | directory) a special Org file @file{agendas.org}. This file is an Org-mode | |
12085 | style outline, containing every custom agenda view defined by the user. | |
12086 | While creating the agendas, Org-mode will force@footnote{See the variable | |
12087 | @code{org-mobile-force-id-on-agenda-items}.} an ID property on all entries | |
12088 | referenced by the agendas, so that these entries can be uniquely identified | |
12089 | if @i{MobileOrg} flags them for further action. Finally, Org writes the file | |
12090 | @file{index.org}, containing links to all other files. If @i{MobileOrg} is | |
12091 | configured to request this file from the WebDAV server, all agendas and Org | |
12092 | files will be downloaded to the device. To speed up the download, MobileOrg | |
12093 | will only read files whose checksums@footnote{stored automatically in the | |
12094 | file @file{checksums.dat}} have changed. | |
7006d207 CD |
12095 | |
12096 | @node Pulling from MobileOrg, , Pushing to MobileOrg, MobileOrg | |
12097 | @section Pulling from MobileOrg | |
12098 | ||
12099 | When @i{MobileOrg} synchronizes with the WebDAV server, it not only pulls the | |
12100 | Org files for viewing. It also appends captured entries and pointers to | |
a351880d CD |
12101 | flagged and changed entries to the file @file{mobileorg.org} on the server. |
12102 | Org has a @emph{pull} operation that integrates this information into an | |
12103 | inbox file and operates on the pointers to flagged entries. Here is how it | |
12104 | works: | |
7006d207 CD |
12105 | |
12106 | @enumerate | |
12107 | @item | |
12108 | Org moves all entries found in | |
12109 | @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this | |
12110 | operation.} and appends them to the file pointed to by the variable | |
a351880d CD |
12111 | @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event |
12112 | will be a top-level entry in the inbox file. | |
12113 | @item | |
12114 | After moving the entries, Org will attempt to implement the changes made in | |
12115 | @i{MobileOrg}. Some changes are applied directly and without user | |
12116 | interaction. Examples are all changes to tags, TODO state, headline and body | |
12117 | text that can be cleanly applied. Entries that have been flagged for further | |
12118 | action will receive a tag @code{:FLAGGED:}, so that they can be easily found | |
12119 | again. When there is a problem finding an entry or applying the change, the | |
12120 | pointer entry will remain in the inbox and will be marked with an error | |
12121 | message. You need to later resolve these issues by hand. | |
7006d207 CD |
12122 | @item |
12123 | Org will then generate an agenda view with all flagged entries. The user | |
12124 | should then go through these entries and do whatever actions are necessary. | |
12125 | If a note has been stored while flagging an entry in @i{MobileOrg}, that note | |
12126 | will be displayed in the echo area when the cursor is on the corresponding | |
12127 | agenda line. | |
12128 | @table @kbd | |
12129 | @kindex ? | |
12130 | @item ? | |
12131 | Pressing @kbd{?} in that special agenda will display the full flagging note in | |
12132 | another window and also push it onto the kill ring. So you could use @kbd{? | |
12133 | z C-y C-c C-c} to store that flagging note as a normal note in the entry. | |
12134 | Pressing @kbd{?} twice in succession will offer to remove the | |
12135 | @code{:FLAGGED:} tag along with the recorded flagging note (which is stored | |
a351880d CD |
12136 | in a property). In this way you indicate, that the intended processing for |
12137 | this flagged entry is finished. | |
7006d207 CD |
12138 | @end table |
12139 | @end enumerate | |
12140 | ||
12141 | @kindex C-c a ? | |
12142 | If you are not able to process all flagged entries directly, you can always | |
12143 | return to this agenda view using @kbd{C-c a ?}. Note, however, that there is | |
12144 | a subtle difference. The view created automatically by @kbd{M-x | |
12145 | org-mobile-pull RET} is guaranteed to search all files that have been | |
12146 | addressed by the last pull. This might include a file that is not currently | |
12147 | in your list of agenda files. If you later use @kbd{C-c a ?} to regenerate | |
12148 | the view, only the current agenda files will be searched. | |
12149 | ||
12150 | @node History and Acknowledgments, Main Index, MobileOrg, Top | |
4009494e | 12151 | @appendix History and Acknowledgments |
a351880d | 12152 | @cindex acknowledgements |
4009494e GM |
12153 | @cindex history |
12154 | @cindex thanks | |
12155 | ||
c8d0cf5c | 12156 | Org was born in 2003, out of frustration over the user interface |
a7808fba | 12157 | of the Emacs Outline mode. I was trying to organize my notes and |
4009494e GM |
12158 | projects, and using Emacs seemed to be the natural way to go. However, |
12159 | having to remember eleven different commands with two or three keys per | |
a7808fba | 12160 | command, only to hide and show parts of the outline tree, that seemed |
4009494e | 12161 | entirely unacceptable to me. Also, when using outlines to take notes, I |
c8d0cf5c | 12162 | constantly wanted to restructure the tree, organizing it parallel to my |
4009494e GM |
12163 | thoughts and plans. @emph{Visibility cycling} and @emph{structure |
12164 | editing} were originally implemented in the package | |
12165 | @file{outline-magic.el}, but quickly moved to the more general | |
12166 | @file{org.el}. As this environment became comfortable for project | |
c8d0cf5c CD |
12167 | planning, the next step was adding @emph{TODO entries}, basic |
12168 | @emph{timestamps}, and @emph{table support}. These areas highlighted the two main | |
12169 | goals that Org still has today: to be a new, outline-based, | |
4009494e GM |
12170 | plain text mode with innovative and intuitive editing features, and to |
12171 | incorporate project planning functionality directly into a notes file. | |
12172 | ||
a50253cc | 12173 | A special thanks goes to @i{Bastien Guerry} who has not only written a large |
a7808fba | 12174 | number of extensions to Org (most of them integrated into the core by now), |
c8d0cf5c | 12175 | but who has also helped in the development and maintenance of Org so much that he |
7ddb1b5f | 12176 | should be considered the main co-contributor to this package. |
a7808fba | 12177 | |
c8d0cf5c CD |
12178 | Since the first release, literally thousands of emails to me or to |
12179 | @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug | |
4009494e GM |
12180 | reports, feedback, new ideas, and sometimes patches and add-on code. |
12181 | Many thanks to everyone who has helped to improve this package. I am | |
12182 | trying to keep here a list of the people who had significant influence | |
a7808fba | 12183 | in shaping one or more aspects of Org. The list may not be |
4009494e GM |
12184 | complete, if I have forgotten someone, please accept my apologies and |
12185 | let me know. | |
12186 | ||
12187 | @itemize @bullet | |
12188 | ||
12189 | @item | |
12190 | @i{Russel Adams} came up with the idea for drawers. | |
12191 | @item | |
a7808fba | 12192 | @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}. |
4009494e | 12193 | @item |
b349f79f CD |
12194 | @i{Christophe Bataillon} created the great unicorn logo that we use on the |
12195 | Org-mode website. | |
12196 | @item | |
c8d0cf5c CD |
12197 | @i{Alex Bochannek} provided a patch for rounding timestamps. |
12198 | @item | |
12199 | @i{Brad Bozarth} showed how to pull RSS feed data into Org-mode files. | |
12200 | @item | |
12201 | @i{Tom Breton} wrote @file{org-choose.el}. | |
4009494e GM |
12202 | @item |
12203 | @i{Charles Cave}'s suggestion sparked the implementation of templates | |
12204 | for Remember. | |
12205 | @item | |
12206 | @i{Pavel Chalmoviansky} influenced the agenda treatment of items with | |
12207 | specified time. | |
12208 | @item | |
c8d0cf5c | 12209 | @i{Gregory Chernov} patched support for Lisp forms into table |
4009494e GM |
12210 | calculations and improved XEmacs compatibility, in particular by porting |
12211 | @file{nouline.el} to XEmacs. | |
12212 | @item | |
c8d0cf5c CD |
12213 | @i{Sacha Chua} suggested copying some linking code from Planner. |
12214 | @item | |
12215 | @i{Baoqiu Cui} contributed the DocBook exporter. | |
4009494e | 12216 | @item |
a351880d CD |
12217 | @i{Dan Davison} wrote (together with @i{Eric Schulte}) Org Babel. |
12218 | @item | |
5fbc0f11 | 12219 | @i{Eddward DeVilla} proposed and tested checkbox statistics. He also |
4009494e GM |
12220 | came up with the idea of properties, and that there should be an API for |
12221 | them. | |
12222 | @item | |
c8d0cf5c CD |
12223 | @i{Nick Dokos} tracked down several nasty bugs. |
12224 | @item | |
4009494e GM |
12225 | @i{Kees Dullemond} used to edit projects lists directly in HTML and so |
12226 | inspired some of the early development, including HTML export. He also | |
12227 | asked for a way to narrow wide table columns. | |
12228 | @item | |
a7808fba | 12229 | @i{Christian Egli} converted the documentation into Texinfo format, |
4009494e GM |
12230 | patched CSS formatting into the HTML exporter, and inspired the agenda. |
12231 | @item | |
12232 | @i{David Emery} provided a patch for custom CSS support in exported | |
12233 | HTML agendas. | |
12234 | @item | |
12235 | @i{Nic Ferrier} contributed mailcap and XOXO support. | |
12236 | @item | |
28a16a1b CD |
12237 | @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes. |
12238 | @item | |
4009494e GM |
12239 | @i{John Foerch} figured out how to make incremental search show context |
12240 | around a match in a hidden outline tree. | |
12241 | @item | |
a351880d CD |
12242 | @i{Raimar Finken} wrote @file{org-git-line.el}. |
12243 | @item | |
12244 | @i{Mikael Fornius} works as a mailing list moderator. | |
12245 | @item | |
12246 | @i{Austin Frank} works as a mailing list moderator. | |
12247 | @item | |
dbc28aaa | 12248 | @i{Niels Giesen} had the idea to automatically archive DONE trees. |
4009494e | 12249 | @item |
a7808fba CD |
12250 | @i{Bastien Guerry} wrote the La@TeX{} exporter and @file{org-bibtex.el}, and |
12251 | has been prolific with patches, ideas, and bug reports. | |
4009494e GM |
12252 | @item |
12253 | @i{Kai Grossjohann} pointed out key-binding conflicts with other packages. | |
12254 | @item | |
a7808fba CD |
12255 | @i{Bernt Hansen} has driven much of the support for auto-repeating tasks, |
12256 | task state change logging, and the clocktable. His clear explanations have | |
c8d0cf5c | 12257 | been critical when we started to adopt the Git version control system. |
a7808fba | 12258 | @item |
c8d0cf5c | 12259 | @i{Manuel Hermenegildo} has contributed various ideas, small fixes and |
864c9740 CD |
12260 | patches. |
12261 | @item | |
a7808fba CD |
12262 | @i{Phil Jackson} wrote @file{org-irc.el}. |
12263 | @item | |
4009494e GM |
12264 | @i{Scott Jaderholm} proposed footnotes, control over whitespace between |
12265 | folded entries, and column view for properties. | |
12266 | @item | |
a7808fba CD |
12267 | @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}. |
12268 | @item | |
4009494e GM |
12269 | @i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also |
12270 | provided frequent feedback and some patches. | |
12271 | @item | |
55e0839d CD |
12272 | @i{Matt Lundin} has proposed last-row references for table formulas and named |
12273 | invisible anchors. He has also worked a lot on the FAQ. | |
12274 | @item | |
4009494e GM |
12275 | @i{Jason F. McBrayer} suggested agenda export to CSV format. |
12276 | @item | |
dbc28aaa CD |
12277 | @i{Max Mikhanosha} came up with the idea of refiling. |
12278 | @item | |
4009494e GM |
12279 | @i{Dmitri Minaev} sent a patch to set priority limits on a per-file |
12280 | basis. | |
12281 | @item | |
12282 | @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler | |
12283 | happy. | |
12284 | @item | |
7006d207 CD |
12285 | @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone. |
12286 | @item | |
c8d0cf5c CD |
12287 | @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file |
12288 | and being able to quickly restrict the agenda to a subtree. | |
4009494e | 12289 | @item |
c8d0cf5c CD |
12290 | @i{Todd Neal} provided patches for links to Info files and Elisp forms. |
12291 | @item | |
12292 | @i{Greg Newman} refreshed the unicorn logo into its current form. | |
4009494e GM |
12293 | @item |
12294 | @i{Tim O'Callaghan} suggested in-file links, search options for general | |
12295 | file links, and TAGS. | |
12296 | @item | |
12297 | @i{Takeshi Okano} translated the manual and David O'Toole's tutorial | |
12298 | into Japanese. | |
12299 | @item | |
12300 | @i{Oliver Oppitz} suggested multi-state TODO items. | |
12301 | @item | |
12302 | @i{Scott Otterson} sparked the introduction of descriptive text for | |
12303 | links, among other things. | |
12304 | @item | |
12305 | @i{Pete Phillips} helped during the development of the TAGS feature, and | |
12306 | provided frequent feedback. | |
12307 | @item | |
c8d0cf5c CD |
12308 | @i{Martin Pohlack} provided the code snippet to bundle character insertion |
12309 | into bundles of 20 for undo. | |
12310 | @item | |
4009494e GM |
12311 | @i{T.V. Raman} reported bugs and suggested improvements. |
12312 | @item | |
12313 | @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality | |
12314 | control. | |
12315 | @item | |
a351880d CD |
12316 | @i{Paul Rivier} provided the basic implementation of named footnotes. He |
12317 | also acted as mailing list moderator for some time. | |
55e0839d | 12318 | @item |
4009494e GM |
12319 | @i{Kevin Rogers} contributed code to access VM files on remote hosts. |
12320 | @item | |
a7808fba | 12321 | @i{Sebastian Rose} wrote @file{org-info.js}, a Java script for displaying |
c8d0cf5c CD |
12322 | webpages derived from Org using an Info-like or a folding interface with |
12323 | single-key navigation. | |
a7808fba | 12324 | @item |
4009494e GM |
12325 | @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a |
12326 | conflict with @file{allout.el}. | |
12327 | @item | |
c8d0cf5c | 12328 | @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with |
b349f79f | 12329 | extensive patches. |
4009494e | 12330 | @item |
b349f79f CD |
12331 | @i{Philip Rooke} created the Org reference card, provided lots |
12332 | of feedback, developed and applied standards to the Org documentation. | |
4009494e GM |
12333 | @item |
12334 | @i{Christian Schlauer} proposed angular brackets around links, among | |
12335 | other things. | |
12336 | @item | |
a351880d CD |
12337 | @i{Eric Schulte} wrote @file{org-plot.el} and (together with @i{Dan Davison}) |
12338 | Org Babel, and contributed various patches, small features and modules. | |
864c9740 | 12339 | @item |
b349f79f | 12340 | Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s |
4009494e GM |
12341 | @file{organizer-mode.el}. |
12342 | @item | |
55e0839d CD |
12343 | @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal |
12344 | examples, and remote highlighting for referenced code lines. | |
a7808fba | 12345 | @item |
64fb801f CD |
12346 | @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is |
12347 | now packaged into Org's @file{contrib} directory. | |
12348 | @item | |
4009494e GM |
12349 | @i{Daniel Sinder} came up with the idea of internal archiving by locking |
12350 | subtrees. | |
12351 | @item | |
12352 | @i{Dale Smith} proposed link abbreviations. | |
12353 | @item | |
864c9740 CD |
12354 | @i{James TD Smith} has contributed a large number of patches for useful |
12355 | tweaks and features. | |
12356 | @item | |
b349f79f CD |
12357 | @i{Adam Spiers} asked for global linking commands, inspired the link |
12358 | extension system, added support for mairix, and proposed the mapping API. | |
4009494e | 12359 | @item |
96c8522a CD |
12360 | @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content |
12361 | with links transformation to Org syntax. | |
12362 | @item | |
4009494e GM |
12363 | @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual |
12364 | chapter about publishing. | |
12365 | @item | |
12366 | @i{J@"urgen Vollmer} contributed code generating the table of contents | |
12367 | in HTML output. | |
12368 | @item | |
12369 | @i{Chris Wallace} provided a patch implementing the @samp{QUOTE} | |
12370 | keyword. | |
12371 | @item | |
12372 | @i{David Wainberg} suggested archiving, and improvements to the linking | |
12373 | system. | |
12374 | @item | |
b349f79f | 12375 | @i{John Wiegley} wrote @file{emacs-wiki.el}, @file{planner.el}, and |
7ddb1b5f CD |
12376 | @file{muse.el}, which have some overlap with Org. Initially the development |
12377 | of Org was fully independent because I was not aware of the existence of | |
12378 | these packages. But with time I have occasionally looked at John's code and | |
12379 | learned a lot from it. John has also contributed a number of great ideas and | |
12380 | patches directly to Org, including the attachment system | |
12381 | (@file{org-attach.el}), integration with Apple Mail | |
a351880d CD |
12382 | (@file{org-mac-message.el}), hierarchical dependencies of TODO items, habit |
12383 | tracking (@file{org-habits.el}) and support for pcomplete. | |
4009494e GM |
12384 | @item |
12385 | @i{Carsten Wimmer} suggested some changes and helped fix a bug in | |
a7808fba | 12386 | linking to Gnus. |
4009494e | 12387 | @item |
a7808fba | 12388 | @i{Roland Winkler} requested additional key bindings to make Org |
4009494e GM |
12389 | work on a tty. |
12390 | @item | |
12391 | @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks | |
12392 | and contributed various ideas and code snippets. | |
12393 | @end itemize | |
12394 | ||
12395 | ||
dbc28aaa | 12396 | @node Main Index, Key Index, History and Acknowledgments, Top |
c8d0cf5c | 12397 | @unnumbered Concept Index |
4009494e GM |
12398 | |
12399 | @printindex cp | |
12400 | ||
c8d0cf5c | 12401 | @node Key Index, Variable Index, Main Index, Top |
4009494e GM |
12402 | @unnumbered Key Index |
12403 | ||
12404 | @printindex ky | |
12405 | ||
c8d0cf5c CD |
12406 | @node Variable Index, , Key Index, Top |
12407 | @unnumbered Variable Index | |
12408 | ||
12409 | This is not a complete index of variables and faces, only the ones that are | |
12410 | mentioned in the manual. For a more complete list, use @kbd{M-x | |
a351880d | 12411 | org-customize @key{RET}} and then click yourself through the tree. |
c8d0cf5c CD |
12412 | |
12413 | @printindex vr | |
12414 | ||
4009494e GM |
12415 | @bye |
12416 | ||
12417 | @ignore | |
a7808fba | 12418 | arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac |
4009494e | 12419 | @end ignore |
a7808fba CD |
12420 | |
12421 | @c Local variables: | |
12422 | @c ispell-local-dictionary: "en_US-w_accents" | |
12423 | @c ispell-local-pdict: "./.aspell.org.pws" | |
12424 | @c fill-column: 77 | |
12425 | @c End: | |
44ce9197 | 12426 | |
7006d207 CD |
12427 | |
12428 | @c LocalWords: webdavhost pre |