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 | |
55e0839d CD |
6 | @set VERSION 6.19a |
7 | @set DATE January 2009 | |
4009494e GM |
8 | |
9 | @dircategory Emacs | |
10 | @direntry | |
11 | * Org Mode: (org). Outline-based notes management and organizer | |
12 | @end direntry | |
13 | ||
14 | @c Version and Contact Info | |
dbc28aaa | 15 | @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage} |
4009494e GM |
16 | @set AUTHOR Carsten Dominik |
17 | @set MAINTAINER Carsten Dominik | |
dbc28aaa CD |
18 | @set MAINTAINEREMAIL @email{carsten at orgmode dot org} |
19 | @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer} | |
4009494e GM |
20 | @c %**end of header |
21 | @finalout | |
22 | ||
23 | @c Macro definitions | |
24 | ||
25 | @c Subheadings inside a table. | |
26 | @macro tsubheading{text} | |
27 | @ifinfo | |
28 | @subsubheading \text\ | |
29 | @end ifinfo | |
30 | @ifnotinfo | |
31 | @item @b{\text\} | |
32 | @end ifnotinfo | |
33 | @end macro | |
34 | ||
35 | @copying | |
a7808fba | 36 | This manual is for Org (version @value{VERSION}). |
4009494e | 37 | |
6ed161e1 | 38 | Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation |
4009494e GM |
39 | |
40 | @quotation | |
41 | Permission is granted to copy, distribute and/or modify this document | |
d60b1ba1 | 42 | under the terms of the GNU Free Documentation License, Version 1.3 or |
4009494e GM |
43 | any later version published by the Free Software Foundation; with no |
44 | Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' | |
47271179 GM |
45 | and with the Back-Cover Texts as in (a) below. A copy of the license |
46 | is included in the section entitled ``GNU Free Documentation License.'' | |
4009494e | 47 | |
6f093307 GM |
48 | (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and |
49 | modify this GNU manual. Buying copies from the FSF supports it in | |
50 | developing GNU and promoting software freedom.'' | |
5b14aca9 GM |
51 | |
52 | This document is part of a collection distributed under the GNU Free | |
53 | Documentation License. If you want to distribute this document | |
54 | separately from the collection, you can do so by adding a copy of the | |
55 | license to the document, as described in section 6 of the license. | |
4009494e GM |
56 | @end quotation |
57 | @end copying | |
58 | ||
59 | @titlepage | |
a7808fba | 60 | @title The Org Manual |
4009494e GM |
61 | |
62 | @subtitle Release @value{VERSION} | |
63 | @author by Carsten Dominik | |
64 | ||
65 | @c The following two commands start the copyright page. | |
66 | @page | |
67 | @vskip 0pt plus 1filll | |
68 | @insertcopying | |
69 | @end titlepage | |
70 | ||
71 | @c Output the table of contents at the beginning. | |
72 | @contents | |
73 | ||
74 | @ifnottex | |
75 | @node Top, Introduction, (dir), (dir) | |
76 | @top Org Mode Manual | |
77 | ||
78 | @insertcopying | |
79 | @end ifnottex | |
80 | ||
81 | @menu | |
82 | * Introduction:: Getting started | |
a7808fba | 83 | * Document Structure:: A tree works like your brain |
4009494e GM |
84 | * Tables:: Pure magic for quick formatting |
85 | * Hyperlinks:: Notes in context | |
a7808fba | 86 | * TODO Items:: Every tree branch can be a TODO item |
4009494e | 87 | * Tags:: Tagging headlines and matching sets of tags |
a7808fba CD |
88 | * Properties and Columns:: Storing information about an entry |
89 | * Dates and Times:: Making items useful for planning | |
864c9740 | 90 | * Capture:: Creating tasks and attaching files |
a7808fba | 91 | * Agenda Views:: Collecting information into views |
4009494e GM |
92 | * Embedded LaTeX:: LaTeX fragments and formulas |
93 | * Exporting:: Sharing and publishing of notes | |
a7808fba | 94 | * Publishing:: Create a web site of linked Org files |
4009494e | 95 | * Miscellaneous:: All the rest which did not fit elsewhere |
44ce9197 | 96 | * Extensions:: Add-ons for Org mode |
a50253cc | 97 | * Hacking:: How to hack your way around |
a7808fba CD |
98 | * History and Acknowledgments:: How Org came into being |
99 | * Main Index:: An index of Org's concepts and features | |
4009494e GM |
100 | * Key Index:: Key bindings and where they are described |
101 | ||
102 | @detailmenu | |
103 | --- The Detailed Node Listing --- | |
104 | ||
105 | Introduction | |
106 | ||
a7808fba CD |
107 | * Summary:: Brief summary of what Org does |
108 | * Installation:: How to install a downloaded version of Org | |
109 | * Activation:: How to activate Org for certain buffers | |
4009494e | 110 | * Feedback:: Bug reports, ideas, patches etc. |
dbc28aaa | 111 | * Conventions:: Type-setting conventions in the manual |
4009494e GM |
112 | |
113 | Document Structure | |
114 | ||
a7808fba CD |
115 | * Outlines:: Org is based on Outline mode |
116 | * Headlines:: How to typeset Org tree headlines | |
4009494e GM |
117 | * Visibility cycling:: Show and hide, much simplified |
118 | * Motion:: Jumping to other headlines | |
119 | * Structure editing:: Changing sequence and level of headlines | |
120 | * Archiving:: Move done task trees to a different place | |
121 | * Sparse trees:: Matches embedded in context | |
122 | * Plain lists:: Additional structure within an entry | |
123 | * Drawers:: Tucking stuff away | |
55e0839d | 124 | * Footnotes:: How footnotes are defined in Org's syntax |
a7808fba | 125 | * Orgstruct mode:: Structure editing outside Org |
4009494e GM |
126 | |
127 | Archiving | |
128 | ||
129 | * ARCHIVE tag:: Marking a tree as inactive | |
130 | * Moving subtrees:: Moving a tree to an archive file | |
131 | ||
132 | Tables | |
133 | ||
134 | * Built-in table editor:: Simple tables | |
28a16a1b | 135 | * Narrow columns:: Stop wasting space in tables |
4009494e | 136 | * Column groups:: Grouping to trigger vertical lines |
a7808fba CD |
137 | * Orgtbl mode:: The table editor as minor mode |
138 | * The spreadsheet:: The table editor has spreadsheet capabilities | |
864c9740 | 139 | * Org Plot:: Plotting from org tables |
4009494e GM |
140 | |
141 | The spreadsheet | |
142 | ||
143 | * References:: How to refer to another field or range | |
144 | * Formula syntax for Calc:: Using Calc to compute stuff | |
145 | * Formula syntax for Lisp:: Writing formulas in Emacs Lisp | |
146 | * Field formulas:: Formulas valid for a single field | |
147 | * Column formulas:: Formulas valid for an entire column | |
148 | * Editing and debugging formulas:: Fixing formulas | |
149 | * Updating the table:: Recomputing all dependent fields | |
150 | * Advanced features:: Field names, parameters and automatic recalc | |
151 | ||
152 | Hyperlinks | |
153 | ||
a7808fba | 154 | * Link format:: How links in Org are formatted |
4009494e GM |
155 | * Internal links:: Links to other places in the current file |
156 | * External links:: URL-like links to the world | |
157 | * Handling links:: Creating, inserting and following | |
a7808fba | 158 | * Using links outside Org:: Linking from my C source code? |
4009494e GM |
159 | * Link abbreviations:: Shortcuts for writing complex links |
160 | * Search options:: Linking to a specific location | |
161 | * Custom searches:: When the default search is not enough | |
4009494e GM |
162 | |
163 | Internal links | |
164 | ||
a7808fba | 165 | * Radio targets:: Make targets trigger links in plain text |
4009494e | 166 | |
a7808fba | 167 | TODO Items |
4009494e GM |
168 | |
169 | * TODO basics:: Marking and displaying TODO entries | |
170 | * TODO extensions:: Workflow and assignments | |
dbc28aaa | 171 | * Progress logging:: Dates and notes for progress |
4009494e GM |
172 | * Priorities:: Some things are more important than others |
173 | * Breaking down tasks:: Splitting a task into manageable pieces | |
174 | * Checkboxes:: Tick-off lists | |
175 | ||
176 | Extended use of TODO keywords | |
177 | ||
178 | * Workflow states:: From TODO to DONE in steps | |
dbc28aaa | 179 | * TODO types:: I do this, Fred does the rest |
4009494e | 180 | * Multiple sets in one file:: Mixing it all, and still finding your way |
dbc28aaa CD |
181 | * Fast access to TODO states:: Single letter selection of a state |
182 | * Per-file keywords:: Different files, different requirements | |
183 | * Faces for TODO keywords:: Highlighting states | |
184 | ||
a7808fba | 185 | Progress logging |
dbc28aaa CD |
186 | |
187 | * Closing items:: When was this entry marked DONE? | |
188 | * Tracking TODO state changes:: When did the status change? | |
4009494e GM |
189 | |
190 | Tags | |
191 | ||
192 | * Tag inheritance:: Tags use the tree structure of the outline | |
193 | * Setting tags:: How to assign tags to a headline | |
194 | * Tag searches:: Searching for combinations of tags | |
195 | ||
196 | Properties and Columns | |
197 | ||
198 | * Property syntax:: How properties are spelled out | |
a7808fba | 199 | * Special properties:: Access to other Org mode features |
4009494e | 200 | * Property searches:: Matching property values |
dbc28aaa | 201 | * Property inheritance:: Passing values down the tree |
4009494e GM |
202 | * Column view:: Tabular viewing and editing |
203 | * Property API:: Properties for Lisp programmers | |
204 | ||
a7808fba | 205 | Column view |
4009494e GM |
206 | |
207 | * Defining columns:: The COLUMNS format property | |
208 | * Using column view:: How to create and use column view | |
a7808fba | 209 | * Capturing column view:: A dynamic block for column view |
4009494e | 210 | |
a7808fba | 211 | Defining columns |
4009494e GM |
212 | |
213 | * Scope of column definitions:: Where defined, where valid? | |
214 | * Column attributes:: Appearance and content of a column | |
215 | ||
dbc28aaa | 216 | Dates and Times |
4009494e | 217 | |
a7808fba | 218 | * Timestamps:: Assigning a time to a tree entry |
4009494e GM |
219 | * Creating timestamps:: Commands which insert timestamps |
220 | * Deadlines and scheduling:: Planning your work | |
a7808fba CD |
221 | * Clocking work time:: Tracking how long you spend on a task |
222 | * Effort estimates:: Planning work effort in advance | |
96c8522a | 223 | * Relative timer:: Notes with a running timer |
4009494e GM |
224 | |
225 | Creating timestamps | |
226 | ||
a7808fba CD |
227 | * The date/time prompt:: How Org mode helps you entering date and time |
228 | * Custom time format:: Making dates look different | |
4009494e | 229 | |
a7808fba | 230 | Deadlines and scheduling |
4009494e GM |
231 | |
232 | * Inserting deadline/schedule:: Planning items | |
233 | * Repeated tasks:: Items that show up again and again | |
234 | ||
864c9740 CD |
235 | Capture |
236 | ||
237 | * Remember:: Capture new tasks/ideas with little interruption | |
238 | * Attachments:: Add files to tasks. | |
239 | ||
dbc28aaa | 240 | Remember |
4009494e | 241 | |
a7808fba | 242 | * Setting up Remember:: Some code for .emacs to get things going |
dbc28aaa CD |
243 | * Remember templates:: Define the outline of different note types |
244 | * Storing notes:: Directly get the note to where it belongs | |
245 | * Refiling notes:: Moving a note or task to a project | |
4009494e GM |
246 | |
247 | Agenda Views | |
248 | ||
249 | * Agenda files:: Files being searched for agenda information | |
250 | * Agenda dispatcher:: Keyboard access to agenda views | |
251 | * Built-in agenda views:: What is available out of the box? | |
252 | * Presentation and sorting:: How agenda items are prepared for display | |
a7808fba | 253 | * Agenda commands:: Remote editing of Org trees |
4009494e | 254 | * Custom agenda views:: Defining special searches and views |
a7808fba | 255 | * Agenda column view:: Using column view for collected entries |
4009494e GM |
256 | |
257 | The built-in agenda views | |
258 | ||
a7808fba | 259 | * Weekly/daily agenda:: The calendar page with current tasks |
4009494e GM |
260 | * Global TODO list:: All unfinished action items |
261 | * Matching tags and properties:: Structured information with fine-tuned search | |
262 | * Timeline:: Time-sorted view for single file | |
28a16a1b | 263 | * Keyword search:: Finding entries by keyword |
4009494e GM |
264 | * Stuck projects:: Find projects you need to review |
265 | ||
266 | Presentation and sorting | |
267 | ||
268 | * Categories:: Not all tasks are equal | |
269 | * Time-of-day specifications:: How the agenda knows the time | |
270 | * Sorting of agenda items:: The order of things | |
271 | ||
272 | Custom agenda views | |
273 | ||
274 | * Storing searches:: Type once, use often | |
275 | * Block agenda:: All the stuff you need in a single buffer | |
276 | * Setting Options:: Changing the rules | |
a7808fba CD |
277 | * Exporting Agenda Views:: Writing agendas to files |
278 | * Using the agenda elsewhere:: Using agenda information in other programs | |
4009494e GM |
279 | |
280 | Embedded LaTeX | |
281 | ||
282 | * Math symbols:: TeX macros for symbols and Greek letters | |
a7808fba | 283 | * Subscripts and superscripts:: Simple syntax for raising/lowering text |
4009494e GM |
284 | * LaTeX fragments:: Complex formulas made easy |
285 | * Processing LaTeX fragments:: Previewing LaTeX processing | |
286 | * CDLaTeX mode:: Speed up entering of formulas | |
287 | ||
288 | Exporting | |
289 | ||
b349f79f | 290 | * Markup rules:: Which structures are recognized? |
864c9740 | 291 | * Selective export:: Using tags to select and exclude trees |
b349f79f CD |
292 | * Export options:: Per-file export settings |
293 | * The export dispatcher:: How to access exporter commands | |
4009494e GM |
294 | * ASCII export:: Exporting to plain ASCII |
295 | * HTML export:: Exporting to HTML | |
71d35b24 | 296 | * LaTeX and PDF export:: Exporting to LaTeX, and processing to PDF |
4009494e GM |
297 | * XOXO export:: Exporting to XOXO |
298 | * iCalendar export:: Exporting in iCalendar format | |
b349f79f CD |
299 | |
300 | Markup rules | |
301 | ||
302 | * Document title:: How the document title is determined | |
303 | * Headings and sections:: The main structure of the exported document | |
304 | * Table of contents:: If, where, how to create a table of contents | |
305 | * Initial text:: Text before the first headline | |
306 | * Lists:: Plain lists are exported | |
307 | * Paragraphs:: What determines beginning and ending | |
308 | * Literal examples:: Source code and other examples | |
309 | * Include files:: Include the contents of a file during export | |
310 | * Tables exported:: Tables are exported richly | |
67df9cfb | 311 | * Inlined images:: How to inline images during export |
55e0839d | 312 | * Footnote markup:: |
b349f79f CD |
313 | * Emphasis and monospace:: To bold or not to bold |
314 | * TeX macros and LaTeX fragments:: Create special, rich export. | |
315 | * Horizontal rules:: A line across the page | |
316 | * Comment lines:: Some lines will not be exported | |
4009494e GM |
317 | |
318 | HTML export | |
319 | ||
b349f79f | 320 | * HTML Export commands:: How to invoke HTML export |
a7808fba | 321 | * Quoting HTML tags:: Using direct HTML in Org mode |
4009494e | 322 | * Links:: Transformation of links for HTML |
55e0839d CD |
323 | * Images in HTML export:: How to insert figures into HTML output |
324 | * Text areas in HTML export:: An alternative way to show an example | |
a7808fba CD |
325 | * CSS support:: Changing the appearance of the output |
326 | * Javascript support:: Info and Folding in a web browser | |
4009494e | 327 | |
71d35b24 | 328 | LaTeX and PDF export |
4009494e | 329 | |
a50253cc | 330 | * LaTeX/PDF export commands:: Which key invokes which commands |
4009494e | 331 | * Quoting LaTeX code:: Incorporating literal LaTeX code |
a7808fba | 332 | * Sectioning structure:: Changing sectioning in LaTeX output |
67df9cfb CD |
333 | * Tables in LaTeX export:: Options for exporting tables to LaTeX |
334 | * Images in LaTeX export:: How to insert figures into LaTeX output | |
4009494e | 335 | |
4009494e GM |
336 | Publishing |
337 | ||
338 | * Configuration:: Defining projects | |
339 | * Sample configuration:: Example projects | |
340 | * Triggering publication:: Publication commands | |
341 | ||
342 | Configuration | |
343 | ||
344 | * Project alist:: The central configuration variable | |
345 | * Sources and destinations:: From here to there | |
346 | * Selecting files:: What files are part of the project? | |
347 | * Publishing action:: Setting the function doing the publishing | |
348 | * Publishing options:: Tweaking HTML export | |
349 | * Publishing links:: Which links keep working after publishing? | |
350 | * Project page index:: Publishing a list of project files | |
351 | ||
352 | Sample configuration | |
353 | ||
354 | * Simple example:: One-component publishing | |
355 | * Complex example:: A multi-component publishing example | |
356 | ||
357 | Miscellaneous | |
358 | ||
359 | * Completion:: M-TAB knows what you need | |
a7808fba | 360 | * Customization:: Adapting Org to your taste |
4009494e GM |
361 | * In-buffer settings:: Overview of the #+KEYWORDS |
362 | * The very busy C-c C-c key:: When in doubt, press C-c C-c | |
363 | * Clean view:: Getting rid of leading stars in the outline | |
a7808fba | 364 | * TTY keys:: Using Org on a tty |
4009494e GM |
365 | * Interaction:: Other Emacs packages |
366 | * Bugs:: Things which do not work perfectly | |
367 | ||
368 | Interaction with other packages | |
369 | ||
a7808fba | 370 | * Cooperation:: Packages Org cooperates with |
4009494e GM |
371 | * Conflicts:: Packages that lead to conflicts |
372 | ||
b349f79f CD |
373 | Extensions |
374 | ||
375 | * Extensions in the contrib directory:: These come with the Org distro | |
376 | * Other extensions:: These you have to find on the web. | |
377 | ||
378 | Hacking | |
4009494e | 379 | |
4009494e GM |
380 | * Adding hyperlink types:: New custom link types |
381 | * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs | |
382 | * Dynamic blocks:: Automatically filled blocks | |
383 | * Special agenda views:: Customized views | |
384 | * Using the property API:: Writing programs that use entry properties | |
b349f79f | 385 | * Using the mapping API:: Mapping over all or selected entries |
4009494e | 386 | |
a7808fba | 387 | Tables and lists in arbitrary syntax |
4009494e GM |
388 | |
389 | * Radio tables:: Sending and receiving | |
390 | * A LaTeX example:: Step by step, almost a tutorial | |
391 | * Translator functions:: Copy and modify | |
a7808fba | 392 | * Radio lists:: Doing the same for lists |
4009494e GM |
393 | |
394 | @end detailmenu | |
395 | @end menu | |
396 | ||
a7808fba | 397 | @node Introduction, Document Structure, Top, Top |
4009494e GM |
398 | @chapter Introduction |
399 | @cindex introduction | |
400 | ||
401 | @menu | |
a7808fba CD |
402 | * Summary:: Brief summary of what Org does |
403 | * Installation:: How to install a downloaded version of Org | |
404 | * Activation:: How to activate Org for certain buffers | |
4009494e | 405 | * Feedback:: Bug reports, ideas, patches etc. |
dbc28aaa | 406 | * Conventions:: Type-setting conventions in the manual |
4009494e GM |
407 | @end menu |
408 | ||
409 | @node Summary, Installation, Introduction, Introduction | |
410 | @section Summary | |
411 | @cindex summary | |
412 | ||
a7808fba | 413 | Org is a mode for keeping notes, maintaining TODO lists, and doing |
4009494e GM |
414 | project planning with a fast and effective plain-text system. |
415 | ||
a7808fba CD |
416 | Org develops organizational tasks around NOTES files that contain |
417 | lists or information about projects as plain text. Org is | |
418 | implemented on top of Outline mode, which makes it possible to keep the | |
4009494e GM |
419 | content of large files well structured. Visibility cycling and |
420 | structure editing help to work with the tree. Tables are easily created | |
a7808fba | 421 | with a built-in table editor. Org supports TODO items, deadlines, |
4009494e GM |
422 | time stamps, and scheduling. It dynamically compiles entries into an |
423 | agenda that utilizes and smoothly integrates much of the Emacs calendar | |
424 | and diary. Plain text URL-like links connect to websites, emails, | |
425 | Usenet messages, BBDB entries, and any files related to the projects. | |
a7808fba | 426 | For printing and sharing of notes, an Org file can be exported as a |
dbc28aaa | 427 | structured ASCII file, as HTML, or (TODO and agenda items only) as an |
4009494e | 428 | iCalendar file. It can also serve as a publishing tool for a set of |
a7808fba | 429 | linked web pages. |
4009494e | 430 | |
a7808fba | 431 | An important design aspect that distinguishes Org from for example |
4009494e GM |
432 | Planner/Muse is that it encourages to store every piece of information |
433 | only once. In Planner, you have project pages, day pages and possibly | |
a7808fba | 434 | other files, duplicating some information such as tasks. In Org, |
4009494e GM |
435 | you only have notes files. In your notes you mark entries as tasks, |
436 | label them with tags and timestamps. All necessary lists like a | |
437 | schedule for the day, the agenda for a meeting, tasks lists selected by | |
438 | tags etc are created dynamically when you need them. | |
439 | ||
a7808fba | 440 | Org keeps simple things simple. When first fired up, it should |
4009494e GM |
441 | feel like a straightforward, easy to use outliner. Complexity is not |
442 | imposed, but a large amount of functionality is available when you need | |
a7808fba | 443 | it. Org is a toolbox and can be used in different ways, for |
4009494e GM |
444 | example as: |
445 | ||
446 | @example | |
447 | @r{@bullet{} outline extension with visibility cycling and structure editing} | |
448 | @r{@bullet{} ASCII system and table editor for taking structured notes} | |
449 | @r{@bullet{} ASCII table editor with spreadsheet-like capabilities} | |
450 | @r{@bullet{} TODO list editor} | |
451 | @r{@bullet{} full agenda and planner with deadlines and work scheduling} | |
452 | @r{@bullet{} environment to implement David Allen's GTD system} | |
453 | @r{@bullet{} a basic database application} | |
dbc28aaa | 454 | @r{@bullet{} simple hypertext system, with HTML and LaTeX export} |
4009494e GM |
455 | @r{@bullet{} publishing tool to create a set of interlinked webpages} |
456 | @end example | |
457 | ||
a7808fba | 458 | Org's automatic, context sensitive table editor with spreadsheet |
4009494e | 459 | capabilities can be integrated into any major mode by activating the |
a7808fba | 460 | minor Orgtbl mode. Using a translation step, it can be used to maintain |
4009494e | 461 | tables in arbitrary file types, for example in La@TeX{}. The structure |
a7808fba CD |
462 | editing and list creation capabilities can be used outside Org with |
463 | the minor Orgstruct mode. | |
4009494e GM |
464 | |
465 | @cindex FAQ | |
a7808fba CD |
466 | There is a website for Org which provides links to the newest |
467 | version of Org, as well as additional information, frequently asked | |
4009494e | 468 | questions (FAQ), links to tutorials etc. This page is located at |
dbc28aaa | 469 | @uref{http://orgmode.org}. |
4009494e GM |
470 | |
471 | @page | |
472 | ||
473 | ||
474 | @node Installation, Activation, Summary, Introduction | |
475 | @section Installation | |
476 | @cindex installation | |
477 | @cindex XEmacs | |
478 | ||
a7808fba | 479 | @b{Important:} @i{If Org is part of the Emacs distribution or an |
4009494e GM |
480 | XEmacs package, please skip this section and go directly to |
481 | @ref{Activation}.} | |
482 | ||
a7808fba CD |
483 | If you have downloaded Org from the Web, either as a distribution @file{.zip} |
484 | or @file{.tar} file, or as a GIT archive, you must take the following steps | |
485 | to install it: Go into the unpacked Org distribution directory and edit the | |
486 | top section of the file @file{Makefile}. You must set the name of the Emacs | |
487 | binary (likely either @file{emacs} or @file{xemacs}), and the paths to the | |
488 | directories where local Lisp and Info files are kept. If you don't have | |
489 | access to the system-wide directories, you can simply run Org directly from | |
490 | the distribution directory by adding the @file{lisp} subdirectory to the | |
491 | Emacs load path. To do this, add the following line to @file{.emacs}: | |
4009494e GM |
492 | |
493 | @example | |
a7808fba CD |
494 | (setq load-path (cons "~/path/to/orgdir/lisp" load-path)) |
495 | @end example | |
496 | ||
497 | @noindent | |
498 | If you plan to use code from the @file{contrib} subdirectory, do a similar | |
499 | step for this directory: | |
500 | ||
501 | @example | |
502 | (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path)) | |
4009494e GM |
503 | @end example |
504 | ||
505 | @b{XEmacs users now need to install the file @file{noutline.el} from | |
a7808fba | 506 | the @file{xemacs} sub-directory of the Org distribution. Use the |
4009494e GM |
507 | command:} |
508 | ||
509 | @example | |
510 | @b{make install-noutline} | |
511 | @end example | |
512 | ||
a7808fba | 513 | @noindent Now byte-compile the Lisp files with the shell command: |
4009494e GM |
514 | |
515 | @example | |
516 | make | |
4009494e GM |
517 | @end example |
518 | ||
a7808fba CD |
519 | @noindent If you are running Org from the distribution directory, this is |
520 | all. If you want to install into the system directories, use | |
4009494e GM |
521 | |
522 | @example | |
a7808fba | 523 | make install |
4009494e GM |
524 | make install-info |
525 | @end example | |
526 | ||
527 | @noindent Then add to @file{.emacs}: | |
528 | ||
529 | @lisp | |
a7808fba | 530 | ;; This line only if Org is not part of the X/Emacs distribution. |
4009494e GM |
531 | (require 'org-install) |
532 | @end lisp | |
533 | ||
55e0839d | 534 | Do not forget to activate Org as described in the following section. |
a7808fba | 535 | |
4009494e GM |
536 | @node Activation, Feedback, Installation, Introduction |
537 | @section Activation | |
538 | @cindex activation | |
539 | @cindex autoload | |
a7808fba CD |
540 | @cindex global key bindings |
541 | @cindex key bindings, global | |
4009494e GM |
542 | |
543 | @iftex | |
544 | @b{Important:} @i{If you use copy-and-paste to copy lisp code from the | |
44ce9197 | 545 | PDF documentation as viewed by some PDF viewers to your .emacs file, the |
4009494e GM |
546 | single quote character comes out incorrectly and the code will not work. |
547 | You need to fix the single quotes by hand, or copy from Info | |
548 | documentation.} | |
549 | @end iftex | |
550 | ||
71d35b24 | 551 | Add the following lines to your @file{.emacs} file. The last three lines |
a7808fba CD |
552 | define @emph{global} keys for the commands @command{org-store-link}, |
553 | @command{org-agenda}, and @command{org-iswitchb} - please choose suitable | |
554 | keys yourself. | |
4009494e GM |
555 | |
556 | @lisp | |
557 | ;; The following lines are always needed. Choose your own keys. | |
558 | (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode)) | |
559 | (global-set-key "\C-cl" 'org-store-link) | |
560 | (global-set-key "\C-ca" 'org-agenda) | |
a7808fba | 561 | (global-set-key "\C-cb" 'org-iswitchb) |
4009494e GM |
562 | @end lisp |
563 | ||
a7808fba | 564 | Furthermore, you must activate @code{font-lock-mode} in Org |
4009494e GM |
565 | buffers, because significant functionality depends on font-locking being |
566 | active. You can do this with either one of the following two lines | |
567 | (XEmacs user must use the second option): | |
568 | @lisp | |
569 | (global-font-lock-mode 1) ; for all buffers | |
a7808fba | 570 | (add-hook 'org-mode-hook 'turn-on-font-lock) ; Org buffers only |
4009494e GM |
571 | @end lisp |
572 | ||
a7808fba | 573 | @cindex Org mode, turning on |
4009494e | 574 | With this setup, all files with extension @samp{.org} will be put |
a7808fba | 575 | into Org mode. As an alternative, make the first line of a file look |
4009494e GM |
576 | like this: |
577 | ||
578 | @example | |
579 | MY PROJECTS -*- mode: org; -*- | |
580 | @end example | |
581 | ||
a7808fba | 582 | @noindent which will select Org mode for this buffer no matter what |
4009494e GM |
583 | the file's name is. See also the variable |
584 | @code{org-insert-mode-line-in-empty-file}. | |
585 | ||
2096a1b6 | 586 | Many commands in Org work on the region if the region is active. To make use |
b6cb4cd5 CD |
587 | of this, you need to have @code{transient-mark-mode} (@code{zmacs-regions} in |
588 | XEmacs) turned on. In Emacs 23 this is the default, in Emacs 22 you need to | |
589 | do this yourself with | |
590 | ||
591 | @lisp | |
592 | (transient-mark-mode 1) | |
593 | @end lisp | |
594 | ||
dbc28aaa | 595 | @node Feedback, Conventions, Activation, Introduction |
4009494e GM |
596 | @section Feedback |
597 | @cindex feedback | |
598 | @cindex bug reports | |
599 | @cindex maintainer | |
600 | @cindex author | |
601 | ||
b349f79f CD |
602 | If you find problems with Org, or if you have questions, remarks, or ideas |
603 | about it, please mail to the Org mailing list @code{emacs-orgmode@@gnu.org}. | |
604 | If you are not a member of the mailing list, your mail will be reviewed by a | |
605 | moderator and then passed through to the list. | |
4009494e GM |
606 | |
607 | For bug reports, please provide as much information as possible, | |
608 | including the version information of Emacs (@kbd{C-h v emacs-version | |
a7808fba CD |
609 | @key{RET}}) and Org (@kbd{C-h v org-version @key{RET}}), as well as |
610 | the Org related setup in @file{.emacs}. If an error occurs, a | |
4009494e GM |
611 | backtrace can be very useful (see below on how to create one). Often a |
612 | small example file helps, along with clear information about: | |
613 | ||
614 | @enumerate | |
615 | @item What exactly did you do? | |
616 | @item What did you expect to happen? | |
617 | @item What happened instead? | |
618 | @end enumerate | |
619 | @noindent Thank you for helping to improve this mode. | |
620 | ||
621 | @subsubheading How to create a useful backtrace | |
622 | ||
623 | @cindex backtrace of an error | |
a7808fba | 624 | If working with Org produces an error with a message you don't |
4009494e GM |
625 | understand, you may have hit a bug. The best way to report this is by |
626 | providing, in addition to what was mentioned above, a @emph{Backtrace}. | |
627 | This is information from the built-in debugger about where and how the | |
628 | error occurred. Here is how to produce a useful backtrace: | |
629 | ||
630 | @enumerate | |
631 | @item | |
632 | Start a fresh Emacs or XEmacs, and make sure that it will load the | |
633 | original Lisp code in @file{org.el} instead of the compiled version in | |
634 | @file{org.elc}. The backtrace contains much more information if it is | |
635 | produced with uncompiled code. To do this, either rename @file{org.elc} | |
636 | to something else before starting Emacs, or ask Emacs explicitly to load | |
637 | @file{org.el} by using the command line | |
638 | @example | |
639 | emacs -l /path/to/org.el | |
640 | @end example | |
641 | @item | |
642 | Go to the @code{Options} menu and select @code{Enter Debugger on Error} | |
643 | (XEmacs has this option in the @code{Troubleshooting} sub-menu). | |
644 | @item | |
645 | Do whatever you have to do to hit the error. Don't forget to | |
646 | document the steps you take. | |
647 | @item | |
648 | When you hit the error, a @file{*Backtrace*} buffer will appear on the | |
649 | screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and | |
650 | attach it to your bug report. | |
651 | @end enumerate | |
652 | ||
dbc28aaa CD |
653 | @node Conventions, , Feedback, Introduction |
654 | @section Typesetting conventions used in this manual | |
655 | ||
a7808fba | 656 | Org uses three types of keywords: TODO keywords, tags, and property |
dbc28aaa CD |
657 | names. In this manual we use the following conventions: |
658 | ||
659 | @table @code | |
660 | @item TODO | |
661 | @itemx WAITING | |
662 | TODO keywords are written with all capitals, even if they are | |
663 | user-defined. | |
664 | @item boss | |
665 | @itemx ARCHIVE | |
666 | User-defined tags are written in lowercase; built-in tags with special | |
667 | meaning are written with all capitals. | |
668 | @item Release | |
669 | @itemx PRIORITY | |
670 | User-defined properties are capitalized; built-in properties with | |
671 | special meaning are written with all capitals. | |
672 | @end table | |
673 | ||
a7808fba | 674 | @node Document Structure, Tables, Introduction, Top |
4009494e GM |
675 | @chapter Document Structure |
676 | @cindex document structure | |
677 | @cindex structure of document | |
678 | ||
a7808fba | 679 | Org is based on outline mode and provides flexible commands to |
4009494e GM |
680 | edit the structure of the document. |
681 | ||
682 | @menu | |
a7808fba CD |
683 | * Outlines:: Org is based on Outline mode |
684 | * Headlines:: How to typeset Org tree headlines | |
4009494e GM |
685 | * Visibility cycling:: Show and hide, much simplified |
686 | * Motion:: Jumping to other headlines | |
687 | * Structure editing:: Changing sequence and level of headlines | |
688 | * Archiving:: Move done task trees to a different place | |
689 | * Sparse trees:: Matches embedded in context | |
690 | * Plain lists:: Additional structure within an entry | |
691 | * Drawers:: Tucking stuff away | |
55e0839d | 692 | * Footnotes:: How footnotes are defined in Org's syntax |
a7808fba | 693 | * Orgstruct mode:: Structure editing outside Org |
4009494e GM |
694 | @end menu |
695 | ||
a7808fba | 696 | @node Outlines, Headlines, Document Structure, Document Structure |
4009494e GM |
697 | @section Outlines |
698 | @cindex outlines | |
a7808fba | 699 | @cindex Outline mode |
4009494e | 700 | |
a7808fba | 701 | Org is implemented on top of Outline mode. Outlines allow a |
4009494e GM |
702 | document to be organized in a hierarchical structure, which (at least |
703 | for me) is the best representation of notes and thoughts. An overview | |
704 | of this structure is achieved by folding (hiding) large parts of the | |
705 | document to show only the general document structure and the parts | |
a7808fba | 706 | currently being worked on. Org greatly simplifies the use of |
4009494e GM |
707 | outlines by compressing the entire show/hide functionality into a single |
708 | command @command{org-cycle}, which is bound to the @key{TAB} key. | |
709 | ||
a7808fba | 710 | @node Headlines, Visibility cycling, Outlines, Document Structure |
4009494e GM |
711 | @section Headlines |
712 | @cindex headlines | |
713 | @cindex outline tree | |
714 | ||
715 | Headlines define the structure of an outline tree. The headlines in | |
a7808fba | 716 | Org start with one or more stars, on the left margin@footnote{See |
4009494e GM |
717 | the variable @code{org-special-ctrl-a/e} to configure special behavior |
718 | of @kbd{C-a} and @kbd{C-e} in headlines.}. For example: | |
719 | ||
720 | @example | |
721 | * Top level headline | |
722 | ** Second level | |
723 | *** 3rd level | |
724 | some text | |
725 | *** 3rd level | |
726 | more text | |
727 | ||
728 | * Another top level headline | |
729 | @end example | |
730 | ||
731 | @noindent Some people find the many stars too noisy and would prefer an | |
732 | outline that has whitespace followed by a single star as headline | |
733 | starters. @ref{Clean view} describes a setup to realize this. | |
734 | ||
735 | An empty line after the end of a subtree is considered part of it and | |
736 | will be hidden when the subtree is folded. However, if you leave at | |
737 | least two empty lines, one empty line will remain visible after folding | |
738 | the subtree, in order to structure the collapsed view. See the | |
739 | variable @code{org-cycle-separator-lines} to modify this behavior. | |
740 | ||
a7808fba | 741 | @node Visibility cycling, Motion, Headlines, Document Structure |
4009494e GM |
742 | @section Visibility cycling |
743 | @cindex cycling, visibility | |
744 | @cindex visibility cycling | |
745 | @cindex trees, visibility | |
746 | @cindex show hidden text | |
747 | @cindex hide text | |
748 | ||
749 | Outlines make it possible to hide parts of the text in the buffer. | |
a7808fba | 750 | Org uses just two commands, bound to @key{TAB} and |
4009494e GM |
751 | @kbd{S-@key{TAB}} to change the visibility in the buffer. |
752 | ||
753 | @cindex subtree visibility states | |
754 | @cindex subtree cycling | |
755 | @cindex folded, subtree visibility state | |
756 | @cindex children, subtree visibility state | |
757 | @cindex subtree, subtree visibility state | |
758 | @table @kbd | |
759 | @kindex @key{TAB} | |
760 | @item @key{TAB} | |
761 | @emph{Subtree cycling}: Rotate current subtree among the states | |
762 | ||
763 | @example | |
764 | ,-> FOLDED -> CHILDREN -> SUBTREE --. | |
765 | '-----------------------------------' | |
766 | @end example | |
767 | ||
768 | The cursor must be on a headline for this to work@footnote{see, however, | |
769 | the option @code{org-cycle-emulate-tab}.}. When the cursor is at the | |
770 | beginning of the buffer and the first line is not a headline, then | |
771 | @key{TAB} actually runs global cycling (see below)@footnote{see the | |
772 | option @code{org-cycle-global-at-bob}.}. Also when called with a prefix | |
773 | argument (@kbd{C-u @key{TAB}}), global cycling is invoked. | |
774 | ||
775 | @cindex global visibility states | |
776 | @cindex global cycling | |
777 | @cindex overview, global visibility state | |
778 | @cindex contents, global visibility state | |
779 | @cindex show all, global visibility state | |
780 | @kindex S-@key{TAB} | |
781 | @item S-@key{TAB} | |
782 | @itemx C-u @key{TAB} | |
783 | @emph{Global cycling}: Rotate the entire buffer among the states | |
784 | ||
785 | @example | |
786 | ,-> OVERVIEW -> CONTENTS -> SHOW ALL --. | |
787 | '--------------------------------------' | |
788 | @end example | |
789 | ||
a7808fba CD |
790 | When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the |
791 | CONTENTS view up to headlines of level N will be shown. Note that inside | |
792 | tables, @kbd{S-@key{TAB}} jumps to the previous field. | |
4009494e GM |
793 | |
794 | @cindex show all, command | |
864c9740 CD |
795 | @kindex C-u C-u C-u @key{TAB} |
796 | @item C-u C-u C-u @key{TAB} | |
797 | Show all, including drawers. | |
4009494e GM |
798 | @kindex C-c C-r |
799 | @item C-c C-r | |
a7808fba CD |
800 | Reveal context around point, showing the current entry, the following heading |
801 | and the hierarchy above. Useful for working near a location that has been | |
802 | exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command | |
803 | (@pxref{Agenda commands}). With a prefix argument show, on each | |
4009494e GM |
804 | level, all sibling headings. |
805 | @kindex C-c C-x b | |
806 | @item C-c C-x b | |
807 | Show the current subtree in an indirect buffer@footnote{The indirect | |
808 | buffer | |
809 | @ifinfo | |
810 | (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual}) | |
811 | @end ifinfo | |
812 | @ifnotinfo | |
813 | (see the Emacs manual for more information about indirect buffers) | |
814 | @end ifnotinfo | |
815 | will contain the entire buffer, but will be narrowed to the current | |
816 | tree. Editing the indirect buffer will also change the original buffer, | |
a7808fba CD |
817 | but without affecting visibility in that buffer.}. With a numeric |
818 | prefix argument N, go up to level N and then take that tree. If N is | |
819 | negative then go up that many levels. With a @kbd{C-u} prefix, do not remove | |
4009494e GM |
820 | the previously used indirect buffer. |
821 | @end table | |
822 | ||
a7808fba | 823 | When Emacs first visits an Org file, the global state is set to |
4009494e GM |
824 | OVERVIEW, i.e. only the top level headlines are visible. This can be |
825 | configured through the variable @code{org-startup-folded}, or on a | |
826 | per-file basis by adding one of the following lines anywhere in the | |
827 | buffer: | |
828 | ||
829 | @example | |
830 | #+STARTUP: overview | |
831 | #+STARTUP: content | |
832 | #+STARTUP: showall | |
833 | @end example | |
834 | ||
b349f79f | 835 | @noindent |
a50253cc | 836 | Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties |
b349f79f CD |
837 | and Columns}) will get their visibility adapted accordingly. Allowed values |
838 | for this property are @code{folded}, @code{children}, @code{content}, and | |
839 | @code{all}. | |
840 | @table @kbd | |
841 | @kindex C-u C-u @key{TAB} | |
842 | @item C-u C-u @key{TAB} | |
843 | Switch back to the startup visibility of the buffer, i.e. whatever is | |
844 | requested by startup options and @samp{VISIBILITY} properties in individual | |
845 | entries. | |
846 | @end table | |
847 | ||
a7808fba | 848 | @node Motion, Structure editing, Visibility cycling, Document Structure |
4009494e GM |
849 | @section Motion |
850 | @cindex motion, between headlines | |
851 | @cindex jumping, to headlines | |
852 | @cindex headline navigation | |
853 | The following commands jump to other headlines in the buffer. | |
854 | ||
855 | @table @kbd | |
856 | @kindex C-c C-n | |
857 | @item C-c C-n | |
858 | Next heading. | |
859 | @kindex C-c C-p | |
860 | @item C-c C-p | |
861 | Previous heading. | |
862 | @kindex C-c C-f | |
863 | @item C-c C-f | |
864 | Next heading same level. | |
865 | @kindex C-c C-b | |
866 | @item C-c C-b | |
867 | Previous heading same level. | |
868 | @kindex C-c C-u | |
869 | @item C-c C-u | |
870 | Backward to higher level heading. | |
871 | @kindex C-c C-j | |
872 | @item C-c C-j | |
873 | Jump to a different place without changing the current outline | |
874 | visibility. Shows the document structure in a temporary buffer, where | |
875 | you can use the following keys to find your destination: | |
876 | @example | |
877 | @key{TAB} @r{Cycle visibility.} | |
878 | @key{down} / @key{up} @r{Next/previous visible headline.} | |
71d35b24 CD |
879 | @key{RET} @r{Select this location.} |
880 | @kbd{/} @r{Do a Sparse-tree search} | |
881 | @r{The following keys work if you turn off @code{org-goto-auto-isearch}} | |
4009494e GM |
882 | n / p @r{Next/previous visible headline.} |
883 | f / b @r{Next/previous headline same level.} | |
884 | u @r{One level up.} | |
885 | 0-9 @r{Digit argument.} | |
71d35b24 | 886 | q @r{Quit} |
4009494e | 887 | @end example |
d60b1ba1 | 888 | See also the variable@code{org-goto-interface}. |
4009494e GM |
889 | @end table |
890 | ||
a7808fba | 891 | @node Structure editing, Archiving, Motion, Document Structure |
4009494e GM |
892 | @section Structure editing |
893 | @cindex structure editing | |
894 | @cindex headline, promotion and demotion | |
895 | @cindex promotion, of subtrees | |
896 | @cindex demotion, of subtrees | |
897 | @cindex subtree, cut and paste | |
898 | @cindex pasting, of subtrees | |
899 | @cindex cutting, of subtrees | |
900 | @cindex copying, of subtrees | |
901 | @cindex subtrees, cut and paste | |
902 | ||
903 | @table @kbd | |
904 | @kindex M-@key{RET} | |
905 | @item M-@key{RET} | |
906 | Insert new heading with same level as current. If the cursor is in a | |
907 | plain list item, a new item is created (@pxref{Plain lists}). To force | |
a7808fba | 908 | creation of a new headline, use a prefix argument, or first press @key{RET} |
4009494e GM |
909 | to get to the beginning of the next line. When this command is used in |
910 | the middle of a line, the line is split and the rest of the line becomes | |
28a16a1b CD |
911 | the new headline@footnote{If you do not want the line to be split, |
912 | customize the variable @code{org-M-RET-may-split-line}.}. If the | |
913 | command is used at the beginning of a headline, the new headline is | |
914 | created before the current line. If at the beginning of any other line, | |
915 | the content of that line is made the new heading. If the command is | |
916 | used at the end of a folded subtree (i.e. behind the ellipses at the end | |
917 | of a headline), then a headline like the current one will be inserted | |
918 | after the end of the subtree. | |
dbc28aaa CD |
919 | @kindex C-@key{RET} |
920 | @item C-@key{RET} | |
71d35b24 CD |
921 | Just like @kbd{M-@key{RET}}, except when adding a new heading below the |
922 | current heading, the new heading is placed after the body instead of before | |
923 | it. This command works from anywhere in the entry. | |
4009494e GM |
924 | @kindex M-S-@key{RET} |
925 | @item M-S-@key{RET} | |
926 | Insert new TODO entry with same level as current heading. | |
864c9740 CD |
927 | @kindex C-S-@key{RET} |
928 | @item C-S-@key{RET} | |
929 | Insert new TODO entry with same level as current heading. Like | |
930 | @kbd{C-@key{RET}}, the new headline will be inserted after the current | |
931 | subtree. | |
4009494e GM |
932 | @kindex M-@key{left} |
933 | @item M-@key{left} | |
934 | Promote current heading by one level. | |
935 | @kindex M-@key{right} | |
936 | @item M-@key{right} | |
937 | Demote current heading by one level. | |
938 | @kindex M-S-@key{left} | |
939 | @item M-S-@key{left} | |
940 | Promote the current subtree by one level. | |
941 | @kindex M-S-@key{right} | |
942 | @item M-S-@key{right} | |
943 | Demote the current subtree by one level. | |
944 | @kindex M-S-@key{up} | |
945 | @item M-S-@key{up} | |
946 | Move subtree up (swap with previous subtree of same | |
947 | level). | |
948 | @kindex M-S-@key{down} | |
949 | @item M-S-@key{down} | |
950 | Move subtree down (swap with next subtree of same level). | |
951 | @kindex C-c C-x C-w | |
4009494e | 952 | @item C-c C-x C-w |
4009494e | 953 | Kill subtree, i.e. remove it from buffer but save in kill ring. |
a7808fba | 954 | With a numeric prefix argument N, kill N sequential subtrees. |
4009494e GM |
955 | @kindex C-c C-x M-w |
956 | @item C-c C-x M-w | |
a7808fba CD |
957 | Copy subtree to kill ring. With a numeric prefix argument N, copy the N |
958 | sequential subtrees. | |
4009494e GM |
959 | @kindex C-c C-x C-y |
960 | @item C-c C-x C-y | |
961 | Yank subtree from kill ring. This does modify the level of the subtree to | |
a7808fba CD |
962 | make sure the tree fits in nicely at the yank position. The yank level can |
963 | also be specified with a numeric prefix argument, or by yanking after a | |
4009494e | 964 | headline marker like @samp{****}. |
96c8522a | 965 | @kindex C-y |
e45e3595 CD |
966 | @item C-y |
967 | Depending on the variables @code{org-yank-adjusted-subtrees} and | |
968 | @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will | |
969 | paste subtrees folded and in a clever way, using the same command as @kbd{C-c | |
970 | C-x C-y}. With the default settings, level adjustment will take place and | |
971 | yanked trees will be folded unless doing so would swallow text previously | |
972 | visible. Any prefix argument to this command will force a normal @code{yank} | |
973 | to be executed, with the prefix passed along. A good way to force a normal | |
64fb801f CD |
974 | yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a yank, it will yank |
975 | previous kill items plainly, without adjustment and folding. | |
dbc28aaa CD |
976 | @kindex C-c C-w |
977 | @item C-c C-w | |
e45e3595 | 978 | Refile entry or region to a different location. @xref{Refiling notes}. |
4009494e GM |
979 | @kindex C-c ^ |
980 | @item C-c ^ | |
a7808fba CD |
981 | Sort same-level entries. When there is an active region, all entries in the |
982 | region will be sorted. Otherwise the children of the current headline are | |
983 | sorted. The command prompts for the sorting method, which can be | |
984 | alphabetically, numerically, by time (using the first time stamp in each | |
985 | entry), by priority, or by TODO keyword (in the sequence the keywords have | |
986 | been defined in the setup). Reverse sorting is possible as well. You can | |
987 | also supply your own function to extract the sorting key. With a @kbd{C-u} | |
988 | prefix, sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes, | |
989 | duplicate entries will also be removed. | |
b349f79f CD |
990 | @kindex C-x n s |
991 | @item C-x n s | |
992 | Narrow buffer to current subtree. | |
993 | @kindex C-x n w | |
994 | @item C-x n w | |
995 | Widen buffer to remove a narrowing. | |
28a16a1b CD |
996 | @kindex C-c * |
997 | @item C-c * | |
55e0839d CD |
998 | Turn a normal line or plain list item into a headline (so that it becomes a |
999 | subheading at its location). Also turn a headline into a normal line by | |
1000 | removing the stars. If there is an active region, turn all lines in the | |
1001 | region into headlines. If the first line in the region was an item, turn | |
1002 | only the item lines into headlines. Finally, if the first line is a | |
28a16a1b | 1003 | headline, remove the stars from all headlines in the region. |
4009494e GM |
1004 | @end table |
1005 | ||
1006 | @cindex region, active | |
1007 | @cindex active region | |
a7808fba CD |
1008 | @cindex Transient mark mode |
1009 | When there is an active region (Transient mark mode), promotion and | |
4009494e GM |
1010 | demotion work on all headlines in the region. To select a region of |
1011 | headlines, it is best to place both point and mark at the beginning of a | |
1012 | line, mark at the beginning of the first headline, and point at the line | |
1013 | just after the last headline to change. Note that when the cursor is | |
1014 | inside a table (@pxref{Tables}), the Meta-Cursor keys have different | |
1015 | functionality. | |
1016 | ||
a7808fba | 1017 | @node Archiving, Sparse trees, Structure editing, Document Structure |
4009494e GM |
1018 | @section Archiving |
1019 | @cindex archiving | |
1020 | ||
1021 | When a project represented by a (sub)tree is finished, you may want | |
1022 | to move the tree out of the way and to stop it from contributing to the | |
a7808fba | 1023 | agenda. Org mode knows two ways of archiving. You can mark a tree with |
4009494e GM |
1024 | the ARCHIVE tag, or you can move an entire (sub)tree to a different |
1025 | location. | |
1026 | ||
1027 | @menu | |
1028 | * ARCHIVE tag:: Marking a tree as inactive | |
1029 | * Moving subtrees:: Moving a tree to an archive file | |
1030 | @end menu | |
1031 | ||
1032 | @node ARCHIVE tag, Moving subtrees, Archiving, Archiving | |
1033 | @subsection The ARCHIVE tag | |
1034 | @cindex internal archiving | |
1035 | ||
1036 | A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at | |
1037 | its location in the outline tree, but behaves in the following way: | |
1038 | @itemize @minus | |
1039 | @item | |
1040 | It does not open when you attempt to do so with a visibility cycling | |
1041 | command (@pxref{Visibility cycling}). You can force cycling archived | |
1042 | subtrees with @kbd{C-@key{TAB}}, or by setting the option | |
1043 | @code{org-cycle-open-archived-trees}. Also normal outline commands like | |
1044 | @code{show-all} will open archived subtrees. | |
1045 | @item | |
1046 | During sparse tree construction (@pxref{Sparse trees}), matches in | |
1047 | archived subtrees are not exposed, unless you configure the option | |
1048 | @code{org-sparse-tree-open-archived-trees}. | |
1049 | @item | |
a7808fba | 1050 | During agenda view construction (@pxref{Agenda Views}), the content of |
4009494e | 1051 | archived trees is ignored unless you configure the option |
44ce9197 CD |
1052 | @code{org-agenda-skip-archived-trees}, in which case these trees will always |
1053 | be included. In the agenda you can press the @kbd{v} key to get archives | |
1054 | temporarily included. | |
4009494e GM |
1055 | @item |
1056 | Archived trees are not exported (@pxref{Exporting}), only the headline | |
1057 | is. Configure the details using the variable | |
1058 | @code{org-export-with-archived-trees}. | |
1059 | @end itemize | |
1060 | ||
1061 | The following commands help managing the ARCHIVE tag: | |
1062 | ||
1063 | @table @kbd | |
a7808fba CD |
1064 | @kindex C-c C-x a |
1065 | @item C-c C-x a | |
4009494e | 1066 | Toggle the ARCHIVE tag for the current headline. When the tag is set, |
a7808fba | 1067 | the headline changes to a shadowed face, and the subtree below it is |
4009494e | 1068 | hidden. |
a7808fba CD |
1069 | @kindex C-u C-c C-x a |
1070 | @item C-u C-c C-x a | |
4009494e GM |
1071 | Check if any direct children of the current headline should be archived. |
1072 | To do this, each subtree is checked for open TODO entries. If none are | |
1073 | found, the command offers to set the ARCHIVE tag for the child. If the | |
1074 | cursor is @emph{not} on a headline when this command is invoked, the | |
1075 | level 1 trees will be checked. | |
1076 | @kindex C-@kbd{TAB} | |
1077 | @item C-@kbd{TAB} | |
1078 | Cycle a tree even if it is tagged with ARCHIVE. | |
1079 | @end table | |
1080 | ||
1081 | @node Moving subtrees, , ARCHIVE tag, Archiving | |
1082 | @subsection Moving subtrees | |
1083 | @cindex external archiving | |
1084 | ||
a7808fba | 1085 | Once an entire project is finished, you may want to move it to a different |
44ce9197 | 1086 | location. Org can move it to an @emph{Archive Sibling} in the same tree, to a |
a7808fba | 1087 | different tree in the current file, or to a different file, the archive file. |
4009494e GM |
1088 | |
1089 | @table @kbd | |
a7808fba CD |
1090 | @kindex C-c C-x A |
1091 | @item C-c C-x A | |
44ce9197 CD |
1092 | Move the current entry to the @emph{Archive Sibling}. This is a sibling of |
1093 | the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE} | |
a7808fba CD |
1094 | (@pxref{ARCHIVE tag}). The entry becomes a child of that sibling and in this |
1095 | way retains a lot of its original context, including inherited tags and | |
1096 | approximate position in the outline. | |
4009494e GM |
1097 | @kindex C-c C-x C-s |
1098 | @item C-c C-x C-s | |
1099 | Archive the subtree starting at the cursor position to the location | |
1100 | given by @code{org-archive-location}. Context information that could be | |
a7808fba | 1101 | lost like the file name, the category, inherited tags, and the TODO |
4009494e GM |
1102 | state will be store as properties in the entry. |
1103 | @kindex C-u C-c C-x C-s | |
1104 | @item C-u C-c C-x C-s | |
1105 | Check if any direct children of the current headline could be moved to | |
1106 | the archive. To do this, each subtree is checked for open TODO entries. | |
1107 | If none are found, the command offers to move it to the archive | |
1108 | location. If the cursor is @emph{not} on a headline when this command | |
1109 | is invoked, the level 1 trees will be checked. | |
1110 | @end table | |
1111 | ||
1112 | @cindex archive locations | |
1113 | The default archive location is a file in the same directory as the | |
1114 | current file, with the name derived by appending @file{_archive} to the | |
1115 | current file name. For information and examples on how to change this, | |
1116 | see the documentation string of the variable | |
1117 | @code{org-archive-location}. There is also an in-buffer option for | |
dbc28aaa CD |
1118 | setting this variable, for example@footnote{For backward compatibility, |
1119 | the following also works: If there are several such lines in a file, | |
1120 | each specifies the archive location for the text below it. The first | |
1121 | such line also applies to any text before its definition. However, | |
1122 | using this method is @emph{strongly} deprecated as it is incompatible | |
1123 | with the outline structure of the document. The correct method for | |
55e0839d | 1124 | setting multiple archive locations in a buffer is using properties.}: |
4009494e GM |
1125 | |
1126 | @example | |
1127 | #+ARCHIVE: %s_done:: | |
1128 | @end example | |
1129 | ||
1130 | @noindent | |
dbc28aaa CD |
1131 | If you would like to have a special ARCHIVE location for a single entry |
1132 | or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the | |
a7808fba | 1133 | location as the value (@pxref{Properties and Columns}). |
4009494e | 1134 | |
28a16a1b CD |
1135 | When a subtree is moved, it receives a number of special properties that |
1136 | record context information like the file from where the entry came, it's | |
1137 | outline path the archiving time etc. Configure the variable | |
1138 | @code{org-archive-save-context-info} to adjust the amount of information | |
1139 | added. | |
1140 | ||
a7808fba | 1141 | @node Sparse trees, Plain lists, Archiving, Document Structure |
4009494e GM |
1142 | @section Sparse trees |
1143 | @cindex sparse trees | |
1144 | @cindex trees, sparse | |
1145 | @cindex folding, sparse trees | |
1146 | @cindex occur, command | |
1147 | ||
b349f79f CD |
1148 | An important feature of Org mode is the ability to construct @emph{sparse |
1149 | trees} for selected information in an outline tree, so that the entire | |
1150 | document is folded as much as possible, but the selected information is made | |
1151 | visible along with the headline structure above it@footnote{See also the | |
1152 | variables @code{org-show-hierarchy-above}, @code{org-show-following-heading}, | |
1153 | @code{org-show-siblings}, and @code{org-show-entry-below} for detailed | |
1154 | control on how much context is shown around each match.}. Just try it out | |
1155 | and you will see immediately how it works. | |
dbc28aaa | 1156 | |
a7808fba | 1157 | Org mode contains several commands creating such trees, all these |
dbc28aaa | 1158 | commands can be accessed through a dispatcher: |
4009494e GM |
1159 | |
1160 | @table @kbd | |
1161 | @kindex C-c / | |
1162 | @item C-c / | |
dbc28aaa CD |
1163 | This prompts for an extra key to select a sparse-tree creating command. |
1164 | @kindex C-c / r | |
1165 | @item C-c / r | |
b349f79f CD |
1166 | Occur. Prompts for a regexp and shows a sparse tree with all matches. If |
1167 | the match is in a headline, the headline is made visible. If the match is in | |
1168 | the body of an entry, headline and body are made visible. In order to | |
1169 | provide minimal context, also the full hierarchy of headlines above the match | |
1170 | is shown, as well as the headline following the match. Each match is also | |
1171 | highlighted; the highlights disappear when the buffer is changed by an | |
1172 | editing command@footnote{depending on the option | |
1173 | @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}. | |
1174 | When called with a @kbd{C-u} prefix argument, previous highlights are kept, | |
1175 | so several calls to this command can be stacked. | |
4009494e | 1176 | @end table |
dbc28aaa | 1177 | |
4009494e GM |
1178 | @noindent |
1179 | For frequently used sparse trees of specific search strings, you can | |
1180 | use the variable @code{org-agenda-custom-commands} to define fast | |
1181 | keyboard access to specific sparse trees. These commands will then be | |
1182 | accessible through the agenda dispatcher (@pxref{Agenda dispatcher}). | |
1183 | For example: | |
1184 | ||
1185 | @lisp | |
1186 | (setq org-agenda-custom-commands | |
1187 | '(("f" occur-tree "FIXME"))) | |
1188 | @end lisp | |
1189 | ||
1190 | @noindent will define the key @kbd{C-c a f} as a shortcut for creating | |
1191 | a sparse tree matching the string @samp{FIXME}. | |
1192 | ||
dbc28aaa CD |
1193 | The other sparse tree commands select headings based on TODO keywords, |
1194 | tags, or properties and will be discussed later in this manual. | |
4009494e GM |
1195 | |
1196 | @kindex C-c C-e v | |
1197 | @cindex printing sparse trees | |
1198 | @cindex visible text, printing | |
1199 | To print a sparse tree, you can use the Emacs command | |
1200 | @code{ps-print-buffer-with-faces} which does not print invisible parts | |
1201 | of the document @footnote{This does not work under XEmacs, because | |
1202 | XEmacs uses selective display for outlining, not text properties.}. | |
1203 | Or you can use the command @kbd{C-c C-e v} to export only the visible | |
1204 | part of the document and print the resulting file. | |
1205 | ||
a7808fba | 1206 | @node Plain lists, Drawers, Sparse trees, Document Structure |
4009494e GM |
1207 | @section Plain lists |
1208 | @cindex plain lists | |
1209 | @cindex lists, plain | |
1210 | @cindex lists, ordered | |
1211 | @cindex ordered lists | |
1212 | ||
1213 | Within an entry of the outline tree, hand-formatted lists can provide | |
1214 | additional structure. They also provide a way to create lists of | |
a7808fba | 1215 | checkboxes (@pxref{Checkboxes}). Org supports editing such lists, |
dbc28aaa | 1216 | and the HTML exporter (@pxref{Exporting}) parses and formats them. |
4009494e | 1217 | |
b349f79f CD |
1218 | Org knows ordered lists, unordered lists, and description lists. |
1219 | @itemize @bullet | |
1220 | @item | |
1221 | @emph{Unordered} list items start with @samp{-}, @samp{+}, or | |
1222 | @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or | |
1223 | they will be seen as top-level headlines. Also, when you are hiding leading | |
1224 | stars to get a clean outline view, plain list items starting with a star are | |
1225 | visually indistinguishable from true headlines. In short: even though | |
1226 | @samp{*} is supported, it may be better to not use it for plain list items.} | |
1227 | as bullets. | |
1228 | @item | |
1229 | @emph{Ordered} list items start with a numeral followed by either a period or | |
1230 | a right parenthesis, such as @samp{1.} or @samp{1)}. | |
1231 | @item | |
1232 | @emph{Description} list items are like unordered list items, but contain the | |
1233 | separator @samp{ :: } to separate the description @emph{term} from the | |
a50253cc | 1234 | description. |
b349f79f CD |
1235 | @end itemize |
1236 | ||
1237 | Items belonging to the same list must have the same indentation on the first | |
1238 | line. In particular, if an ordered list reaches number @samp{10.}, then the | |
1239 | 2--digit numbers must be written left-aligned with the other numbers in the | |
1240 | list. Indentation also determines the end of a list item. It ends before | |
1241 | the next line that is indented like the bullet/number, or less. Empty lines | |
1242 | are part of the previous item, so you can have several paragraphs in one | |
1243 | item. If you would like an empty line to terminate all currently open plain | |
1244 | lists, configure the variable @code{org-empty-line-terminates-plain-lists}. | |
1245 | Here is an example: | |
4009494e GM |
1246 | |
1247 | @example | |
1248 | @group | |
1249 | ** Lord of the Rings | |
1250 | My favorite scenes are (in this order) | |
1251 | 1. The attack of the Rohirrim | |
a50253cc | 1252 | 2. Eowyn's fight with the witch king |
4009494e GM |
1253 | + this was already my favorite scene in the book |
1254 | + I really like Miranda Otto. | |
1255 | 3. Peter Jackson being shot by Legolas | |
1256 | - on DVD only | |
1257 | He makes a really funny face when it happens. | |
a50253cc | 1258 | But in the end, no individual scenes matter but the film as a whole. |
b349f79f | 1259 | Important actors in this film are: |
a50253cc | 1260 | - @b{Elijah Wood} :: He plays Frodo |
ac20fddf | 1261 | - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember |
a50253cc | 1262 | him very well from his role as Mikey Walsh in the Goonies. |
4009494e GM |
1263 | @end group |
1264 | @end example | |
1265 | ||
a7808fba CD |
1266 | Org supports these lists by tuning filling and wrapping commands to |
1267 | deal with them correctly@footnote{Org only changes the filling | |
4009494e GM |
1268 | settings for Emacs. For XEmacs, you should use Kyle E. Jones' |
1269 | @file{filladapt.el}. To turn this on, put into @file{.emacs}: | |
b349f79f CD |
1270 | @code{(require 'filladapt)}}, and by exporting them properly |
1271 | (@pxref{Exporting}). | |
4009494e GM |
1272 | |
1273 | The following commands act on items when the cursor is in the first line | |
1274 | of an item (the line with the bullet or number). | |
1275 | ||
1276 | @table @kbd | |
1277 | @kindex @key{TAB} | |
1278 | @item @key{TAB} | |
1279 | Items can be folded just like headline levels if you set the variable | |
1280 | @code{org-cycle-include-plain-lists}. The level of an item is then | |
1281 | given by the indentation of the bullet/number. Items are always | |
1282 | subordinate to real headlines, however; the hierarchies remain | |
1283 | completely separated. | |
1284 | ||
1285 | If @code{org-cycle-include-plain-lists} has not been set, @key{TAB} | |
a7808fba | 1286 | fixes the indentation of the current line in a heuristic way. |
4009494e GM |
1287 | @kindex M-@key{RET} |
1288 | @item M-@key{RET} | |
a7808fba CD |
1289 | Insert new item at current level. With a prefix argument, force a new |
1290 | heading (@pxref{Structure editing}). If this command is used in the middle | |
1291 | of a line, the line is @emph{split} and the rest of the line becomes the new | |
1292 | item@footnote{If you do not want the line to be split, customize the variable | |
1293 | @code{org-M-RET-may-split-line}.}. If this command is executed in the | |
1294 | @emph{whitespace before a bullet or number}, the new item is created | |
1295 | @emph{before} the current item. If the command is executed in the white | |
1296 | space before the text that is part of an item but does not contain the | |
1297 | bullet, a bullet is added to the current line. | |
4009494e GM |
1298 | @kindex M-S-@key{RET} |
1299 | @item M-S-@key{RET} | |
1300 | Insert a new item with a checkbox (@pxref{Checkboxes}). | |
1301 | @kindex S-@key{up} | |
1302 | @kindex S-@key{down} | |
1303 | @item S-@key{up} | |
1304 | @itemx S-@key{down} | |
1305 | Jump to the previous/next item in the current list. | |
1306 | @kindex M-S-@key{up} | |
1307 | @kindex M-S-@key{down} | |
1308 | @item M-S-@key{up} | |
1309 | @itemx M-S-@key{down} | |
1310 | Move the item including subitems up/down (swap with previous/next item | |
1311 | of same indentation). If the list is ordered, renumbering is | |
1312 | automatic. | |
1313 | @kindex M-S-@key{left} | |
1314 | @kindex M-S-@key{right} | |
1315 | @item M-S-@key{left} | |
1316 | @itemx M-S-@key{right} | |
1317 | Decrease/increase the indentation of the item, including subitems. | |
1318 | Initially, the item tree is selected based on current indentation. | |
1319 | When these commands are executed several times in direct succession, | |
1320 | the initially selected region is used, even if the new indentation | |
1321 | would imply a different hierarchy. To use the new hierarchy, break | |
1322 | the command chain with a cursor motion or so. | |
1323 | @kindex C-c C-c | |
1324 | @item C-c C-c | |
1325 | If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the | |
dbc28aaa CD |
1326 | state of the checkbox. If not, this command makes sure that all the |
1327 | items on this list level use the same bullet. Furthermore, if this is | |
a7808fba | 1328 | an ordered list, make sure the numbering is OK. |
4009494e GM |
1329 | @kindex C-c - |
1330 | @item C-c - | |
a7808fba CD |
1331 | Cycle the entire list level through the different itemize/enumerate bullets |
1332 | (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}). With a numeric prefix | |
1333 | argument N, select the Nth bullet from this list. If there is an active | |
1334 | region when calling this, all lines will be converted to list items. If the | |
1335 | first line already was a list item, any item markers will be removed from the | |
1336 | list. Finally, even without an active region, a normal line will be | |
1337 | converted into a list item. | |
64fb801f CD |
1338 | @kindex S-@key{left} |
1339 | @kindex S-@key{right} | |
1340 | @item S-@key{left}/@key{right} | |
1341 | Also cycle bullet styles when in the first line of an item. | |
4009494e GM |
1342 | @end table |
1343 | ||
55e0839d | 1344 | @node Drawers, Footnotes, Plain lists, Document Structure |
4009494e GM |
1345 | @section Drawers |
1346 | @cindex drawers | |
1347 | @cindex visibility cycling, drawers | |
1348 | ||
1349 | Sometimes you want to keep information associated with an entry, but you | |
a7808fba | 1350 | normally don't want to see it. For this, Org mode has @emph{drawers}. |
dbc28aaa CD |
1351 | Drawers need to be configured with the variable |
1352 | @code{org-drawers}@footnote{You can define drawers on a per-file basis | |
1353 | with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers | |
4009494e GM |
1354 | look like this: |
1355 | ||
1356 | @example | |
1357 | ** This is a headline | |
1358 | Still outside the drawer | |
1359 | :DRAWERNAME: | |
1360 | This is inside the drawer. | |
1361 | :END: | |
1362 | After the drawer. | |
1363 | @end example | |
1364 | ||
1365 | Visibility cycling (@pxref{Visibility cycling}) on the headline will | |
1366 | hide and show the entry, but keep the drawer collapsed to a single line. | |
1367 | In order to look inside the drawer, you need to move the cursor to the | |
a7808fba | 1368 | drawer line and press @key{TAB} there. Org mode uses a drawer for |
b349f79f CD |
1369 | storing properties (@pxref{Properties and Columns}), and another one for |
1370 | storing clock times (@pxref{Clocking work time}). | |
4009494e | 1371 | |
55e0839d CD |
1372 | @node Footnotes, Orgstruct mode, Drawers, Document Structure |
1373 | @section Footnotes | |
1374 | @cindex footnotes | |
1375 | ||
1376 | Org-mode supports the creation of footnotes. In contrast to the | |
1377 | @file{footnote.el} package, Org-mode's footnotes are designed for work on a | |
1378 | larger document, not only for one-off documents like emails. The basic | |
1379 | syntax is similar to the one used by @file{footnote.el}, i.e. a footnote is | |
1380 | defined in a paragraph that is started by a footnote marker in square | |
1381 | brackets in column 0, no indentation allowed. If you need a paragraph break | |
1382 | inside a footnote, use the LaTeX idiom @samp{\par}. The footnote reference | |
1383 | is simply the marker in square brackets, inside text. For example: | |
1384 | ||
1385 | @example | |
1386 | The Org homepage[fn:1] now looks a lot better than it used to. | |
1387 | ... | |
1388 | [fn:1] The link is: http://orgmode.org | |
1389 | @end example | |
1390 | ||
1391 | Org-mode extends the number-based syntax to @emph{named} footnotes and | |
1392 | optional inline definition. Using plain numbers as markers (as | |
1393 | @file{footnote.el} does) is supported for backward compatibility, but not | |
1394 | encouraged because of possible conflicts with LaTeX snippets @pxref{Embedded | |
1395 | LaTeX}. Here are the valid references: | |
1396 | ||
1397 | @table @code | |
1398 | @item [1] | |
1399 | A plain numeric footnote marker. | |
1400 | @item [fn:name] | |
1401 | A named footnote reference, where @code{name} is a unique label word, or, for | |
1402 | simplicity of automatic creation, a number. | |
1403 | @item [fn:: This is the inline definition of this footnote] | |
1404 | A LaTeX-like anonymous footnote where the definition is given directly at the | |
1405 | reference point. | |
1406 | @item [fn:name: a definition] | |
1407 | An inline definition of a footnote, which also specifies a name for the note. | |
1408 | Since Org allows multiple references to the same note, you can then use use | |
1409 | @code{[fn:name]} to create additional references. | |
1410 | @end table | |
1411 | ||
1412 | Footnote labels can be created automatically, or you create names yourself. | |
1413 | This is handled by the variable @code{org-footnote-auto-label} and its | |
1414 | corresponding @code{#+STARTUP} keywords, see the docstring of that variable | |
1415 | for details. | |
1416 | ||
1417 | @noindent The following command handles footnotes: | |
1418 | ||
1419 | @table @kbd | |
1420 | @kindex C-c C-x f | |
1421 | @item C-c C-x f | |
1422 | The footnote action command. | |
1423 | ||
1424 | When the cursor is on a footnote reference, jump to the definition. When it | |
1425 | is at a definition, jump to the (first) reference. | |
1426 | ||
1427 | Otherwise, create a new footnote. Depending on the variable | |
1428 | @code{org-footnote-define-inline}@footnote{The corresponding in-buffer | |
1429 | setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the | |
1430 | definition will be placed right into the text as part of the reference, or | |
1431 | separately into the location determined by the variable | |
1432 | @code{org-footnote-section}. | |
1433 | ||
1434 | When this command is called with a prefix argument, a menu of additional | |
1435 | options is offered: | |
1436 | @example | |
1437 | s @r{Sort the footnote definitions by reference sequence. During editing,} | |
1438 | @r{Org makes no effort to sort footnote definitions into a particular} | |
1439 | @r{sequence. If you want them sorted, use this command, which will} | |
1440 | @r{also move entries according to @code{org-footnote-section}.} | |
1441 | n @r{Normalize the footnotes by collecting all definitions (including} | |
1442 | @r{inline definitions) into a special section, and then numbering them} | |
1443 | @r{in sequence. The references will then also be numbers. This is} | |
1444 | @r{meant to be the final step before finishing a document (e.g. sending} | |
1445 | @r{off an email). The exporters do this automatically, and so could} | |
1446 | @r{something like @code{message-send-hook}.} | |
1447 | d @r{Delete the footnote at point, and all definitions of and references} | |
1448 | @r{to it.} | |
1449 | @end example | |
1450 | @kindex C-c C-c | |
1451 | @item C-c C-c | |
1452 | If the cursor is on a footnote reference, jump to the definition. If it is a | |
1453 | the definition, jump back to the reference. When called at a footnote | |
1454 | location with a prefix argument, offer the same menu as @kbd{C-c C-x f}. | |
1455 | @kindex C-c C-o | |
1456 | @kindex mouse-1 | |
1457 | @kindex mouse-2 | |
1458 | @item C-c C-c @r{or} mouse-1/2 | |
1459 | Footnote labels are also links to the corresponding definition/reference, and | |
1460 | you can use the usual commands to follow these links. | |
1461 | @end table | |
1462 | ||
1463 | @node Orgstruct mode, , Footnotes, Document Structure | |
4009494e | 1464 | @section The Orgstruct minor mode |
a7808fba | 1465 | @cindex Orgstruct mode |
4009494e GM |
1466 | @cindex minor mode for structure editing |
1467 | ||
a7808fba | 1468 | If you like the intuitive way the Org mode structure editing and list |
4009494e | 1469 | formatting works, you might want to use these commands in other modes |
a7808fba | 1470 | like Text mode or Mail mode as well. The minor mode Orgstruct mode |
4009494e | 1471 | makes this possible. You can always toggle the mode with @kbd{M-x |
a7808fba | 1472 | orgstruct-mode}. To turn it on by default, for example in Mail mode, |
4009494e GM |
1473 | use |
1474 | ||
1475 | @lisp | |
1476 | (add-hook 'mail-mode-hook 'turn-on-orgstruct) | |
1477 | @end lisp | |
1478 | ||
1479 | When this mode is active and the cursor is on a line that looks to | |
a7808fba | 1480 | Org like a headline of the first line of a list item, most |
4009494e GM |
1481 | structure editing commands will work, even if the same keys normally |
1482 | have different functionality in the major mode you are using. If the | |
a7808fba | 1483 | cursor is not in one of those special lines, Orgstruct mode lurks |
4009494e GM |
1484 | silently in the shadow. |
1485 | ||
a7808fba | 1486 | @node Tables, Hyperlinks, Document Structure, Top |
4009494e GM |
1487 | @chapter Tables |
1488 | @cindex tables | |
1489 | @cindex editing tables | |
1490 | ||
a7808fba | 1491 | Org comes with a fast and intuitive table editor. Spreadsheet-like |
dbc28aaa | 1492 | calculations are supported in connection with the Emacs @file{calc} |
28a16a1b | 1493 | package |
dbc28aaa | 1494 | @ifinfo |
a7808fba | 1495 | (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}). |
dbc28aaa CD |
1496 | @end ifinfo |
1497 | @ifnotinfo | |
1498 | (see the Emacs Calculator manual for more information about the Emacs | |
1499 | calculator). | |
1500 | @end ifnotinfo | |
4009494e GM |
1501 | |
1502 | @menu | |
1503 | * Built-in table editor:: Simple tables | |
28a16a1b | 1504 | * Narrow columns:: Stop wasting space in tables |
4009494e | 1505 | * Column groups:: Grouping to trigger vertical lines |
a7808fba CD |
1506 | * Orgtbl mode:: The table editor as minor mode |
1507 | * The spreadsheet:: The table editor has spreadsheet capabilities | |
864c9740 | 1508 | * Org Plot:: Plotting from org tables |
4009494e GM |
1509 | @end menu |
1510 | ||
1511 | @node Built-in table editor, Narrow columns, Tables, Tables | |
1512 | @section The built-in table editor | |
1513 | @cindex table editor, built-in | |
1514 | ||
a7808fba | 1515 | Org makes it easy to format tables in plain ASCII. Any line with |
4009494e GM |
1516 | @samp{|} as the first non-whitespace character is considered part of a |
1517 | table. @samp{|} is also the column separator. A table might look like | |
1518 | this: | |
1519 | ||
1520 | @example | |
1521 | | Name | Phone | Age | | |
1522 | |-------+-------+-----| | |
1523 | | Peter | 1234 | 17 | | |
1524 | | Anna | 4321 | 25 | | |
1525 | @end example | |
1526 | ||
1527 | A table is re-aligned automatically each time you press @key{TAB} or | |
1528 | @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to | |
1529 | the next field (@key{RET} to the next row) and creates new table rows | |
1530 | at the end of the table or before horizontal lines. The indentation | |
1531 | of the table is set by the first line. Any line starting with | |
1532 | @samp{|-} is considered as a horizontal separator line and will be | |
1533 | expanded on the next re-align to span the whole table width. So, to | |
1534 | create the above table, you would only type | |
1535 | ||
1536 | @example | |
1537 | |Name|Phone|Age| | |
1538 | |- | |
1539 | @end example | |
1540 | ||
1541 | @noindent and then press @key{TAB} to align the table and start filling in | |
55e0839d CD |
1542 | fields. Even faster would be to type @code{|Name|Phone|Age} followed by |
1543 | @kbd{C-c @key{RET}}. | |
4009494e | 1544 | |
a7808fba | 1545 | When typing text into a field, Org treats @key{DEL}, |
4009494e GM |
1546 | @key{Backspace}, and all character keys in a special way, so that |
1547 | inserting and deleting avoids shifting other fields. Also, when | |
1548 | typing @emph{immediately after the cursor was moved into a new field | |
1549 | with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the | |
1550 | field is automatically made blank. If this behavior is too | |
1551 | unpredictable for you, configure the variables | |
1552 | @code{org-enable-table-editor} and @code{org-table-auto-blank-field}. | |
1553 | ||
1554 | @table @kbd | |
1555 | @tsubheading{Creation and conversion} | |
1556 | @kindex C-c | | |
1557 | @item C-c | | |
1558 | Convert the active region to table. If every line contains at least one | |
1559 | TAB character, the function assumes that the material is tab separated. | |
dbc28aaa | 1560 | If every line contains a comma, comma-separated values (CSV) are assumed. |
4009494e | 1561 | If not, lines are split at whitespace into fields. You can use a prefix |
dbc28aaa CD |
1562 | argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u |
1563 | C-u} forces TAB, and a numeric argument N indicates that at least N | |
a7808fba | 1564 | consecutive spaces, or alternatively a TAB will be the separator. |
28a16a1b | 1565 | @* |
a7808fba | 1566 | If there is no active region, this command creates an empty Org |
4009494e GM |
1567 | table. But it's easier just to start typing, like |
1568 | @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}. | |
1569 | ||
1570 | @tsubheading{Re-aligning and field motion} | |
1571 | @kindex C-c C-c | |
1572 | @item C-c C-c | |
1573 | Re-align the table without moving the cursor. | |
1574 | @c | |
1575 | @kindex @key{TAB} | |
1576 | @item @key{TAB} | |
1577 | Re-align the table, move to the next field. Creates a new row if | |
1578 | necessary. | |
1579 | @c | |
1580 | @kindex S-@key{TAB} | |
1581 | @item S-@key{TAB} | |
1582 | Re-align, move to previous field. | |
1583 | @c | |
1584 | @kindex @key{RET} | |
1585 | @item @key{RET} | |
1586 | Re-align the table and move down to next row. Creates a new row if | |
1587 | necessary. At the beginning or end of a line, @key{RET} still does | |
1588 | NEWLINE, so it can be used to split a table. | |
1589 | ||
1590 | @tsubheading{Column and row editing} | |
1591 | @kindex M-@key{left} | |
1592 | @kindex M-@key{right} | |
1593 | @item M-@key{left} | |
1594 | @itemx M-@key{right} | |
1595 | Move the current column left/right. | |
1596 | @c | |
1597 | @kindex M-S-@key{left} | |
1598 | @item M-S-@key{left} | |
1599 | Kill the current column. | |
1600 | @c | |
1601 | @kindex M-S-@key{right} | |
1602 | @item M-S-@key{right} | |
1603 | Insert a new column to the left of the cursor position. | |
1604 | @c | |
1605 | @kindex M-@key{up} | |
1606 | @kindex M-@key{down} | |
1607 | @item M-@key{up} | |
1608 | @itemx M-@key{down} | |
1609 | Move the current row up/down. | |
1610 | @c | |
1611 | @kindex M-S-@key{up} | |
1612 | @item M-S-@key{up} | |
1613 | Kill the current row or horizontal line. | |
1614 | @c | |
1615 | @kindex M-S-@key{down} | |
1616 | @item M-S-@key{down} | |
a7808fba CD |
1617 | Insert a new row above the current row. With a prefix argument, the line is |
1618 | created below the current one. | |
4009494e GM |
1619 | @c |
1620 | @kindex C-c - | |
1621 | @item C-c - | |
2096a1b6 | 1622 | Insert a horizontal line below current row. With a prefix argument, the line |
4009494e GM |
1623 | is created above the current line. |
1624 | @c | |
55e0839d CD |
1625 | @kindex C-c @key{RET} |
1626 | @item C-c @key{RET} | |
2096a1b6 | 1627 | Insert a horizontal line below current row, and move the cursor into the row |
55e0839d CD |
1628 | below that line. |
1629 | @c | |
4009494e GM |
1630 | @kindex C-c ^ |
1631 | @item C-c ^ | |
1632 | Sort the table lines in the region. The position of point indicates the | |
1633 | column to be used for sorting, and the range of lines is the range | |
1634 | between the nearest horizontal separator lines, or the entire table. If | |
1635 | point is before the first column, you will be prompted for the sorting | |
1636 | column. If there is an active region, the mark specifies the first line | |
1637 | and the sorting column, while point should be in the last line to be | |
1638 | included into the sorting. The command prompts for the sorting type | |
1639 | (alphabetically, numerically, or by time). When called with a prefix | |
1640 | argument, alphabetic sorting will be case-sensitive. | |
1641 | ||
1642 | @tsubheading{Regions} | |
1643 | @kindex C-c C-x M-w | |
1644 | @item C-c C-x M-w | |
1645 | Copy a rectangular region from a table to a special clipboard. Point | |
1646 | and mark determine edge fields of the rectangle. The process ignores | |
1647 | horizontal separator lines. | |
1648 | @c | |
1649 | @kindex C-c C-x C-w | |
1650 | @item C-c C-x C-w | |
1651 | Copy a rectangular region from a table to a special clipboard, and | |
1652 | blank all fields in the rectangle. So this is the ``cut'' operation. | |
1653 | @c | |
1654 | @kindex C-c C-x C-y | |
1655 | @item C-c C-x C-y | |
1656 | Paste a rectangular region into a table. | |
864c9740 | 1657 | The upper left corner ends up in the current field. All involved fields |
4009494e GM |
1658 | will be overwritten. If the rectangle does not fit into the present table, |
1659 | the table is enlarged as needed. The process ignores horizontal separator | |
1660 | lines. | |
1661 | @c | |
28a16a1b | 1662 | @kindex M-@key{RET} |
28a16a1b | 1663 | @itemx M-@kbd{RET} |
4009494e GM |
1664 | Wrap several fields in a column like a paragraph. If there is an active |
1665 | region, and both point and mark are in the same column, the text in the | |
a7808fba CD |
1666 | column is wrapped to minimum width for the given number of lines. A numeric |
1667 | prefix argument may be used to change the number of desired lines. If there | |
1668 | is no region, the current field is split at the cursor position and the text | |
1669 | fragment to the right of the cursor is prepended to the field one line | |
1670 | down. If there is no region, but you specify a prefix argument, the current | |
1671 | field is made blank, and the content is appended to the field above. | |
4009494e GM |
1672 | |
1673 | @tsubheading{Calculations} | |
1674 | @cindex formula, in tables | |
1675 | @cindex calculations, in tables | |
1676 | @cindex region, active | |
1677 | @cindex active region | |
a7808fba | 1678 | @cindex Transient mark mode |
4009494e GM |
1679 | @kindex C-c + |
1680 | @item C-c + | |
1681 | Sum the numbers in the current column, or in the rectangle defined by | |
1682 | the active region. The result is shown in the echo area and can | |
1683 | be inserted with @kbd{C-y}. | |
1684 | @c | |
1685 | @kindex S-@key{RET} | |
1686 | @item S-@key{RET} | |
864c9740 CD |
1687 | When current field is empty, copy from first non-empty field above. When not |
1688 | empty, copy current field down to next row and move cursor along with it. | |
1689 | Depending on the variable @code{org-table-copy-increment}, integer field | |
1690 | values will be incremented during copy. Integers that are too large will not | |
a50253cc | 1691 | be incremented. Also, a @code{0} prefix argument temporarily disables the |
864c9740 | 1692 | increment. This key is also used by CUA mode (@pxref{Cooperation}). |
4009494e GM |
1693 | |
1694 | @tsubheading{Miscellaneous} | |
1695 | @kindex C-c ` | |
1696 | @item C-c ` | |
1697 | Edit the current field in a separate window. This is useful for fields | |
1698 | that are not fully visible (@pxref{Narrow columns}). When called with a | |
1699 | @kbd{C-u} prefix, just make the full field visible, so that it can be | |
1700 | edited in place. | |
1701 | @c | |
4009494e GM |
1702 | @item M-x org-table-import |
1703 | Import a file as a table. The table should be TAB- or whitespace | |
dbc28aaa CD |
1704 | separated. Useful, for example, to import a spreadsheet table or data |
1705 | from a database, because these programs generally can write | |
1706 | TAB-separated text files. This command works by inserting the file into | |
1707 | the buffer and then converting the region to a table. Any prefix | |
1708 | argument is passed on to the converter, which uses it to determine the | |
1709 | separator. | |
4009494e | 1710 | @item C-c | |
a7808fba | 1711 | Tables can also be imported by pasting tabular text into the Org |
4009494e | 1712 | buffer, selecting the pasted text with @kbd{C-x C-x} and then using the |
44ce9197 | 1713 | @kbd{C-c |} command (see above under @i{Creation and conversion}). |
4009494e GM |
1714 | @c |
1715 | @item M-x org-table-export | |
a7808fba CD |
1716 | Export the table, by default as a TAB-separated file. Useful for data |
1717 | exchange with, for example, spreadsheet or database programs. The format | |
1718 | used to export the file can be configured in the variable | |
1719 | @code{org-table-export-default-format}. You may also use properties | |
1720 | @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file | |
b349f79f CD |
1721 | name and the format for table export in a subtree. Org supports quite |
1722 | general formats for exported tables. The exporter format is the same as the | |
1723 | format used by Orgtbl radio tables, see @ref{Translator functions} for a | |
1724 | detailed description. | |
4009494e GM |
1725 | @end table |
1726 | ||
1727 | If you don't like the automatic table editor because it gets in your | |
1728 | way on lines which you would like to start with @samp{|}, you can turn | |
1729 | it off with | |
1730 | ||
1731 | @lisp | |
1732 | (setq org-enable-table-editor nil) | |
1733 | @end lisp | |
1734 | ||
1735 | @noindent Then the only table command that still works is | |
1736 | @kbd{C-c C-c} to do a manual re-align. | |
1737 | ||
1738 | @node Narrow columns, Column groups, Built-in table editor, Tables | |
1739 | @section Narrow columns | |
1740 | @cindex narrow columns in tables | |
1741 | ||
1742 | The width of columns is automatically determined by the table editor. | |
1743 | Sometimes a single field or a few fields need to carry more text, | |
1744 | leading to inconveniently wide columns. To limit@footnote{This feature | |
1745 | does not work on XEmacs.} the width of a column, one field anywhere in | |
1746 | the column may contain just the string @samp{<N>} where @samp{N} is an | |
1747 | integer specifying the width of the column in characters. The next | |
1748 | re-align will then set the width of this column to no more than this | |
1749 | value. | |
1750 | ||
1751 | @example | |
1752 | @group | |
1753 | |---+------------------------------| |---+--------| | |
1754 | | | | | | <6> | | |
1755 | | 1 | one | | 1 | one | | |
1756 | | 2 | two | ----\ | 2 | two | | |
1757 | | 3 | This is a long chunk of text | ----/ | 3 | This=> | | |
1758 | | 4 | four | | 4 | four | | |
1759 | |---+------------------------------| |---+--------| | |
1760 | @end group | |
1761 | @end example | |
1762 | ||
1763 | @noindent | |
1764 | Fields that are wider become clipped and end in the string @samp{=>}. | |
1765 | Note that the full text is still in the buffer, it is only invisible. | |
1766 | To see the full text, hold the mouse over the field - a tool-tip window | |
1767 | will show the full content. To edit such a field, use the command | |
1768 | @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will | |
1769 | open a new window with the full field. Edit it and finish with @kbd{C-c | |
1770 | C-c}. | |
1771 | ||
1772 | When visiting a file containing a table with narrowed columns, the | |
1773 | necessary character hiding has not yet happened, and the table needs to | |
1774 | be aligned before it looks nice. Setting the option | |
1775 | @code{org-startup-align-all-tables} will realign all tables in a file | |
1776 | upon visiting, but also slow down startup. You can also set this option | |
1777 | on a per-file basis with: | |
1778 | ||
1779 | @example | |
1780 | #+STARTUP: align | |
1781 | #+STARTUP: noalign | |
1782 | @end example | |
1783 | ||
a7808fba | 1784 | @node Column groups, Orgtbl mode, Narrow columns, Tables |
4009494e GM |
1785 | @section Column groups |
1786 | @cindex grouping columns in tables | |
1787 | ||
a7808fba | 1788 | When Org exports tables, it does so by default without vertical |
4009494e GM |
1789 | lines because that is visually more satisfying in general. Occasionally |
1790 | however, vertical lines can be useful to structure a table into groups | |
1791 | of columns, much like horizontal lines can do for groups of rows. In | |
1792 | order to specify column groups, you can use a special row where the | |
1793 | first field contains only @samp{/}. The further fields can either | |
1794 | contain @samp{<} to indicate that this column should start a group, | |
1795 | @samp{>} to indicate the end of a column, or @samp{<>} to make a column | |
a7808fba | 1796 | a group of its own. Boundaries between column groups will upon export be |
4009494e GM |
1797 | marked with vertical lines. Here is an example: |
1798 | ||
1799 | @example | |
1800 | | | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) | | |
1801 | |---+----+-----+-----+-----+---------+------------| | |
1802 | | / | <> | < | | > | < | > | | |
1803 | | # | 1 | 1 | 1 | 1 | 1 | 1 | | |
1804 | | # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 | | |
1805 | | # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 | | |
1806 | |---+----+-----+-----+-----+---------+------------| | |
44ce9197 | 1807 | #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2))) |
4009494e GM |
1808 | @end example |
1809 | ||
a7808fba | 1810 | It is also sufficient to just insert the column group starters after |
4009494e GM |
1811 | every vertical line you'd like to have: |
1812 | ||
1813 | @example | |
1814 | | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) | | |
1815 | |----+-----+-----+-----+---------+------------| | |
1816 | | / | < | | | < | | | |
1817 | @end example | |
1818 | ||
a7808fba | 1819 | @node Orgtbl mode, The spreadsheet, Column groups, Tables |
4009494e | 1820 | @section The Orgtbl minor mode |
a7808fba | 1821 | @cindex Orgtbl mode |
4009494e GM |
1822 | @cindex minor mode for tables |
1823 | ||
a7808fba CD |
1824 | If you like the intuitive way the Org table editor works, you |
1825 | might also want to use it in other modes like Text mode or Mail mode. | |
1826 | The minor mode Orgtbl mode makes this possible. You can always toggle | |
4009494e GM |
1827 | the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for |
1828 | example in mail mode, use | |
1829 | ||
1830 | @lisp | |
1831 | (add-hook 'mail-mode-hook 'turn-on-orgtbl) | |
1832 | @end lisp | |
1833 | ||
1834 | Furthermore, with some special setup, it is possible to maintain tables | |
a7808fba | 1835 | in arbitrary syntax with Orgtbl mode. For example, it is possible to |
4009494e | 1836 | construct La@TeX{} tables with the underlying ease and power of |
a7808fba | 1837 | Orgtbl mode, including spreadsheet capabilities. For details, see |
4009494e GM |
1838 | @ref{Tables in arbitrary syntax}. |
1839 | ||
864c9740 | 1840 | @node The spreadsheet, Org Plot, Orgtbl mode, Tables |
4009494e GM |
1841 | @section The spreadsheet |
1842 | @cindex calculations, in tables | |
1843 | @cindex spreadsheet capabilities | |
1844 | @cindex @file{calc} package | |
1845 | ||
1846 | The table editor makes use of the Emacs @file{calc} package to implement | |
1847 | spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to | |
a7808fba | 1848 | derive fields from other fields. While fully featured, Org's |
4009494e | 1849 | implementation is not identical to other spreadsheets. For example, |
a7808fba | 1850 | Org knows the concept of a @emph{column formula} that will be |
4009494e GM |
1851 | applied to all non-header fields in a column without having to copy the |
1852 | formula to each relevant field. | |
1853 | ||
1854 | @menu | |
1855 | * References:: How to refer to another field or range | |
1856 | * Formula syntax for Calc:: Using Calc to compute stuff | |
1857 | * Formula syntax for Lisp:: Writing formulas in Emacs Lisp | |
1858 | * Field formulas:: Formulas valid for a single field | |
1859 | * Column formulas:: Formulas valid for an entire column | |
1860 | * Editing and debugging formulas:: Fixing formulas | |
1861 | * Updating the table:: Recomputing all dependent fields | |
1862 | * Advanced features:: Field names, parameters and automatic recalc | |
1863 | @end menu | |
1864 | ||
1865 | @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet | |
1866 | @subsection References | |
1867 | @cindex references | |
1868 | ||
1869 | To compute fields in the table from other fields, formulas must | |
a7808fba | 1870 | reference other fields or ranges. In Org, fields can be referenced |
4009494e GM |
1871 | by name, by absolute coordinates, and by relative coordinates. To find |
1872 | out what the coordinates of a field are, press @kbd{C-c ?} in that | |
1873 | field, or press @kbd{C-c @}} to toggle the display of a grid. | |
1874 | ||
1875 | @subsubheading Field references | |
1876 | @cindex field references | |
1877 | @cindex references, to fields | |
1878 | ||
1879 | Formulas can reference the value of another field in two ways. Like in | |
1880 | any other spreadsheet, you may reference fields with a letter/number | |
1881 | combination like @code{B3}, meaning the 2nd field in the 3rd row. | |
1882 | @c Such references are always fixed to that field, they don't change | |
1883 | @c when you copy and paste a formula to a different field. So | |
a7808fba | 1884 | @c Org's @code{B3} behaves like @code{$B$3} in other spreadsheets. |
4009494e GM |
1885 | |
1886 | @noindent | |
a7808fba | 1887 | Org also uses another, more general operator that looks like this: |
4009494e GM |
1888 | @example |
1889 | @@row$column | |
1890 | @end example | |
1891 | ||
1892 | @noindent | |
1893 | Column references can be absolute like @samp{1}, @samp{2},...@samp{N}, | |
73ef3bde | 1894 | or relative to the current column like @samp{+1} or @samp{-2}. |
4009494e GM |
1895 | |
1896 | The row specification only counts data lines and ignores horizontal | |
1897 | separator lines (hlines). You can use absolute row numbers | |
1898 | @samp{1}...@samp{N}, and row numbers relative to the current row like | |
1899 | @samp{+3} or @samp{-1}. Or specify the row relative to one of the | |
dbc28aaa CD |
1900 | hlines: @samp{I} refers to the first hline@footnote{Note that only |
1901 | hlines are counted that @emph{separate} table lines. If the table | |
1902 | starts with a hline above the header, it does not count.}, @samp{II} to | |
1903 | the second etc. @samp{-I} refers to the first such line above the | |
1904 | current line, @samp{+I} to the first such line below the current line. | |
1905 | You can also write @samp{III+2} which is the second data line after the | |
1906 | third hline in the table. Relative row numbers like @samp{-3} will not | |
1907 | cross hlines if the current line is too close to the hline. Instead, | |
1908 | the value directly at the hline is used. | |
4009494e GM |
1909 | |
1910 | @samp{0} refers to the current row and column. Also, if you omit | |
1911 | either the column or the row part of the reference, the current | |
28a16a1b | 1912 | row/column is implied. |
4009494e | 1913 | |
a7808fba | 1914 | Org's references with @emph{unsigned} numbers are fixed references |
4009494e GM |
1915 | in the sense that if you use the same reference in the formula for two |
1916 | different fields, the same field will be referenced each time. | |
a7808fba | 1917 | Org's references with @emph{signed} numbers are floating |
4009494e GM |
1918 | references because the same reference operator can reference different |
1919 | fields depending on the field being calculated by the formula. | |
1920 | ||
b6cb4cd5 | 1921 | As a special case references like @samp{$LR5} and @samp{$LR12} can be used to |
55e0839d CD |
1922 | refer in a stable way to the 5th and 12th field in the last row of the |
1923 | table. | |
b6cb4cd5 | 1924 | |
4009494e GM |
1925 | Here are a few examples: |
1926 | ||
1927 | @example | |
1928 | @@2$3 @r{2nd row, 3rd column} | |
1929 | C2 @r{same as previous} | |
1930 | $5 @r{column 5 in the current row} | |
1931 | E& @r{same as previous} | |
1932 | @@2 @r{current column, row 2} | |
1933 | @@-1$-3 @r{the field one row up, three columns to the left} | |
1934 | @@-I$2 @r{field just under hline above current row, column 2} | |
1935 | @end example | |
1936 | ||
1937 | @subsubheading Range references | |
1938 | @cindex range references | |
1939 | @cindex references, to ranges | |
1940 | ||
1941 | You may reference a rectangular range of fields by specifying two field | |
1942 | references connected by two dots @samp{..}. If both fields are in the | |
1943 | current row, you may simply use @samp{$2..$7}, but if at least one field | |
1944 | is in a different row, you need to use the general @code{@@row$column} | |
1945 | format at least for the first field (i.e the reference must start with | |
1946 | @samp{@@} in order to be interpreted correctly). Examples: | |
1947 | ||
1948 | @example | |
1949 | $1..$3 @r{First three fields in the current row.} | |
1950 | $P..$Q @r{Range, using column names (see under Advanced)} | |
1951 | @@2$1..@@4$3 @r{6 fields between these two fields.} | |
1952 | A2..C4 @r{Same as above.} | |
1953 | @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row} | |
1954 | @end example | |
1955 | ||
1956 | @noindent Range references return a vector of values that can be fed | |
1957 | into Calc vector functions. Empty fields in ranges are normally | |
1958 | suppressed, so that the vector contains only the non-empty fields (but | |
1959 | see the @samp{E} mode switch below). If there are no non-empty fields, | |
1960 | @samp{[0]} is returned to avoid syntax errors in formulas. | |
1961 | ||
1962 | @subsubheading Named references | |
1963 | @cindex named references | |
1964 | @cindex references, named | |
1965 | @cindex name, of column or field | |
1966 | @cindex constants, in calculations | |
1967 | ||
1968 | @samp{$name} is interpreted as the name of a column, parameter or | |
1969 | constant. Constants are defined globally through the variable | |
1970 | @code{org-table-formula-constants}, and locally (for the file) through a | |
1971 | line like | |
1972 | ||
1973 | @example | |
1974 | #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6 | |
1975 | @end example | |
1976 | ||
1977 | @noindent | |
a7808fba | 1978 | Also properties (@pxref{Properties and Columns}) can be used as |
dbc28aaa CD |
1979 | constants in table formulas: For a property @samp{:Xyz:} use the name |
1980 | @samp{$PROP_Xyz}, and the property will be searched in the current | |
4009494e GM |
1981 | outline entry and in the hierarchy above it. If you have the |
1982 | @file{constants.el} package, it will also be used to resolve constants, | |
1983 | including natural constants like @samp{$h} for Planck's constant, and | |
1984 | units like @samp{$km} for kilometers@footnote{@file{Constant.el} can | |
1985 | supply the values of constants in two different unit systems, @code{SI} | |
1986 | and @code{cgs}. Which one is used depends on the value of the variable | |
1987 | @code{constants-unit-system}. You can use the @code{#+STARTUP} options | |
1988 | @code{constSI} and @code{constcgs} to set this value for the current | |
1989 | buffer.}. Column names and parameters can be specified in special table | |
1990 | lines. These are described below, see @ref{Advanced features}. All | |
1991 | names must start with a letter, and further consist of letters and | |
1992 | numbers. | |
1993 | ||
55e0839d CD |
1994 | @subsubheading Remote references |
1995 | @cindex remote references | |
1996 | @cindex references, remote | |
1997 | @cindex references, to a different table | |
1998 | @cindex name, of column or field | |
1999 | @cindex constants, in calculations | |
2000 | ||
2001 | You may also reference constants, fields and ranges from a different table, | |
2002 | either in the current file or even in a different file. The syntax is | |
2003 | ||
2004 | @example | |
2005 | remote(NAME-OR-ID,REF) | |
2006 | @end example | |
2007 | ||
2008 | @noindent | |
2009 | where NAME can be the name of a table in the current file as set by a | |
2010 | @code{#+TBLNAME: NAME} line before the table. It can also be the ID of an | |
2011 | entry, even in a different file, and the reference then refers to the first | |
2012 | table in that entry. REF is an absolute field or range reference as | |
2013 | described above, valid in the referenced table. | |
2014 | ||
4009494e GM |
2015 | @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet |
2016 | @subsection Formula syntax for Calc | |
2017 | @cindex formula syntax, Calc | |
2018 | @cindex syntax, of formulas | |
2019 | ||
2020 | A formula can be any algebraic expression understood by the Emacs | |
2021 | @file{Calc} package. @b{Note that @file{calc} has the | |
2022 | non-standard convention that @samp{/} has lower precedence than | |
2023 | @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before | |
2024 | evaluation by @code{calc-eval} (@pxref{Calling Calc from | |
a7808fba | 2025 | Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU |
4009494e | 2026 | Emacs Calc Manual}), |
a7808fba | 2027 | @c FIXME: The link to the Calc manual in HTML does not work. |
4009494e GM |
2028 | variable substitution takes place according to the rules described above. |
2029 | @cindex vectors, in table calculations | |
a7808fba | 2030 | The range vectors can be directly fed into the Calc vector functions |
4009494e GM |
2031 | like @samp{vmean} and @samp{vsum}. |
2032 | ||
2033 | @cindex format specifier | |
2034 | @cindex mode, for @file{calc} | |
2035 | A formula can contain an optional mode string after a semicolon. This | |
2036 | string consists of flags to influence Calc and other modes during | |
a7808fba | 2037 | execution. By default, Org uses the standard Calc modes (precision |
44ce9197 | 2038 | 12, angular units degrees, fraction and symbolic modes off). The display |
4009494e GM |
2039 | format, however, has been changed to @code{(float 5)} to keep tables |
2040 | compact. The default settings can be configured using the variable | |
2041 | @code{org-calc-default-modes}. | |
2042 | ||
2043 | @example | |
2044 | p20 @r{switch the internal precision to 20 digits} | |
2045 | n3 s3 e2 f4 @r{normal, scientific, engineering, or fixed display format} | |
2046 | D R @r{angle modes: degrees, radians} | |
2047 | F S @r{fraction and symbolic modes} | |
2048 | N @r{interpret all fields as numbers, use 0 for non-numbers} | |
2049 | T @r{force text interpretation} | |
2050 | E @r{keep empty fields in ranges} | |
2051 | @end example | |
2052 | ||
2053 | @noindent | |
2054 | In addition, you may provide a @code{printf} format specifier to | |
2055 | reformat the final result. A few examples: | |
2056 | ||
2057 | @example | |
2058 | $1+$2 @r{Sum of first and second field} | |
2059 | $1+$2;%.2f @r{Same, format result to two decimals} | |
2060 | exp($2)+exp($1) @r{Math functions can be used} | |
2061 | $0;%.1f @r{Reformat current cell to 1 decimal} | |
2062 | ($3-32)*5/9 @r{Degrees F -> C conversion} | |
2063 | $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}} | |
2064 | tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1} | |
2065 | sin($1);Dp3%.1e @r{Same, but use printf specifier for display} | |
2066 | vmean($2..$7) @r{Compute column range mean, using vector function} | |
2067 | vmean($2..$7);EN @r{Same, but treat empty fields as 0} | |
2068 | taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree} | |
2069 | @end example | |
2070 | ||
2071 | Calc also contains a complete set of logical operations. For example | |
2072 | ||
2073 | @example | |
2074 | if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty} | |
2075 | @end example | |
2076 | ||
2077 | @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet | |
2078 | @subsection Emacs Lisp forms as formulas | |
2079 | @cindex Lisp forms, as table formulas | |
2080 | ||
2081 | It is also possible to write a formula in Emacs Lisp; this can be useful | |
a50253cc | 2082 | for string manipulation and control structures, if Calc's |
4009494e GM |
2083 | functionality is not enough. If a formula starts with a single quote |
2084 | followed by an opening parenthesis, then it is evaluated as a lisp form. | |
2085 | The evaluation should return either a string or a number. Just as with | |
2086 | @file{calc} formulas, you can specify modes and a printf format after a | |
a7808fba | 2087 | semicolon. With Emacs Lisp forms, you need to be conscious about the way |
4009494e GM |
2088 | field references are interpolated into the form. By default, a |
2089 | reference will be interpolated as a Lisp string (in double quotes) | |
2090 | containing the field. If you provide the @samp{N} mode switch, all | |
2091 | referenced elements will be numbers (non-number fields will be zero) and | |
2092 | interpolated as Lisp numbers, without quotes. If you provide the | |
2093 | @samp{L} flag, all fields will be interpolated literally, without quotes. | |
2094 | I.e., if you want a reference to be interpreted as a string by the Lisp | |
a7808fba | 2095 | form, enclose the reference operator itself in double quotes, like |
4009494e GM |
2096 | @code{"$3"}. Ranges are inserted as space-separated fields, so you can |
2097 | embed them in list or vector syntax. A few examples, note how the | |
2098 | @samp{N} mode is used when we do computations in lisp. | |
2099 | ||
2100 | @example | |
2101 | @r{Swap the first two characters of the content of column 1} | |
2102 | '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2)) | |
2096a1b6 | 2103 | @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}} |
4009494e GM |
2104 | '(+ $1 $2);N |
2105 | @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}} | |
2106 | '(apply '+ '($1..$4));N | |
2107 | @end example | |
2108 | ||
2109 | @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet | |
2110 | @subsection Field formulas | |
2111 | @cindex field formula | |
2112 | @cindex formula, for individual table field | |
2113 | ||
2114 | To assign a formula to a particular field, type it directly into the | |
2115 | field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you | |
2116 | press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in | |
2117 | the field, the formula will be stored as the formula for this field, | |
2118 | evaluated, and the current field replaced with the result. | |
2119 | ||
2120 | Formulas are stored in a special line starting with @samp{#+TBLFM:} | |
2121 | directly below the table. If you typed the equation in the 4th field of | |
2122 | the 3rd data line in the table, the formula will look like | |
2123 | @samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows | |
2124 | with the appropriate commands, @i{absolute references} (but not relative | |
2125 | ones) in stored formulas are modified in order to still reference the | |
2126 | same field. Of cause this is not true if you edit the table structure | |
2127 | with normal editing commands - then you must fix the equations yourself. | |
b6cb4cd5 CD |
2128 | The left hand side of a formula may also be a named field (@pxref{Advanced |
2129 | features}), or a last-row reference like @samp{$LR3}. | |
4009494e GM |
2130 | |
2131 | Instead of typing an equation into the field, you may also use the | |
2132 | following command | |
2133 | ||
2134 | @table @kbd | |
2135 | @kindex C-u C-c = | |
2136 | @item C-u C-c = | |
2137 | Install a new formula for the current field. The command prompts for a | |
2138 | formula, with default taken from the @samp{#+TBLFM:} line, applies | |
2139 | it to the current field and stores it. | |
2140 | @end table | |
2141 | ||
2142 | @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet | |
2143 | @subsection Column formulas | |
2144 | @cindex column formula | |
2145 | @cindex formula, for table column | |
2146 | ||
2147 | Often in a table, the same formula should be used for all fields in a | |
2148 | particular column. Instead of having to copy the formula to all fields | |
a7808fba | 2149 | in that column, Org allows to assign a single formula to an entire |
4009494e GM |
2150 | column. If the table contains horizontal separator hlines, everything |
2151 | before the first such line is considered part of the table @emph{header} | |
2152 | and will not be modified by column formulas. | |
2153 | ||
2154 | To assign a formula to a column, type it directly into any field in the | |
2155 | column, preceded by an equal sign, like @samp{=$1+$2}. When you press | |
2156 | @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the | |
2157 | field, the formula will be stored as the formula for the current column, | |
2158 | evaluated and the current field replaced with the result. If the field | |
2159 | contains only @samp{=}, the previously stored formula for this column is | |
a7808fba | 2160 | used. For each column, Org will only remember the most recently |
4009494e GM |
2161 | used formula. In the @samp{TBLFM:} line, column formulas will look like |
2162 | @samp{$4=$1+$2}. | |
2163 | ||
2164 | Instead of typing an equation into the field, you may also use the | |
2165 | following command: | |
2166 | ||
2167 | @table @kbd | |
2168 | @kindex C-c = | |
2169 | @item C-c = | |
a7808fba CD |
2170 | Install a new formula for the current column and replace current field with |
2171 | the result of the formula. The command prompts for a formula, with default | |
2172 | taken from the @samp{#+TBLFM} line, applies it to the current field and | |
2173 | stores it. With a numeric prefix argument(e.g. @kbd{C-5 C-c =}) the command | |
4009494e GM |
2174 | will apply it to that many consecutive fields in the current column. |
2175 | @end table | |
2176 | ||
4009494e | 2177 | @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet |
a7808fba | 2178 | @subsection Editing and debugging formulas |
4009494e GM |
2179 | @cindex formula editing |
2180 | @cindex editing, of table formulas | |
2181 | ||
2182 | You can edit individual formulas in the minibuffer or directly in the | |
a7808fba CD |
2183 | field. Org can also prepare a special buffer with all active |
2184 | formulas of a table. When offering a formula for editing, Org | |
4009494e GM |
2185 | converts references to the standard format (like @code{B3} or @code{D&}) |
2186 | if possible. If you prefer to only work with the internal format (like | |
2187 | @code{@@3$2} or @code{$4}), configure the variable | |
2188 | @code{org-table-use-standard-references}. | |
2189 | ||
2190 | @table @kbd | |
2191 | @kindex C-c = | |
2192 | @kindex C-u C-c = | |
2193 | @item C-c = | |
2194 | @itemx C-u C-c = | |
2195 | Edit the formula associated with the current column/field in the | |
2196 | minibuffer. See @ref{Column formulas} and @ref{Field formulas}. | |
2197 | @kindex C-u C-u C-c = | |
2198 | @item C-u C-u C-c = | |
2199 | Re-insert the active formula (either a | |
2200 | field formula, or a column formula) into the current field, so that you | |
2201 | can edit it directly in the field. The advantage over editing in the | |
2202 | minibuffer is that you can use the command @kbd{C-c ?}. | |
2203 | @kindex C-c ? | |
2204 | @item C-c ? | |
2205 | While editing a formula in a table field, highlight the field(s) | |
2206 | referenced by the reference at the cursor position in the formula. | |
2207 | @kindex C-c @} | |
2208 | @item C-c @} | |
2209 | Toggle the display of row and column numbers for a table, using | |
2210 | overlays. These are updated each time the table is aligned, you can | |
2211 | force it with @kbd{C-c C-c}. | |
2212 | @kindex C-c @{ | |
2213 | @item C-c @{ | |
2214 | Toggle the formula debugger on and off. See below. | |
2215 | @kindex C-c ' | |
2216 | @item C-c ' | |
2217 | Edit all formulas for the current table in a special buffer, where the | |
2218 | formulas will be displayed one per line. If the current field has an | |
2219 | active formula, the cursor in the formula editor will mark it. | |
a7808fba | 2220 | While inside the special buffer, Org will automatically highlight |
4009494e GM |
2221 | any field or range reference at the cursor position. You may edit, |
2222 | remove and add formulas, and use the following commands: | |
2223 | @table @kbd | |
2224 | @kindex C-c C-c | |
2225 | @kindex C-x C-s | |
2226 | @item C-c C-c | |
2227 | @itemx C-x C-s | |
2228 | Exit the formula editor and store the modified formulas. With @kbd{C-u} | |
2229 | prefix, also apply the new formulas to the entire table. | |
2230 | @kindex C-c C-q | |
2231 | @item C-c C-q | |
2232 | Exit the formula editor without installing changes. | |
2233 | @kindex C-c C-r | |
2234 | @item C-c C-r | |
2235 | Toggle all references in the formula editor between standard (like | |
2236 | @code{B3}) and internal (like @code{@@3$2}). | |
2237 | @kindex @key{TAB} | |
2238 | @item @key{TAB} | |
2239 | Pretty-print or indent lisp formula at point. When in a line containing | |
2240 | a lisp formula, format the formula according to Emacs Lisp rules. | |
2241 | Another @key{TAB} collapses the formula back again. In the open | |
a7808fba | 2242 | formula, @key{TAB} re-indents just like in Emacs lisp mode. |
4009494e GM |
2243 | @kindex M-@key{TAB} |
2244 | @item M-@key{TAB} | |
a7808fba | 2245 | Complete Lisp symbols, just like in Emacs lisp mode. |
4009494e GM |
2246 | @kindex S-@key{up} |
2247 | @kindex S-@key{down} | |
2248 | @kindex S-@key{left} | |
2249 | @kindex S-@key{right} | |
2250 | @item S-@key{up}/@key{down}/@key{left}/@key{right} | |
2251 | Shift the reference at point. For example, if the reference is | |
2252 | @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}. | |
2253 | This also works for relative references, and for hline references. | |
2254 | @kindex M-S-@key{up} | |
2255 | @kindex M-S-@key{down} | |
2256 | @item M-S-@key{up}/@key{down} | |
a7808fba | 2257 | Move the test line for column formulas in the Org buffer up and |
4009494e GM |
2258 | down. |
2259 | @kindex M-@key{up} | |
2260 | @kindex M-@key{down} | |
2261 | @item M-@key{up}/@key{down} | |
2262 | Scroll the window displaying the table. | |
2263 | @kindex C-c @} | |
2264 | @item C-c @} | |
2265 | Turn the coordinate grid in the table on and off. | |
2266 | @end table | |
2267 | @end table | |
2268 | ||
2269 | Making a table field blank does not remove the formula associated with | |
2270 | the field, because that is stored in a different line (the @samp{TBLFM} | |
2271 | line) - during the next recalculation the field will be filled again. | |
2272 | To remove a formula from a field, you have to give an empty reply when | |
2273 | prompted for the formula, or to edit the @samp{#+TBLFM} line. | |
2274 | ||
2275 | @kindex C-c C-c | |
2276 | You may edit the @samp{#+TBLFM} directly and re-apply the changed | |
2277 | equations with @kbd{C-c C-c} in that line, or with the normal | |
2278 | recalculation commands in the table. | |
2279 | ||
2280 | @subsubheading Debugging formulas | |
2281 | @cindex formula debugging | |
2282 | @cindex debugging, of table formulas | |
2283 | When the evaluation of a formula leads to an error, the field content | |
2284 | becomes the string @samp{#ERROR}. If you would like see what is going | |
2285 | on during variable substitution and calculation in order to find a bug, | |
2286 | turn on formula debugging in the @code{Tbl} menu and repeat the | |
2287 | calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a | |
2288 | field. Detailed information will be displayed. | |
2289 | ||
2290 | @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet | |
a7808fba | 2291 | @subsection Updating the table |
4009494e GM |
2292 | @cindex recomputing table fields |
2293 | @cindex updating, table | |
2294 | ||
2295 | Recalculation of a table is normally not automatic, but needs to be | |
2296 | triggered by a command. See @ref{Advanced features} for a way to make | |
2297 | recalculation at least semi-automatically. | |
2298 | ||
2299 | In order to recalculate a line of a table or the entire table, use the | |
2300 | following commands: | |
2301 | ||
2302 | @table @kbd | |
2303 | @kindex C-c * | |
2304 | @item C-c * | |
2305 | Recalculate the current row by first applying the stored column formulas | |
2306 | from left to right, and all field formulas in the current row. | |
2307 | @c | |
2308 | @kindex C-u C-c * | |
2309 | @item C-u C-c * | |
2310 | @kindex C-u C-c C-c | |
2311 | @itemx C-u C-c C-c | |
2312 | Recompute the entire table, line by line. Any lines before the first | |
2313 | hline are left alone, assuming that these are part of the table header. | |
2314 | @c | |
2315 | @kindex C-u C-u C-c * | |
2316 | @kindex C-u C-u C-c C-c | |
2317 | @item C-u C-u C-c * | |
2318 | @itemx C-u C-u C-c C-c | |
2319 | Iterate the table by recomputing it until no further changes occur. | |
2320 | This may be necessary if some computed fields use the value of other | |
2321 | fields that are computed @i{later} in the calculation sequence. | |
2322 | @end table | |
2323 | ||
2324 | @node Advanced features, , Updating the table, The spreadsheet | |
2325 | @subsection Advanced features | |
2326 | ||
2327 | If you want the recalculation of fields to happen automatically, or if | |
2328 | you want to be able to assign @i{names} to fields and columns, you need | |
2329 | to reserve the first column of the table for special marking characters. | |
2330 | @table @kbd | |
2331 | @kindex C-# | |
2332 | @item C-# | |
2333 | Rotate the calculation mark in first column through the states @samp{}, | |
864c9740 CD |
2334 | @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region, |
2335 | change all marks in the region. | |
4009494e GM |
2336 | @end table |
2337 | ||
2338 | Here is an example of a table that collects exam results of students and | |
2339 | makes use of these features: | |
2340 | ||
2341 | @example | |
2342 | @group | |
2343 | |---+---------+--------+--------+--------+-------+------| | |
2344 | | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note | | |
2345 | |---+---------+--------+--------+--------+-------+------| | |
2346 | | ! | | P1 | P2 | P3 | Tot | | | |
2347 | | # | Maximum | 10 | 15 | 25 | 50 | 10.0 | | |
2348 | | ^ | | m1 | m2 | m3 | mt | | | |
2349 | |---+---------+--------+--------+--------+-------+------| | |
2350 | | # | Peter | 10 | 8 | 23 | 41 | 8.2 | | |
4009494e GM |
2351 | | # | Sam | 2 | 4 | 3 | 9 | 1.8 | |
2352 | |---+---------+--------+--------+--------+-------+------| | |
2353 | | | Average | | | | 29.7 | | | |
2354 | | ^ | | | | | at | | | |
2355 | | $ | max=50 | | | | | | | |
2356 | |---+---------+--------+--------+--------+-------+------| | |
2357 | #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f | |
2358 | @end group | |
2359 | @end example | |
2360 | ||
2361 | @noindent @b{Important}: Please note that for these special tables, | |
2362 | recalculating the table with @kbd{C-u C-c *} will only affect rows that | |
2363 | are marked @samp{#} or @samp{*}, and fields that have a formula assigned | |
2364 | to the field itself. The column formulas are not applied in rows with | |
2365 | empty first field. | |
2366 | ||
2367 | @cindex marking characters, tables | |
2368 | The marking characters have the following meaning: | |
2369 | @table @samp | |
2370 | @item ! | |
2371 | The fields in this line define names for the columns, so that you may | |
2372 | refer to a column as @samp{$Tot} instead of @samp{$6}. | |
2373 | @item ^ | |
2374 | This row defines names for the fields @emph{above} the row. With such | |
2375 | a definition, any formula in the table may use @samp{$m1} to refer to | |
2376 | the value @samp{10}. Also, if you assign a formula to a names field, it | |
2377 | will be stored as @samp{$name=...}. | |
2378 | @item _ | |
2379 | Similar to @samp{^}, but defines names for the fields in the row | |
2380 | @emph{below}. | |
2381 | @item $ | |
2382 | Fields in this row can define @emph{parameters} for formulas. For | |
2383 | example, if a field in a @samp{$} row contains @samp{max=50}, then | |
2384 | formulas in this table can refer to the value 50 using @samp{$max}. | |
2385 | Parameters work exactly like constants, only that they can be defined on | |
2386 | a per-table basis. | |
2387 | @item # | |
2388 | Fields in this row are automatically recalculated when pressing | |
2389 | @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row | |
2390 | is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked | |
2391 | lines will be left alone by this command. | |
2392 | @item * | |
2393 | Selects this line for global recalculation with @kbd{C-u C-c *}, but | |
2394 | not for automatic recalculation. Use this when automatic | |
2395 | recalculation slows down editing too much. | |
2396 | @item | |
2397 | Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}. | |
2398 | All lines that should be recalculated should be marked with @samp{#} | |
2399 | or @samp{*}. | |
2400 | @item / | |
2401 | Do not export this line. Useful for lines that contain the narrowing | |
2402 | @samp{<N>} markers. | |
2403 | @end table | |
2404 | ||
2405 | Finally, just to whet your appetite on what can be done with the | |
2406 | fantastic @file{calc} package, here is a table that computes the Taylor | |
28a16a1b CD |
2407 | series of degree @code{n} at location @code{x} for a couple of |
2408 | functions. | |
4009494e GM |
2409 | |
2410 | @example | |
2411 | @group | |
2412 | |---+-------------+---+-----+--------------------------------------| | |
2413 | | | Func | n | x | Result | | |
2414 | |---+-------------+---+-----+--------------------------------------| | |
2415 | | # | exp(x) | 1 | x | 1 + x | | |
2416 | | # | exp(x) | 2 | x | 1 + x + x^2 / 2 | | |
2417 | | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 | | |
2418 | | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 | | |
2419 | | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 | | |
2420 | | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 | | |
2421 | |---+-------------+---+-----+--------------------------------------| | |
2422 | #+TBLFM: $5=taylor($2,$4,$3);n3 | |
2423 | @end group | |
2424 | @end example | |
2425 | ||
864c9740 CD |
2426 | @page |
2427 | @node Org Plot, , The spreadsheet, Tables | |
2428 | @section Org Plot | |
2429 | @cindex graph, in tables | |
2430 | @cindex plot tables using gnuplot | |
2431 | ||
2432 | Org Plot can produce 2D and 3D graphs of information stored in org tables | |
71d35b24 CD |
2433 | using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode} |
2434 | @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}. To see | |
2435 | this in action ensure that you have both Gnuplot and Gnuplot-mode installed | |
2436 | on your system, then call @code{org-plot/gnuplot} on the following table. | |
864c9740 CD |
2437 | |
2438 | @example | |
2439 | @group | |
2440 | #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]" | |
2441 | | Sede | Max cites | H-index | | |
2442 | |-----------+-----------+---------| | |
2443 | | Chile | 257.72 | 21.39 | | |
2444 | | Leeds | 165.77 | 19.68 | | |
2445 | | Sao Paolo | 71.00 | 11.50 | | |
2446 | | Stockholm | 134.19 | 14.33 | | |
2447 | | Morelia | 257.56 | 17.67 | | |
2448 | @end group | |
2449 | @end example | |
2450 | ||
2451 | Notice that Org Plot is smart enough to apply the tables headers as labels. | |
2452 | Further control over the labels, type, content, and appearance of plots can | |
2453 | be exercised through the @code{#+Plot:} lines preceding a table. See below | |
2454 | for a complete list of Org plot options. For more information and examples | |
71d35b24 CD |
2455 | see the org-plot tutorial at |
2456 | @uref{http://legito.org/worg/org-tutorials/org-plot.php}. | |
864c9740 CD |
2457 | |
2458 | @subsubheading Plot Options | |
2459 | ||
2460 | @table @code | |
2461 | @item set | |
2462 | Specify any @file{gnuplot} option to be set when graphing. | |
2463 | ||
2464 | @item title | |
2465 | Specify the title of the plot. | |
2466 | ||
2467 | @item ind | |
2468 | Specify which column of the table to use as the @code{x} axis. | |
2469 | ||
2470 | @item deps | |
71d35b24 CD |
2471 | Specify the columns to graph as a lisp style list, surrounded by parenthesis |
2472 | and separated by spaces for example @code{dep:(3 4)} to graph the third and | |
2473 | fourth columns (defaults to graphing all other columns aside from the ind | |
2474 | column). | |
864c9740 CD |
2475 | |
2476 | @item type | |
2477 | Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}. | |
2478 | ||
2479 | @item with | |
2480 | Specify a @code{with} option to be inserted for every col being plotted | |
2481 | (e.g. @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...). | |
2482 | Defaults to 'lines'. | |
2483 | ||
2484 | @item file | |
2485 | If you want to plot to a file specify the @code{"path/to/desired/output-file"}. | |
2486 | ||
2487 | @item labels | |
2488 | List of labels to be used for the deps (defaults to column headers if they | |
2489 | exist). | |
2490 | ||
2491 | @item line | |
2492 | Specify an entire line to be inserted in the gnuplot script. | |
2493 | ||
2494 | @item map | |
2495 | When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a | |
2496 | flat mapping rather than a @code{3d} slope. | |
2497 | ||
e45e3595 CD |
2498 | @item timefmt |
2499 | Specify format of org-mode timestamps as they will be parsed by gnuplot. | |
2500 | Defaults to '%Y-%m-%d-%H:%M:%S'. | |
2501 | ||
864c9740 CD |
2502 | @item script |
2503 | If you want total control you can specify a script file (place the file name | |
2504 | between double quotes) which will be used to plot. Before plotting, every | |
2505 | instance of @code{$datafile} in the specified script will be replaced with | |
2506 | the path to the generated data file. Note even if you set this option you | |
2507 | may still want to specify the plot type, as that can impact the content of | |
2508 | the data file. | |
2509 | @end table | |
2510 | ||
a7808fba | 2511 | @node Hyperlinks, TODO Items, Tables, Top |
4009494e GM |
2512 | @chapter Hyperlinks |
2513 | @cindex hyperlinks | |
2514 | ||
a7808fba | 2515 | Like HTML, Org provides links inside a file, external links to |
dbc28aaa | 2516 | other files, Usenet articles, emails, and much more. |
4009494e GM |
2517 | |
2518 | @menu | |
a7808fba | 2519 | * Link format:: How links in Org are formatted |
4009494e GM |
2520 | * Internal links:: Links to other places in the current file |
2521 | * External links:: URL-like links to the world | |
2522 | * Handling links:: Creating, inserting and following | |
a7808fba | 2523 | * Using links outside Org:: Linking from my C source code? |
4009494e GM |
2524 | * Link abbreviations:: Shortcuts for writing complex links |
2525 | * Search options:: Linking to a specific location | |
2526 | * Custom searches:: When the default search is not enough | |
4009494e GM |
2527 | @end menu |
2528 | ||
2529 | @node Link format, Internal links, Hyperlinks, Hyperlinks | |
2530 | @section Link format | |
2531 | @cindex link format | |
2532 | @cindex format, of links | |
2533 | ||
a7808fba | 2534 | Org will recognize plain URL-like links and activate them as |
4009494e GM |
2535 | clickable links. The general link format, however, looks like this: |
2536 | ||
2537 | @example | |
28a16a1b | 2538 | [[link][description]] @r{or alternatively} [[link]] |
4009494e GM |
2539 | @end example |
2540 | ||
a7808fba | 2541 | Once a link in the buffer is complete (all brackets present), Org |
4009494e GM |
2542 | will change the display so that @samp{description} is displayed instead |
2543 | of @samp{[[link][description]]} and @samp{link} is displayed instead of | |
2544 | @samp{[[link]]}. Links will be highlighted in the face @code{org-link}, | |
2545 | which by default is an underlined face. You can directly edit the | |
2546 | visible part of a link. Note that this can be either the @samp{link} | |
2547 | part (if there is no description) or the @samp{description} part. To | |
2548 | edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the | |
2549 | cursor on the link. | |
2550 | ||
2551 | If you place the cursor at the beginning or just behind the end of the | |
2552 | displayed text and press @key{BACKSPACE}, you will remove the | |
2553 | (invisible) bracket at that location. This makes the link incomplete | |
2554 | and the internals are again displayed as plain text. Inserting the | |
2555 | missing bracket hides the link internals again. To show the | |
2556 | internal structure of all links, use the menu entry | |
2557 | @code{Org->Hyperlinks->Literal links}. | |
2558 | ||
2559 | @node Internal links, External links, Link format, Hyperlinks | |
2560 | @section Internal links | |
2561 | @cindex internal links | |
2562 | @cindex links, internal | |
2563 | @cindex targets, for links | |
2564 | ||
2565 | If the link does not look like a URL, it is considered to be internal in | |
2566 | the current file. Links such as @samp{[[My Target]]} or @samp{[[My | |
2567 | Target][Find my target]]} lead to a text search in the current file. | |
2568 | The link can be followed with @kbd{C-c C-o} when the cursor is on the | |
2569 | link, or with a mouse click (@pxref{Handling links}). The preferred | |
2570 | match for such a link is a dedicated target: the same string in double | |
2571 | angular brackets. Targets may be located anywhere; sometimes it is | |
2572 | convenient to put them into a comment line. For example | |
2573 | ||
2574 | @example | |
2575 | # <<My Target>> | |
2576 | @end example | |
2577 | ||
2578 | @noindent In HTML export (@pxref{HTML export}), such targets will become | |
64fb801f CD |
2579 | named anchors for direct access through @samp{http} links@footnote{Note that |
2580 | text before the first headline is usually not exported, so the first such | |
2581 | target should be after the first headline, or in the line directly before the | |
2582 | first headline.}. | |
4009494e | 2583 | |
a7808fba | 2584 | If no dedicated target exists, Org will search for the words in the |
4009494e GM |
2585 | link. In the above example the search would be for @samp{my target}. |
2586 | Links starting with a star like @samp{*My Target} restrict the search to | |
a7808fba | 2587 | headlines. When searching, Org mode will first try an exact match, but |
4009494e GM |
2588 | then move on to more and more lenient searches. For example, the link |
2589 | @samp{[[*My Targets]]} will find any of the following: | |
2590 | ||
2591 | @example | |
2592 | ** My targets | |
2593 | ** TODO my targets are bright | |
2594 | ** my 20 targets are | |
2595 | @end example | |
2596 | ||
2597 | To insert a link targeting a headline, in-buffer completion can be used. | |
2598 | Just type a star followed by a few optional letters into the buffer and | |
2599 | press @kbd{M-@key{TAB}}. All headlines in the current buffer will be | |
2600 | offered as completions. @xref{Handling links}, for more commands | |
2601 | creating links. | |
2602 | ||
a7808fba | 2603 | Following a link pushes a mark onto Org's own mark ring. You can |
4009494e GM |
2604 | return to the previous position with @kbd{C-c &}. Using this command |
2605 | several times in direct succession goes back to positions recorded | |
2606 | earlier. | |
2607 | ||
2608 | @menu | |
a7808fba | 2609 | * Radio targets:: Make targets trigger links in plain text |
4009494e GM |
2610 | @end menu |
2611 | ||
2612 | @node Radio targets, , Internal links, Internal links | |
2613 | @subsection Radio targets | |
2614 | @cindex radio targets | |
2615 | @cindex targets, radio | |
2616 | @cindex links, radio targets | |
2617 | ||
a7808fba | 2618 | Org can automatically turn any occurrences of certain target names |
4009494e GM |
2619 | in normal text into a link. So without explicitly creating a link, the |
2620 | text connects to the target radioing its position. Radio targets are | |
2621 | enclosed by triple angular brackets. For example, a target @samp{<<<My | |
2622 | Target>>>} causes each occurrence of @samp{my target} in normal text to | |
a7808fba | 2623 | become activated as a link. The Org file is scanned automatically |
4009494e GM |
2624 | for radio targets only when the file is first loaded into Emacs. To |
2625 | update the target list during editing, press @kbd{C-c C-c} with the | |
2626 | cursor on or at a target. | |
2627 | ||
2628 | @node External links, Handling links, Internal links, Hyperlinks | |
2629 | @section External links | |
2630 | @cindex links, external | |
2631 | @cindex external links | |
2632 | @cindex links, external | |
a7808fba | 2633 | @cindex Gnus links |
4009494e | 2634 | @cindex BBDB links |
28a16a1b | 2635 | @cindex IRC links |
4009494e GM |
2636 | @cindex URL links |
2637 | @cindex file links | |
2638 | @cindex VM links | |
2639 | @cindex RMAIL links | |
2640 | @cindex WANDERLUST links | |
2641 | @cindex MH-E links | |
2642 | @cindex USENET links | |
2643 | @cindex SHELL links | |
2644 | @cindex Info links | |
2645 | @cindex elisp links | |
2646 | ||
a7808fba | 2647 | Org supports links to files, websites, Usenet and email messages, |
28a16a1b CD |
2648 | BBDB database entries and links to both IRC conversations and their |
2649 | logs. External links are URL-like locators. They start with a short | |
2650 | identifying string followed by a colon. There can be no space after | |
2651 | the colon. The following list shows examples for each link type. | |
4009494e GM |
2652 | |
2653 | @example | |
a7808fba | 2654 | http://www.astro.uva.nl/~dominik @r{on the web} |
4009494e | 2655 | file:/home/dominik/images/jupiter.jpg @r{file, absolute path} |
44ce9197 | 2656 | /home/dominik/images/jupiter.jpg @r{same as above} |
4009494e | 2657 | file:papers/last.pdf @r{file, relative path} |
44ce9197 | 2658 | ./papers/last.pdf @r{same as above} |
55e0839d CD |
2659 | file:projects.org @r{another org file} |
2660 | file:projects.org::some words @r{text search in org file} | |
2661 | file:projects.org::*task title @r{heading search in org file} | |
2662 | id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID} | |
4009494e | 2663 | news:comp.emacs @r{Usenet link} |
55e0839d | 2664 | mailto:adent@@galaxy.net @r{Mail link} |
4009494e GM |
2665 | vm:folder @r{VM folder link} |
2666 | vm:folder#id @r{VM message link} | |
55e0839d | 2667 | vm://myself@@some.where.org/folder#id @r{VM on remote machine} |
4009494e GM |
2668 | wl:folder @r{WANDERLUST folder link} |
2669 | wl:folder#id @r{WANDERLUST message link} | |
2670 | mhe:folder @r{MH-E folder link} | |
2671 | mhe:folder#id @r{MH-E message link} | |
2672 | rmail:folder @r{RMAIL folder link} | |
2673 | rmail:folder#id @r{RMAIL message link} | |
a7808fba CD |
2674 | gnus:group @r{Gnus group link} |
2675 | gnus:group#id @r{Gnus article link} | |
64fb801f | 2676 | bbdb:R.*Stallman @r{BBDB link (with regexp)} |
28a16a1b | 2677 | irc:/irc.com/#emacs/bob @r{IRC link} |
4009494e | 2678 | shell:ls *.org @r{A shell command} |
64fb801f CD |
2679 | elisp:org-agenda @r{Interactive elisp command} |
2680 | elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate} | |
4009494e GM |
2681 | @end example |
2682 | ||
2683 | A link should be enclosed in double brackets and may contain a | |
a7808fba | 2684 | descriptive text to be displayed instead of the URL (@pxref{Link |
4009494e GM |
2685 | format}), for example: |
2686 | ||
2687 | @example | |
2688 | [[http://www.gnu.org/software/emacs/][GNU Emacs]] | |
2689 | @end example | |
2690 | ||
2691 | @noindent | |
2692 | If the description is a file name or URL that points to an image, HTML | |
2693 | export (@pxref{HTML export}) will inline the image as a clickable | |
2694 | button. If there is no description at all and the link points to an | |
2695 | image, | |
2696 | that image will be inlined into the exported HTML file. | |
2697 | ||
2698 | @cindex angular brackets, around links | |
2699 | @cindex plain text external links | |
a7808fba | 2700 | Org also finds external links in the normal text and activates them |
4009494e GM |
2701 | as links. If spaces must be part of the link (for example in |
2702 | @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities | |
2703 | about the end of the link, enclose them in angular brackets. | |
2704 | ||
a7808fba | 2705 | @node Handling links, Using links outside Org, External links, Hyperlinks |
4009494e GM |
2706 | @section Handling links |
2707 | @cindex links, handling | |
2708 | ||
a7808fba CD |
2709 | Org provides methods to create a link in the correct syntax, to |
2710 | insert it into an Org file, and to follow the link. | |
4009494e GM |
2711 | |
2712 | @table @kbd | |
2713 | @kindex C-c l | |
2714 | @cindex storing links | |
2715 | @item C-c l | |
55e0839d CD |
2716 | Store a link to the current location. This is a @emph{global} command (you |
2717 | must create the key binding yourself) which can be used in any buffer to | |
2718 | create a link. The link will be stored for later insertion into an Org | |
2719 | buffer (see below). | |
2720 | ||
2721 | For Org files, if there is a @samp{<<target>>} at the cursor, the link points | |
2722 | to the target. Otherwise it points to the current headline, either by text | |
2723 | (unsafe), or, if @file{org-id.el} is loaded and @code{org-link-to-org-use-id} | |
2724 | is set, by ID property. | |
2725 | ||
2726 | For VM, Rmail, Wanderlust, MH-E, Gnus and BBDB buffers, the link will | |
2727 | indicate the current article/entry. For W3 and W3M buffers, the link goes to | |
2728 | the current URL. For IRC links, if you set the variable | |
2729 | @code{org-irc-link-to-logs} to non-nil then @kbd{C-c l} will store a | |
67df9cfb | 2730 | @samp{file:/} style link to the relevant point in the logs for the current |
2096a1b6 | 2731 | conversation. Otherwise an @samp{irc:/} style link to the user/channel/server |
55e0839d CD |
2732 | under the point will be stored. |
2733 | ||
2734 | For any other files, the link will point to the file, with a search string | |
2735 | (@pxref{Search options}) pointing to the contents of the current line. If | |
2736 | there is an active region, the selected words will form the basis of the | |
2737 | search string. If the automatically created link is not working correctly or | |
2738 | accurately enough, you can write custom functions to select the search string | |
2739 | and to do the search for particular file types - see @ref{Custom searches}. | |
2740 | The key binding @kbd{C-c l} is only a suggestion - see @ref{Installation}. | |
4009494e GM |
2741 | @c |
2742 | @kindex C-c C-l | |
2743 | @cindex link completion | |
2744 | @cindex completion, of links | |
2745 | @cindex inserting links | |
2746 | @item C-c C-l | |
a7808fba CD |
2747 | Insert a link. This prompts for a link to be inserted into the buffer. You |
2748 | can just type a link, using text for an internal link, or one of the link | |
2749 | type prefixes mentioned in the examples above. All links stored during the | |
2750 | current session are part of the history for this prompt, so you can access | |
2751 | them with @key{up} and @key{down} (or @kbd{M-p/n}). Completion, on the other | |
2752 | hand, will help you to insert valid link prefixes like @samp{http:} or | |
2753 | @samp{ftp:}, including the prefixes defined through link abbreviations | |
2754 | (@pxref{Link abbreviations}). The link will be inserted into the | |
2755 | buffer@footnote{After insertion of a stored link, the link will be removed | |
2756 | from the list of stored links. To keep it in the list later use, use a | |
2757 | triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option | |
2758 | @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text. | |
2759 | If some text was selected when this command is called, the selected text | |
2760 | becomes the default description.@* Note that you don't have to use this | |
2761 | command to insert a link. Links in Org are plain text, and you can type | |
2762 | or paste them straight into the buffer. By using this command, the links are | |
2763 | automatically enclosed in double brackets, and you will be asked for the | |
2764 | optional descriptive text. | |
4009494e GM |
2765 | @c |
2766 | @c If the link is a @samp{file:} link and | |
2767 | @c the linked file is located in the same directory as the current file or | |
2768 | @c a subdirectory of it, the path of the file will be inserted relative to | |
2769 | @c the current directory. | |
2770 | @c | |
2771 | @kindex C-u C-c C-l | |
2772 | @cindex file name completion | |
2773 | @cindex completion, of file names | |
2774 | @item C-u C-c C-l | |
2775 | When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to | |
2776 | a file will be inserted and you may use file name completion to select | |
2777 | the name of the file. The path to the file is inserted relative to the | |
2778 | directory of the current org file, if the linked file is in the current | |
a7808fba | 2779 | directory or in a sub-directory of it, or if the path is written relative |
4009494e GM |
2780 | to the current directory using @samp{../}. Otherwise an absolute path |
2781 | is used, if possible with @samp{~/} for your home directory. You can | |
2782 | force an absolute path with two @kbd{C-u} prefixes. | |
2783 | @c | |
2784 | @item C-c C-l @r{(with cursor on existing link)} | |
2785 | When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the | |
2786 | link and description parts of the link. | |
2787 | @c | |
2788 | @cindex following links | |
2789 | @kindex C-c C-o | |
2790 | @item C-c C-o | |
2791 | Open link at point. This will launch a web browser for URLs (using | |
864c9740 CD |
2792 | @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for |
2793 | the corresponding links, and execute the command in a shell link. When the | |
2794 | cursor is on an internal link, this commands runs the corresponding search. | |
2795 | When the cursor is on a TAG list in a headline, it creates the corresponding | |
2796 | TAGS view. If the cursor is on a time stamp, it compiles the agenda for that | |
2797 | date. Furthermore, it will visit text and remote files in @samp{file:} links | |
2798 | with Emacs and select a suitable application for local non-text files. | |
2799 | Classification of files is based on file extension only. See option | |
2800 | @code{org-file-apps}. If you want to override the default application and | |
e45e3595 CD |
2801 | visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid |
2802 | opening in Emacs, use a @kbd{C-u C-u} prefix. | |
4009494e GM |
2803 | @c |
2804 | @kindex mouse-2 | |
2805 | @kindex mouse-1 | |
2806 | @item mouse-2 | |
2807 | @itemx mouse-1 | |
2808 | On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o} | |
2809 | would. Under Emacs 22, also @kbd{mouse-1} will follow a link. | |
2810 | @c | |
2811 | @kindex mouse-3 | |
2812 | @item mouse-3 | |
2813 | Like @kbd{mouse-2}, but force file links to be opened with Emacs, and | |
2814 | internal links to be displayed in another window@footnote{See the | |
2815 | variable @code{org-display-internal-link-with-indirect-buffer}}. | |
2816 | @c | |
2817 | @cindex mark ring | |
2818 | @kindex C-c % | |
2819 | @item C-c % | |
2820 | Push the current position onto the mark ring, to be able to return | |
2821 | easily. Commands following an internal link do this automatically. | |
2822 | @c | |
2823 | @cindex links, returning to | |
2824 | @kindex C-c & | |
2825 | @item C-c & | |
2826 | Jump back to a recorded position. A position is recorded by the | |
2827 | commands following internal links, and by @kbd{C-c %}. Using this | |
2828 | command several times in direct succession moves through a ring of | |
2829 | previously recorded positions. | |
2830 | @c | |
2831 | @kindex C-c C-x C-n | |
2832 | @kindex C-c C-x C-p | |
2833 | @cindex links, finding next/previous | |
2834 | @item C-c C-x C-n | |
2835 | @itemx C-c C-x C-p | |
2836 | Move forward/backward to the next link in the buffer. At the limit of | |
2837 | the buffer, the search fails once, and then wraps around. The key | |
2838 | bindings for this are really too long, you might want to bind this also | |
2839 | to @kbd{C-n} and @kbd{C-p} | |
2840 | @lisp | |
2841 | (add-hook 'org-load-hook | |
2842 | (lambda () | |
2843 | (define-key 'org-mode-map "\C-n" 'org-next-link) | |
2844 | (define-key 'org-mode-map "\C-p" 'org-previous-link))) | |
2845 | @end lisp | |
2846 | @end table | |
2847 | ||
a7808fba CD |
2848 | @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks |
2849 | @section Using links outside Org | |
4009494e | 2850 | |
a7808fba CD |
2851 | You can insert and follow links that have Org syntax not only in |
2852 | Org, but in any Emacs buffer. For this, you should create two | |
4009494e GM |
2853 | global commands, like this (please select suitable global keys |
2854 | yourself): | |
2855 | ||
2856 | @lisp | |
2857 | (global-set-key "\C-c L" 'org-insert-link-global) | |
2858 | (global-set-key "\C-c o" 'org-open-at-point-global) | |
2859 | @end lisp | |
2860 | ||
a7808fba | 2861 | @node Link abbreviations, Search options, Using links outside Org, Hyperlinks |
4009494e GM |
2862 | @section Link abbreviations |
2863 | @cindex link abbreviations | |
2864 | @cindex abbreviation, links | |
2865 | ||
2866 | Long URLs can be cumbersome to type, and often many similar links are | |
2867 | needed in a document. For this you can use link abbreviations. An | |
2868 | abbreviated link looks like this | |
2869 | ||
2870 | @example | |
2871 | [[linkword:tag][description]] | |
2872 | @end example | |
2873 | ||
2874 | @noindent | |
2875 | where the tag is optional. Such abbreviations are resolved according to | |
2876 | the information in the variable @code{org-link-abbrev-alist} that | |
2877 | relates the linkwords to replacement text. Here is an example: | |
2878 | ||
2879 | @lisp | |
2880 | @group | |
2881 | (setq org-link-abbrev-alist | |
2882 | '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=") | |
2883 | ("google" . "http://www.google.com/search?q=") | |
2884 | ("ads" . "http://adsabs.harvard.edu/cgi-bin/ | |
2885 | nph-abs_connect?author=%s&db_key=AST"))) | |
2886 | @end group | |
2887 | @end lisp | |
2888 | ||
2889 | If the replacement text contains the string @samp{%s}, it will be | |
2890 | replaced with the tag. Otherwise the tag will be appended to the string | |
2891 | in order to create the link. You may also specify a function that will | |
2892 | be called with the tag as the only argument to create the link. | |
2893 | ||
2894 | With the above setting, you could link to a specific bug with | |
2895 | @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with | |
a7808fba | 2896 | @code{[[google:OrgMode]]} and find out what the Org author is |
4009494e GM |
2897 | doing besides Emacs hacking with @code{[[ads:Dominik,C]]}. |
2898 | ||
a7808fba | 2899 | If you need special abbreviations just for a single Org buffer, you |
4009494e GM |
2900 | can define them in the file with |
2901 | ||
2902 | @example | |
2903 | #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id= | |
2904 | #+LINK: google http://www.google.com/search?q=%s | |
2905 | @end example | |
2906 | ||
2907 | @noindent | |
2908 | In-buffer completion @pxref{Completion} can be used after @samp{[} to | |
2909 | complete link abbreviations. | |
2910 | ||
2911 | @node Search options, Custom searches, Link abbreviations, Hyperlinks | |
2912 | @section Search options in file links | |
2913 | @cindex search option in file links | |
2914 | @cindex file links, searching | |
2915 | ||
2916 | File links can contain additional information to make Emacs jump to a | |
2917 | particular location in the file when following a link. This can be a | |
2918 | line number or a search option after a double@footnote{For backward | |
2919 | compatibility, line numbers can also follow a single colon.} colon. For | |
2920 | example, when the command @kbd{C-c l} creates a link (@pxref{Handling | |
2921 | links}) to a file, it encodes the words in the current line as a search | |
2922 | string that can be used to find this line back later when following the | |
28a16a1b | 2923 | link with @kbd{C-c C-o}. |
4009494e GM |
2924 | |
2925 | Here is the syntax of the different ways to attach a search to a file | |
2926 | link, together with an explanation: | |
2927 | ||
2928 | @example | |
2929 | [[file:~/code/main.c::255]] | |
2930 | [[file:~/xx.org::My Target]] | |
2931 | [[file:~/xx.org::*My Target]] | |
2932 | [[file:~/xx.org::/regexp/]] | |
2933 | @end example | |
2934 | ||
2935 | @table @code | |
2936 | @item 255 | |
2937 | Jump to line 255. | |
2938 | @item My Target | |
2939 | Search for a link target @samp{<<My Target>>}, or do a text search for | |
2940 | @samp{my target}, similar to the search in internal links, see | |
2941 | @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file | |
2942 | link will become an HTML reference to the corresponding named anchor in | |
2943 | the linked file. | |
2944 | @item *My Target | |
a7808fba | 2945 | In an Org file, restrict search to headlines. |
4009494e GM |
2946 | @item /regexp/ |
2947 | Do a regular expression search for @code{regexp}. This uses the Emacs | |
2948 | command @code{occur} to list all matches in a separate window. If the | |
a7808fba | 2949 | target file is in Org mode, @code{org-occur} is used to create a |
4009494e GM |
2950 | sparse tree with the matches. |
2951 | @c If the target file is a directory, | |
2952 | @c @code{grep} will be used to search all files in the directory. | |
2953 | @end table | |
2954 | ||
2955 | As a degenerate case, a file link with an empty file name can be used | |
2956 | to search the current file. For example, @code{[[file:::find me]]} does | |
2957 | a search for @samp{find me} in the current file, just as | |
2958 | @samp{[[find me]]} would. | |
2959 | ||
dbc28aaa | 2960 | @node Custom searches, , Search options, Hyperlinks |
4009494e GM |
2961 | @section Custom Searches |
2962 | @cindex custom search strings | |
2963 | @cindex search strings, custom | |
2964 | ||
2965 | The default mechanism for creating search strings and for doing the | |
2966 | actual search related to a file link may not work correctly in all | |
2967 | cases. For example, BibTeX database files have many entries like | |
2968 | @samp{year="1993"} which would not result in good search strings, | |
2969 | because the only unique identification for a BibTeX entry is the | |
2970 | citation key. | |
2971 | ||
2972 | If you come across such a problem, you can write custom functions to set | |
2973 | the right search string for a particular file type, and to do the search | |
2974 | for the string in the file. Using @code{add-hook}, these functions need | |
2975 | to be added to the hook variables | |
2976 | @code{org-create-file-search-functions} and | |
2977 | @code{org-execute-file-search-functions}. See the docstring for these | |
a7808fba | 2978 | variables for more information. Org actually uses this mechanism |
4009494e | 2979 | for Bib@TeX{} database files, and you can use the corresponding code as |
44ce9197 | 2980 | an implementation example. See the file @file{org-bibtex.el}. |
4009494e | 2981 | |
a7808fba CD |
2982 | @node TODO Items, Tags, Hyperlinks, Top |
2983 | @chapter TODO Items | |
4009494e GM |
2984 | @cindex TODO items |
2985 | ||
44ce9197 | 2986 | Org mode does not maintain TODO lists as separate documents@footnote{Of |
a50253cc | 2987 | course, you can make a document that contains only long lists of TODO items, |
44ce9197 CD |
2988 | but this is not required.}. Instead, TODO items are an integral part of the |
2989 | notes file, because TODO items usually come up while taking notes! With Org | |
2990 | mode, simply mark any entry in a tree as being a TODO item. In this way, | |
2991 | information is not duplicated, and the entire context from which the TODO | |
2992 | item emerged is always present. | |
4009494e | 2993 | |
dbc28aaa | 2994 | Of course, this technique for managing TODO items scatters them |
a7808fba | 2995 | throughout your notes file. Org mode compensates for this by providing |
dbc28aaa | 2996 | methods to give you an overview of all the things that you have to do. |
4009494e GM |
2997 | |
2998 | @menu | |
2999 | * TODO basics:: Marking and displaying TODO entries | |
3000 | * TODO extensions:: Workflow and assignments | |
dbc28aaa | 3001 | * Progress logging:: Dates and notes for progress |
4009494e GM |
3002 | * Priorities:: Some things are more important than others |
3003 | * Breaking down tasks:: Splitting a task into manageable pieces | |
3004 | * Checkboxes:: Tick-off lists | |
3005 | @end menu | |
3006 | ||
a7808fba | 3007 | @node TODO basics, TODO extensions, TODO Items, TODO Items |
4009494e GM |
3008 | @section Basic TODO functionality |
3009 | ||
dbc28aaa CD |
3010 | Any headline becomes a TODO item when it starts with the word |
3011 | @samp{TODO}, for example: | |
4009494e GM |
3012 | |
3013 | @example | |
3014 | *** TODO Write letter to Sam Fortune | |
3015 | @end example | |
3016 | ||
3017 | @noindent | |
3018 | The most important commands to work with TODO entries are: | |
3019 | ||
3020 | @table @kbd | |
3021 | @kindex C-c C-t | |
3022 | @cindex cycling, of TODO states | |
3023 | @item C-c C-t | |
3024 | Rotate the TODO state of the current item among | |
3025 | ||
3026 | @example | |
3027 | ,-> (unmarked) -> TODO -> DONE --. | |
3028 | '--------------------------------' | |
3029 | @end example | |
3030 | ||
3031 | The same rotation can also be done ``remotely'' from the timeline and | |
3032 | agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}). | |
dbc28aaa CD |
3033 | |
3034 | @kindex C-u C-c C-t | |
3035 | @item C-u C-c C-t | |
3036 | Select a specific keyword using completion or (if it has been set up) | |
28a16a1b CD |
3037 | the fast selection interface. For the latter, you need to assign keys |
3038 | to TODO states, see @ref{Per-file keywords} and @ref{Setting tags} for | |
3039 | more information. | |
dbc28aaa | 3040 | |
4009494e GM |
3041 | @kindex S-@key{right} |
3042 | @kindex S-@key{left} | |
3043 | @item S-@key{right} | |
3044 | @itemx S-@key{left} | |
dbc28aaa CD |
3045 | Select the following/preceding TODO state, similar to cycling. Useful |
3046 | mostly if more than two TODO states are possible (@pxref{TODO | |
4009494e | 3047 | extensions}). |
4009494e | 3048 | @kindex C-c C-v |
dbc28aaa | 3049 | @kindex C-c / t |
4009494e GM |
3050 | @cindex sparse tree, for TODO |
3051 | @item C-c C-v | |
dbc28aaa | 3052 | @itemx C-c / t |
4009494e GM |
3053 | View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds |
3054 | the entire buffer, but shows all TODO items and the headings hierarchy | |
a7808fba | 3055 | above them. With a prefix argument, search for a specific TODO. You will be |
4009494e | 3056 | prompted for the keyword, and you can also give a list of keywords like |
a7808fba | 3057 | @code{KWD1|KWD2|...}. With numeric prefix argument N, show the tree for the |
4009494e | 3058 | Nth keyword in the variable @code{org-todo-keywords}. With two prefix |
a7808fba | 3059 | arguments, find all TODO and DONE entries. |
4009494e GM |
3060 | @kindex C-c a t |
3061 | @item C-c a t | |
dbc28aaa | 3062 | Show the global TODO list. Collects the TODO items from all agenda |
a7808fba | 3063 | files (@pxref{Agenda Views}) into a single buffer. The new buffer will |
dbc28aaa CD |
3064 | be in @code{agenda-mode}, which provides commands to examine and |
3065 | manipulate the TODO entries from the new buffer (@pxref{Agenda | |
3066 | commands}). @xref{Global TODO list}, for more information. | |
4009494e GM |
3067 | @kindex S-M-@key{RET} |
3068 | @item S-M-@key{RET} | |
3069 | Insert a new TODO entry below the current one. | |
3070 | @end table | |
3071 | ||
71d35b24 CD |
3072 | @noindent |
3073 | Changing a TODO state can also trigger tag changes. See the docstring of the | |
3074 | option @code{org-todo-state-tags-triggers} for details. | |
3075 | ||
a7808fba | 3076 | @node TODO extensions, Progress logging, TODO basics, TODO Items |
4009494e GM |
3077 | @section Extended use of TODO keywords |
3078 | @cindex extended TODO keywords | |
3079 | ||
dbc28aaa | 3080 | By default, marked TODO entries have one of only two states: TODO and |
a7808fba | 3081 | DONE. Org mode allows you to classify TODO items in more complex ways |
dbc28aaa CD |
3082 | with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With |
3083 | special setup, the TODO keyword system can work differently in different | |
3084 | files. | |
4009494e GM |
3085 | |
3086 | Note that @i{tags} are another way to classify headlines in general and | |
3087 | TODO items in particular (@pxref{Tags}). | |
3088 | ||
3089 | @menu | |
3090 | * Workflow states:: From TODO to DONE in steps | |
dbc28aaa | 3091 | * TODO types:: I do this, Fred does the rest |
4009494e | 3092 | * Multiple sets in one file:: Mixing it all, and still finding your way |
dbc28aaa CD |
3093 | * Fast access to TODO states:: Single letter selection of a state |
3094 | * Per-file keywords:: Different files, different requirements | |
3095 | * Faces for TODO keywords:: Highlighting states | |
4009494e GM |
3096 | @end menu |
3097 | ||
3098 | @node Workflow states, TODO types, TODO extensions, TODO extensions | |
3099 | @subsection TODO keywords as workflow states | |
3100 | @cindex TODO workflow | |
3101 | @cindex workflow states as TODO keywords | |
3102 | ||
3103 | You can use TODO keywords to indicate different @emph{sequential} states | |
3104 | in the process of working on an item, for example@footnote{Changing | |
a7808fba | 3105 | this variable only becomes effective after restarting Org mode in a |
4009494e GM |
3106 | buffer.}: |
3107 | ||
3108 | @lisp | |
3109 | (setq org-todo-keywords | |
3110 | '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED"))) | |
3111 | @end lisp | |
3112 | ||
3113 | The vertical bar separates the TODO keywords (states that @emph{need | |
44ce9197 | 3114 | action}) from the DONE states (which need @emph{no further action}). If |
4009494e GM |
3115 | you don't provide the separator bar, the last state is used as the DONE |
3116 | state. | |
3117 | @cindex completion, of TODO keywords | |
3118 | With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO | |
3119 | to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may | |
a7808fba | 3120 | also use a numeric prefix argument to quickly select a specific state. For |
4009494e | 3121 | example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY. |
28a16a1b CD |
3122 | Or you can use @kbd{S-left} to go backward through the sequence. If you |
3123 | define many keywords, you can use in-buffer completion | |
3124 | (@pxref{Completion}) or even a special one-key selection scheme | |
3125 | (@pxref{Fast access to TODO states}) to insert these words into the | |
a7808fba | 3126 | buffer. Changing a TODO state can be logged with a timestamp, see |
28a16a1b | 3127 | @ref{Tracking TODO state changes} for more information. |
4009494e GM |
3128 | |
3129 | @node TODO types, Multiple sets in one file, Workflow states, TODO extensions | |
3130 | @subsection TODO keywords as types | |
3131 | @cindex TODO types | |
3132 | @cindex names as TODO keywords | |
3133 | @cindex types as TODO keywords | |
3134 | ||
3135 | The second possibility is to use TODO keywords to indicate different | |
3136 | @emph{types} of action items. For example, you might want to indicate | |
3137 | that items are for ``work'' or ``home''. Or, when you work with several | |
3138 | people on a single project, you might want to assign action items | |
3139 | directly to persons, by using their names as TODO keywords. This would | |
3140 | be set up like this: | |
3141 | ||
3142 | @lisp | |
3143 | (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE"))) | |
3144 | @end lisp | |
3145 | ||
3146 | In this case, different keywords do not indicate a sequence, but rather | |
3147 | different types. So the normal work flow would be to assign a task to a | |
a7808fba CD |
3148 | person, and later to mark it DONE. Org mode supports this style by adapting |
3149 | the workings of the command @kbd{C-c C-t}@footnote{This is also true for the | |
3150 | @kbd{t} command in the timeline and agenda buffers.}. When used several | |
3151 | times in succession, it will still cycle through all names, in order to first | |
3152 | select the right type for a task. But when you return to the item after some | |
3153 | time and execute @kbd{C-c C-t} again, it will switch from any name directly | |
3154 | to DONE. Use prefix arguments or completion to quickly select a specific | |
3155 | name. You can also review the items of a specific TODO type in a sparse tree | |
3156 | by using a numeric prefix to @kbd{C-c C-v}. For example, to see all things | |
3157 | Lucy has to do, you would use @kbd{C-3 C-c C-v}. To collect Lucy's items | |
3158 | from all agenda files into a single buffer, you would use the numeric prefix | |
3159 | argument as well when creating the global TODO list: @kbd{C-3 C-c t}. | |
4009494e | 3160 | |
dbc28aaa | 3161 | @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions |
4009494e | 3162 | @subsection Multiple keyword sets in one file |
a7808fba | 3163 | @cindex TODO keyword sets |
4009494e GM |
3164 | |
3165 | Sometimes you may want to use different sets of TODO keywords in | |
3166 | parallel. For example, you may want to have the basic | |
3167 | @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a | |
3168 | separate state indicating that an item has been canceled (so it is not | |
3169 | DONE, but also does not require action). Your setup would then look | |
3170 | like this: | |
3171 | ||
3172 | @lisp | |
3173 | (setq org-todo-keywords | |
3174 | '((sequence "TODO" "|" "DONE") | |
3175 | (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED") | |
3176 | (sequence "|" "CANCELED"))) | |
3177 | @end lisp | |
3178 | ||
a7808fba | 3179 | The keywords should all be different, this helps Org mode to keep track |
4009494e GM |
3180 | of which subsequence should be used for a given entry. In this setup, |
3181 | @kbd{C-c C-t} only operates within a subsequence, so it switches from | |
3182 | @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to | |
3183 | (nothing) to @code{REPORT}. Therefore you need a mechanism to initially | |
3184 | select the correct sequence. Besides the obvious ways like typing a | |
3185 | keyword or using completion, you may also apply the following commands: | |
3186 | ||
3187 | @table @kbd | |
3188 | @kindex C-S-@key{right} | |
3189 | @kindex C-S-@key{left} | |
3190 | @item C-S-@key{right} | |
3191 | @itemx C-S-@key{left} | |
3192 | These keys jump from one TODO subset to the next. In the above example, | |
3193 | @kbd{C-S-@key{right}} would jump from @code{TODO} or @code{DONE} to | |
3194 | @code{REPORT}, and any of the words in the second row to @code{CANCELED}. | |
3195 | @kindex S-@key{right} | |
3196 | @kindex S-@key{left} | |
3197 | @item S-@key{right} | |
3198 | @itemx S-@key{left} | |
3199 | @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through | |
3200 | @emph{all} keywords from all sets, so for example @kbd{S-@key{<right>}} | |
3201 | would switch from @code{DONE} to @code{REPORT} in the example above. | |
3202 | @end table | |
3203 | ||
dbc28aaa CD |
3204 | @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions |
3205 | @subsection Fast access to TODO states | |
3206 | ||
3207 | If you would like to quickly change an entry to an arbitrary TODO state | |
3208 | instead of cycling through the states, you can set up keys for | |
3209 | single-letter access to the states. This is done by adding the section | |
3210 | key after each keyword, in parenthesis. For example: | |
3211 | ||
3212 | @lisp | |
3213 | (setq org-todo-keywords | |
3214 | '((sequence "TODO(t)" "|" "DONE(d)") | |
3215 | (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)") | |
3216 | (sequence "|" "CANCELED(c)"))) | |
3217 | @end lisp | |
3218 | ||
3219 | If you then press @code{C-u C-c C-t} followed by the selection key, the | |
3220 | entry will be switched to this state. @key{SPC} can be used to remove | |
3221 | any TODO keyword from an entry. Should you like this way of selecting | |
3222 | TODO states a lot, you might want to set the variable | |
3223 | @code{org-use-fast-todo-selection} to @code{t} and make this behavior | |
3224 | the default. Check also the variable | |
3225 | @code{org-fast-tag-selection-include-todo}, it allows to change the TODO | |
28a16a1b CD |
3226 | state through the tags interface (@pxref{Setting tags}), in case you |
3227 | like to mingle the two concepts. | |
dbc28aaa CD |
3228 | |
3229 | @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions | |
4009494e GM |
3230 | @subsection Setting up keywords for individual files |
3231 | @cindex keyword options | |
dbc28aaa | 3232 | @cindex per-file keywords |
4009494e GM |
3233 | |
3234 | It can be very useful to use different aspects of the TODO mechanism in | |
3235 | different files. For file-local settings, you need to add special lines | |
3236 | to the file which set the keywords and interpretation for that file | |
3237 | only. For example, to set one of the two examples discussed above, you | |
3238 | need one of the following lines, starting in column zero anywhere in the | |
3239 | file: | |
3240 | ||
3241 | @example | |
3242 | #+SEQ_TODO: TODO FEEDBACK VERIFY | DONE CANCELED | |
3243 | @end example | |
3244 | or | |
3245 | @example | |
3246 | #+TYP_TODO: Fred Sara Lucy Mike | DONE | |
3247 | @end example | |
3248 | ||
3249 | A setup for using several sets in parallel would be: | |
3250 | ||
3251 | @example | |
3252 | #+SEQ_TODO: TODO | DONE | |
3253 | #+SEQ_TODO: REPORT BUG KNOWNCAUSE | FIXED | |
3254 | #+SEQ_TODO: | CANCELED | |
3255 | @end example | |
3256 | ||
3257 | @cindex completion, of option keywords | |
3258 | @kindex M-@key{TAB} | |
3259 | @noindent To make sure you are using the correct keyword, type | |
3260 | @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion. | |
3261 | ||
3262 | @cindex DONE, final TODO keyword | |
3263 | Remember that the keywords after the vertical bar (or the last keyword | |
3264 | if no bar is there) must always mean that the item is DONE (although you | |
3265 | may use a different word). After changing one of these lines, use | |
3266 | @kbd{C-c C-c} with the cursor still in the line to make the changes | |
a7808fba CD |
3267 | known to Org mode@footnote{Org mode parses these lines only when |
3268 | Org mode is activated after visiting a file. @kbd{C-c C-c} with the | |
3269 | cursor in a line starting with @samp{#+} is simply restarting Org mode | |
4009494e GM |
3270 | for the current buffer.}. |
3271 | ||
dbc28aaa CD |
3272 | @node Faces for TODO keywords, , Per-file keywords, TODO extensions |
3273 | @subsection Faces for TODO keywords | |
3274 | @cindex faces, for TODO keywords | |
3275 | ||
a7808fba | 3276 | Org mode highlights TODO keywords with special faces: @code{org-todo} |
dbc28aaa CD |
3277 | for keywords indicating that an item still has to be acted upon, and |
3278 | @code{org-done} for keywords indicating that an item is finished. If | |
3279 | you are using more than 2 different states, you might want to use | |
3280 | special faces for some of them. This can be done using the variable | |
3281 | @code{org-todo-keyword-faces}. For example: | |
3282 | ||
3283 | @lisp | |
96c8522a | 3284 | @group |
dbc28aaa CD |
3285 | (setq org-todo-keyword-faces |
3286 | '(("TODO" . org-warning) | |
3287 | ("DEFERRED" . shadow) | |
3288 | ("CANCELED" . (:foreground "blue" :weight bold)))) | |
96c8522a | 3289 | @end group |
dbc28aaa CD |
3290 | @end lisp |
3291 | ||
28a16a1b CD |
3292 | While using a list with face properties as shown for CANCELED |
3293 | @emph{should} work, this does not aways seem to be the case. If | |
3294 | necessary, define a special face and use that. | |
3295 | ||
dbc28aaa | 3296 | @page |
a7808fba CD |
3297 | @node Progress logging, Priorities, TODO extensions, TODO Items |
3298 | @section Progress logging | |
dbc28aaa CD |
3299 | @cindex progress logging |
3300 | @cindex logging, of progress | |
3301 | ||
a7808fba | 3302 | Org mode can automatically record a time stamp and possibly a note when |
28a16a1b CD |
3303 | you mark a TODO item as DONE, or even each time you change the state of |
3304 | a TODO item. This system is highly configurable, settings can be on a | |
3305 | per-keyword basis and can be localized to a file or even a subtree. For | |
3306 | information on how to clock working time for a task, see @ref{Clocking | |
3307 | work time}. | |
dbc28aaa CD |
3308 | |
3309 | @menu | |
3310 | * Closing items:: When was this entry marked DONE? | |
3311 | * Tracking TODO state changes:: When did the status change? | |
3312 | @end menu | |
3313 | ||
3314 | @node Closing items, Tracking TODO state changes, Progress logging, Progress logging | |
3315 | @subsection Closing items | |
3316 | ||
28a16a1b CD |
3317 | The most basic logging is to keep track of @emph{when} a certain TODO |
3318 | item was finished. This is achieved with@footnote{The corresponding | |
3319 | in-buffer setting is: @code{#+STARTUP: logdone}}. | |
dbc28aaa CD |
3320 | |
3321 | @lisp | |
28a16a1b | 3322 | (setq org-log-done 'time) |
dbc28aaa CD |
3323 | @end lisp |
3324 | ||
3325 | @noindent | |
28a16a1b CD |
3326 | Then each time you turn an entry from a TODO (not-done) state into any |
3327 | of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted | |
3328 | just after the headline. If you turn the entry back into a TODO item | |
3329 | through further state cycling, that line will be removed again. If you | |
3330 | want to record a note along with the timestamp, use@footnote{The | |
3331 | corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}} | |
dbc28aaa CD |
3332 | |
3333 | @lisp | |
28a16a1b | 3334 | (setq org-log-done 'note) |
dbc28aaa CD |
3335 | @end lisp |
3336 | ||
28a16a1b CD |
3337 | @noindent |
3338 | You will then be prompted for a note, and that note will be stored below | |
3339 | the entry with a @samp{Closing Note} heading. | |
3340 | ||
3341 | In the timeline (@pxref{Timeline}) and in the agenda | |
a7808fba | 3342 | (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to |
28a16a1b CD |
3343 | display the TODO items with a @samp{CLOSED} timestamp on each day, |
3344 | giving you an overview of what has been done. | |
3345 | ||
dbc28aaa CD |
3346 | @node Tracking TODO state changes, , Closing items, Progress logging |
3347 | @subsection Tracking TODO state changes | |
3348 | ||
3349 | When TODO keywords are used as workflow states (@pxref{Workflow | |
3350 | states}), you might want to keep track of when a state change occurred | |
28a16a1b | 3351 | and maybe take a note about this change. Since it is normally too much |
a7808fba | 3352 | to record a note for every state, Org mode expects configuration on a |
28a16a1b CD |
3353 | per-keyword basis for this. This is achieved by adding special markers |
3354 | @samp{!} (for a time stamp) and @samp{@@} (for a note) in parenthesis | |
3355 | after each keyword. For example, with the setting | |
dbc28aaa CD |
3356 | |
3357 | @lisp | |
28a16a1b CD |
3358 | (setq org-todo-keywords |
3359 | '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)"))) | |
dbc28aaa CD |
3360 | @end lisp |
3361 | ||
3362 | @noindent | |
28a16a1b CD |
3363 | you not only define global TODO keywords and fast access keys, but also |
3364 | request that a time is recorded when the entry is turned into | |
a7808fba | 3365 | DONE@footnote{It is possible that Org mode will record two time stamps |
28a16a1b CD |
3366 | when you are using both @code{org-log-done} and state change logging. |
3367 | However, it will never prompt for two notes - if you have configured | |
3368 | both, the state change recording note will take precedence and cancel | |
3369 | the @samp{Closing Note}.}, and that a note is recorded when switching to | |
3370 | WAIT or CANCELED. The setting for WAIT is even more special: The | |
3371 | @samp{!} after the slash means that in addition to the note taken when | |
3372 | entering the state, a time stamp should be recorded when @i{leaving} the | |
3373 | WAIT state, if and only if the @i{target} state does not configure | |
3374 | logging for entering it. So it has no effect when switching from WAIT | |
3375 | to DONE, because DONE is configured to record a timestamp only. But | |
3376 | when switching from WAIT back to TODO, the @samp{/!} in the WAIT | |
3377 | setting now triggers a timestamp even though TODO has no logging | |
3378 | configured. | |
3379 | ||
3380 | You can use the exact same syntax for setting logging preferences local | |
3381 | to a buffer: | |
3382 | @example | |
3383 | #+SEQ_TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@) | |
3384 | @end example | |
3385 | ||
3386 | In order to define logging settings that are local to a subtree or a | |
3387 | single item, define a LOGGING property in this entry. Any non-empty | |
3388 | LOGGING property resets all logging settings to nil. You may then turn | |
3389 | on logging for this specific tree using STARTUP keywords like | |
3390 | @code{lognotedone} or @code{logrepeat}, as well as adding state specific | |
3391 | settings like @code{TODO(!)}. For example | |
3392 | ||
3393 | @example | |
3394 | * TODO Log each state with only a time | |
3395 | :PROPERTIES: | |
3396 | :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!) | |
3397 | :END: | |
3398 | * TODO Only log when switching to WAIT, and when repeating | |
3399 | :PROPERTIES: | |
3400 | :LOGGING: WAIT(@@) logrepeat | |
3401 | :END: | |
3402 | * TODO No logging at all | |
3403 | :PROPERTIES: | |
3404 | :LOGGING: nil | |
3405 | :END: | |
dbc28aaa CD |
3406 | @end example |
3407 | ||
a7808fba | 3408 | @node Priorities, Breaking down tasks, Progress logging, TODO Items |
4009494e GM |
3409 | @section Priorities |
3410 | @cindex priorities | |
3411 | ||
a7808fba | 3412 | If you use Org mode extensively, you may end up enough TODO items that |
dbc28aaa CD |
3413 | it starts to make sense to prioritize them. Prioritizing can be done by |
3414 | placing a @emph{priority cookie} into the headline of a TODO item, like | |
3415 | this | |
4009494e GM |
3416 | |
3417 | @example | |
3418 | *** TODO [#A] Write letter to Sam Fortune | |
3419 | @end example | |
3420 | ||
3421 | @noindent | |
a7808fba | 3422 | By default, Org mode supports three priorities: @samp{A}, @samp{B}, and |
dbc28aaa CD |
3423 | @samp{C}. @samp{A} is the highest priority. An entry without a cookie |
3424 | is treated as priority @samp{B}. Priorities make a difference only in | |
a7808fba CD |
3425 | the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they have |
3426 | no inherent meaning to Org mode. | |
dbc28aaa CD |
3427 | |
3428 | Priorities can be attached to any outline tree entries; they do not need | |
3429 | to be TODO items. | |
4009494e GM |
3430 | |
3431 | @table @kbd | |
3432 | @kindex @kbd{C-c ,} | |
3433 | @item @kbd{C-c ,} | |
3434 | Set the priority of the current headline. The command prompts for a | |
3435 | priority character @samp{A}, @samp{B} or @samp{C}. When you press | |
3436 | @key{SPC} instead, the priority cookie is removed from the headline. | |
3437 | The priorities can also be changed ``remotely'' from the timeline and | |
3438 | agenda buffer with the @kbd{,} command (@pxref{Agenda commands}). | |
3439 | @c | |
3440 | @kindex S-@key{up} | |
3441 | @kindex S-@key{down} | |
3442 | @item S-@key{up} | |
3443 | @itemx S-@key{down} | |
dbc28aaa CD |
3444 | Increase/decrease priority of current headline@footnote{See also the |
3445 | option @code{org-priority-start-cycle-with-default'}.}. Note that these | |
3446 | keys are also used to modify time stamps (@pxref{Creating timestamps}). | |
a7808fba | 3447 | Furthermore, these keys are also used by CUA mode (@pxref{Conflicts}). |
4009494e GM |
3448 | @end table |
3449 | ||
3450 | You can change the range of allowed priorities by setting the variables | |
3451 | @code{org-highest-priority}, @code{org-lowest-priority}, and | |
3452 | @code{org-default-priority}. For an individual buffer, you may set | |
3453 | these values (highest, lowest, default) like this (please make sure that | |
3454 | the highest priority is earlier in the alphabet than the lowest | |
3455 | priority): | |
3456 | ||
3457 | @example | |
3458 | #+PRIORITIES: A C B | |
3459 | @end example | |
3460 | ||
a7808fba | 3461 | @node Breaking down tasks, Checkboxes, Priorities, TODO Items |
4009494e GM |
3462 | @section Breaking tasks down into subtasks |
3463 | @cindex tasks, breaking down | |
3464 | ||
3465 | It is often advisable to break down large tasks into smaller, manageable | |
b349f79f CD |
3466 | subtasks. You can do this by creating an outline tree below a TODO item, |
3467 | with detailed subtasks on the tree@footnote{To keep subtasks out of the | |
3468 | global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep | |
3469 | the overview over the fraction of subtasks that are already completed, insert | |
3470 | either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will | |
3471 | be updates each time the todo status of a child changes. For example: | |
3472 | ||
3473 | @example | |
3474 | * Organize Party [33%] | |
3475 | ** TODO Call people [1/2] | |
3476 | *** TODO Peter | |
3477 | *** DONE Sarah | |
3478 | ** TODO Buy food | |
3479 | ** DONE Talk to neighbor | |
3480 | @end example | |
3481 | ||
3482 | If you would like a TODO entry to automatically change to DONE when all | |
a50253cc | 3483 | children are done, you can use the following setup: |
b349f79f CD |
3484 | |
3485 | @example | |
3486 | (defun org-summary-todo (n-done n-not-done) | |
3487 | "Switch entry to DONE when all subentries are done, to TODO otherwise." | |
3488 | (let (org-log-done org-log-states) ; turn off logging | |
3489 | (org-todo (if (= n-not-done 0) "DONE" "TODO")))) | |
3490 | ||
3491 | (add-hook 'org-after-todo-statistics-hook 'org-summary-todo) | |
3492 | @end example | |
3493 | ||
3494 | ||
3495 | Another possibility is the use of checkboxes to identify (a hierarchy of) a | |
3496 | large number of subtasks (@pxref{Checkboxes}). | |
4009494e GM |
3497 | |
3498 | ||
a7808fba | 3499 | @node Checkboxes, , Breaking down tasks, TODO Items |
4009494e GM |
3500 | @section Checkboxes |
3501 | @cindex checkboxes | |
3502 | ||
dbc28aaa CD |
3503 | Every item in a plain list (@pxref{Plain lists}) can be made into a |
3504 | checkbox by starting it with the string @samp{[ ]}. This feature is | |
a7808fba | 3505 | similar to TODO items (@pxref{TODO Items}), but is more lightweight. |
dbc28aaa CD |
3506 | Checkboxes are not included into the global TODO list, so they are often |
3507 | great to split a task into a number of simple steps. Or you can use | |
3508 | them in a shopping list. To toggle a checkbox, use @kbd{C-c C-c}, or | |
3509 | use the mouse (thanks to Piotr Zielinski's @file{org-mouse.el}). | |
3510 | ||
3511 | Here is an example of a checkbox list. | |
4009494e GM |
3512 | |
3513 | @example | |
28a16a1b CD |
3514 | * TODO Organize party [2/4] |
3515 | - [-] call people [1/3] | |
4009494e GM |
3516 | - [ ] Peter |
3517 | - [X] Sarah | |
3518 | - [ ] Sam | |
3519 | - [X] order food | |
3520 | - [ ] think about what music to play | |
3521 | - [X] talk to the neighbors | |
3522 | @end example | |
3523 | ||
28a16a1b CD |
3524 | Checkboxes work hierarchically, so if a checkbox item has children that |
3525 | are checkboxes, toggling one of the children checkboxes will make the | |
3526 | parent checkbox reflect if none, some, or all of the children are | |
3527 | checked. | |
3528 | ||
4009494e GM |
3529 | @cindex statistics, for checkboxes |
3530 | @cindex checkbox statistics | |
28a16a1b | 3531 | The @samp{[2/4]} and @samp{[1/3]} in the first and second line are |
dbc28aaa CD |
3532 | cookies indicating how many checkboxes present in this entry have been |
3533 | checked off, and the total number of checkboxes are present. This can | |
3534 | give you an idea on how many checkboxes remain, even without opening a | |
3535 | folded entry. The cookies can be placed into a headline or into (the | |
3536 | first line of) a plain list item. Each cookie covers all checkboxes | |
3537 | structurally below the headline/item on which the cookie appear. You | |
3538 | have to insert the cookie yourself by typing either @samp{[/]} or | |
3539 | @samp{[%]}. With @samp{[/]} you get an @samp{n out of m} result, as in | |
3540 | the examples above. With @samp{[%]} you get information about the | |
4009494e | 3541 | percentage of checkboxes checked (in the above example, this would be |
dbc28aaa | 3542 | @samp{[50%]} and @samp{[33%]}, respectively). |
4009494e GM |
3543 | |
3544 | @noindent The following commands work with checkboxes: | |
3545 | ||
3546 | @table @kbd | |
3547 | @kindex C-c C-c | |
3548 | @item C-c C-c | |
a7808fba | 3549 | Toggle checkbox at point. With a prefix argument, set it to @samp{[-]}, |
4009494e GM |
3550 | which is considered to be an intermediate state. |
3551 | @kindex C-c C-x C-b | |
3552 | @item C-c C-x C-b | |
3553 | Toggle checkbox at point. | |
3554 | @itemize @minus | |
3555 | @item | |
3556 | If there is an active region, toggle the first checkbox in the region | |
3557 | and set all remaining boxes to the same status as the first. If you | |
3558 | want to toggle all boxes in the region independently, use a prefix | |
3559 | argument. | |
3560 | @item | |
3561 | If the cursor is in a headline, toggle checkboxes in the region between | |
3562 | this headline and the next (so @emph{not} the entire subtree). | |
3563 | @item | |
3564 | If there is no active region, just toggle the checkbox at point. | |
3565 | @end itemize | |
3566 | @kindex M-S-@key{RET} | |
3567 | @item M-S-@key{RET} | |
3568 | Insert a new item with a checkbox. | |
3569 | This works only if the cursor is already in a plain list item | |
3570 | (@pxref{Plain lists}). | |
3571 | @kindex C-c # | |
3572 | @item C-c # | |
3573 | Update the checkbox statistics in the current outline entry. When | |
3574 | called with a @kbd{C-u} prefix, update the entire file. Checkbox | |
3575 | statistic cookies are updated automatically if you toggle checkboxes | |
3576 | with @kbd{C-c C-c} and make new ones with @kbd{M-S-@key{RET}}. If you | |
3577 | delete boxes or add/change them by hand, use this command to get things | |
a50253cc | 3578 | back into sync. Or simply toggle any checkbox twice with @kbd{C-c C-c}. |
4009494e GM |
3579 | @end table |
3580 | ||
a7808fba | 3581 | @node Tags, Properties and Columns, TODO Items, Top |
4009494e GM |
3582 | @chapter Tags |
3583 | @cindex tags | |
3584 | @cindex headline tagging | |
3585 | @cindex matching, tags | |
3586 | @cindex sparse tree, tag based | |
3587 | ||
dbc28aaa | 3588 | An excellent way to implement labels and contexts for cross-correlating |
a7808fba | 3589 | information is to assign @i{tags} to headlines. Org mode has extensive |
dbc28aaa | 3590 | support for tags. |
4009494e | 3591 | |
dbc28aaa | 3592 | Every headline can contain a list of tags; they occur at the end of the |
96c8522a CD |
3593 | headline. Tags are normal words containing letters, numbers, @samp{_}, and |
3594 | @samp{@@}. Tags must be preceded and followed by a single colon, e.g., | |
3595 | @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}. | |
3596 | Tags will by default get a bold face with the same color as the headline. | |
3597 | You may specify special faces for specific tags using the variable | |
3598 | @code{org-tag-faces}, much in the same way as you can do for TODO keywords | |
3599 | (@pxref{Faces for TODO keywords}). | |
4009494e GM |
3600 | |
3601 | @menu | |
3602 | * Tag inheritance:: Tags use the tree structure of the outline | |
3603 | * Setting tags:: How to assign tags to a headline | |
3604 | * Tag searches:: Searching for combinations of tags | |
3605 | @end menu | |
3606 | ||
3607 | @node Tag inheritance, Setting tags, Tags, Tags | |
3608 | @section Tag inheritance | |
dbc28aaa | 3609 | @cindex tag inheritance |
4009494e GM |
3610 | @cindex inheritance, of tags |
3611 | @cindex sublevels, inclusion into tags match | |
3612 | ||
3613 | @i{Tags} make use of the hierarchical structure of outline trees. If a | |
3614 | heading has a certain tag, all subheadings will inherit the tag as | |
3615 | well. For example, in the list | |
3616 | ||
3617 | @example | |
dbc28aaa CD |
3618 | * Meeting with the French group :work: |
3619 | ** Summary by Frank :boss:notes: | |
3620 | *** TODO Prepare slides for him :action: | |
4009494e GM |
3621 | @end example |
3622 | ||
3623 | @noindent | |
dbc28aaa CD |
3624 | the final heading will have the tags @samp{:work:}, @samp{:boss:}, |
3625 | @samp{:notes:}, and @samp{:action:} even though the final heading is not | |
b349f79f CD |
3626 | explicitly marked with those tags. You can also set tags that all entries in |
3627 | a file should inherit as if these tags would be defined in a hypothetical | |
a50253cc | 3628 | level zero that surrounds the entire file. |
b349f79f CD |
3629 | |
3630 | @example | |
3631 | #+FILETAGS: :Peter:Boss:Secret: | |
3632 | @end example | |
3633 | ||
3634 | @noindent | |
3635 | To limit tag inheritance to specific tags, or to turn it off entirely, use | |
96c8522a CD |
3636 | the variables @code{org-use-tag-inheritance} and |
3637 | @code{org-tags-exclude-from-inheritance}. | |
b349f79f CD |
3638 | |
3639 | When a headline matches during a tags search while tag inheritance is turned | |
96c8522a | 3640 | on, all the sublevels in the same tree will (for a simple match form) match |
07450bee | 3641 | as well@footnote{This is only true if the search does not involve more |
96c8522a CD |
3642 | complex tests including properties (@pxref{Property searches}).}. The list |
3643 | of matches may then become very long. If you only want to see the first tags | |
3644 | match in a subtree, configure the variable | |
3645 | @code{org-tags-match-list-sublevels} (not recommended). | |
4009494e GM |
3646 | |
3647 | @node Setting tags, Tag searches, Tag inheritance, Tags | |
3648 | @section Setting tags | |
3649 | @cindex setting tags | |
3650 | @cindex tags, setting | |
3651 | ||
3652 | @kindex M-@key{TAB} | |
3653 | Tags can simply be typed into the buffer at the end of a headline. | |
3654 | After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is | |
3655 | also a special command for inserting tags: | |
3656 | ||
3657 | @table @kbd | |
71d35b24 CD |
3658 | @kindex C-c C-q |
3659 | @item C-c C-q | |
4009494e | 3660 | @cindex completion, of tags |
a7808fba | 3661 | Enter new tags for the current headline. Org mode will either offer |
4009494e GM |
3662 | completion or a special single-key interface for setting tags, see |
3663 | below. After pressing @key{RET}, the tags will be inserted and aligned | |
3664 | to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all | |
3665 | tags in the current buffer will be aligned to that column, just to make | |
3666 | things look nice. TAGS are automatically realigned after promotion, | |
3667 | demotion, and TODO state changes (@pxref{TODO basics}). | |
71d35b24 CD |
3668 | @kindex C-c C-c |
3669 | @item C-c C-c | |
3670 | When the cursor is in a headline, this does the same as @kbd{C-c C-q}. | |
4009494e GM |
3671 | @end table |
3672 | ||
3673 | Org will support tag insertion based on a @emph{list of tags}. By | |
3674 | default this list is constructed dynamically, containing all tags | |
3675 | currently used in the buffer. You may also globally specify a hard list | |
3676 | of tags with the variable @code{org-tag-alist}. Finally you can set | |
3677 | the default tags for a given file with lines like | |
3678 | ||
3679 | @example | |
dbc28aaa CD |
3680 | #+TAGS: @@work @@home @@tennisclub |
3681 | #+TAGS: laptop car pc sailboat | |
4009494e GM |
3682 | @end example |
3683 | ||
3684 | If you have globally defined your preferred set of tags using the | |
3685 | variable @code{org-tag-alist}, but would like to use a dynamic tag list | |
dbc28aaa | 3686 | in a specific file, add an empty TAGS option line to that file: |
4009494e GM |
3687 | |
3688 | @example | |
3689 | #+TAGS: | |
3690 | @end example | |
3691 | ||
a7808fba CD |
3692 | By default Org mode uses the standard minibuffer completion facilities for |
3693 | entering tags. However, it also implements another, quicker, tag selection | |
3694 | method called @emph{fast tag selection}. This allows you to select and | |
3695 | deselect tags with just a single key press. For this to work well you should | |
3696 | assign unique letters to most of your commonly used tags. You can do this | |
3697 | globally by configuring the variable @code{org-tag-alist} in your | |
3698 | @file{.emacs} file. For example, you may find the need to tag many items in | |
3699 | different files with @samp{:@@home:}. In this case you can set something | |
3700 | like: | |
4009494e GM |
3701 | |
3702 | @lisp | |
dbc28aaa | 3703 | (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l))) |
4009494e GM |
3704 | @end lisp |
3705 | ||
a7808fba CD |
3706 | @noindent If the tag is only relevant to the file you are working on then you |
3707 | can, instead, set the TAGS option line as: | |
4009494e GM |
3708 | |
3709 | @example | |
dbc28aaa | 3710 | #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p) |
4009494e GM |
3711 | @end example |
3712 | ||
3713 | @noindent | |
a7808fba CD |
3714 | You can also group together tags that are mutually exclusive. By using |
3715 | braces, as in: | |
4009494e GM |
3716 | |
3717 | @example | |
dbc28aaa | 3718 | #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p) |
4009494e GM |
3719 | @end example |
3720 | ||
dbc28aaa | 3721 | @noindent you indicate that at most one of @samp{@@work}, @samp{@@home}, |
a7808fba | 3722 | and @samp{@@tennisclub} should be selected. Multiple such groups are allowed. |
4009494e GM |
3723 | |
3724 | @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of | |
3725 | these lines to activate any changes. | |
3726 | ||
a7808fba CD |
3727 | @noindent |
3728 | To set these mutually exclusive groups in the variable @code{org-mode-alist} | |
3729 | you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead | |
3730 | of the braces. The previous example would be set globally by the following | |
3731 | configuration: | |
3732 | ||
3733 | @lisp | |
3734 | (setq org-tag-alist '((:startgroup . nil) | |
3735 | ("@@work" . ?w) ("@@home" . ?h) | |
3736 | ("@@tennisclub" . ?t) | |
3737 | (:endgroup . nil) | |
3738 | ("laptop" . ?l) ("pc" . ?p))) | |
3739 | @end lisp | |
3740 | ||
3741 | If at least one tag has a selection key then pressing @kbd{C-c C-c} will | |
3742 | automatically present you with a special interface, listing inherited tags, | |
3743 | the tags of the current headline, and a list of all valid tags with | |
3744 | corresponding keys@footnote{Keys will automatically be assigned to tags which | |
3745 | have no configured keys.}. In this interface, you can use the following | |
3746 | keys: | |
4009494e GM |
3747 | |
3748 | @table @kbd | |
3749 | @item a-z... | |
3750 | Pressing keys assigned to tags will add or remove them from the list of | |
3751 | tags in the current line. Selecting a tag in a group of mutually | |
3752 | exclusive tags will turn off any other tags from that group. | |
3753 | @kindex @key{TAB} | |
3754 | @item @key{TAB} | |
3755 | Enter a tag in the minibuffer, even if the tag is not in the predefined | |
3756 | list. You will be able to complete on all tags present in the buffer. | |
3757 | @kindex @key{SPC} | |
3758 | @item @key{SPC} | |
3759 | Clear all tags for this line. | |
3760 | @kindex @key{RET} | |
3761 | @item @key{RET} | |
3762 | Accept the modified set. | |
3763 | @item C-g | |
3764 | Abort without installing changes. | |
3765 | @item q | |
3766 | If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}. | |
3767 | @item ! | |
3768 | Turn off groups of mutually exclusive tags. Use this to (as an | |
3769 | exception) assign several tags from such a group. | |
3770 | @item C-c | |
3771 | Toggle auto-exit after the next change (see below). | |
3772 | If you are using expert mode, the first @kbd{C-c} will display the | |
3773 | selection window. | |
3774 | @end table | |
3775 | ||
3776 | @noindent | |
3777 | This method lets you assign tags to a headline with very few keys. With | |
dbc28aaa CD |
3778 | the above setup, you could clear the current tags and set @samp{@@home}, |
3779 | @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c | |
3780 | C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to | |
3781 | @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or | |
4009494e GM |
3782 | alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag |
3783 | @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h | |
3784 | @key{RET} @key{RET}}. | |
3785 | ||
a7808fba | 3786 | If you find that most of the time, you need only a single key press to |
4009494e GM |
3787 | modify your list of tags, set the variable |
3788 | @code{org-fast-tag-selection-single-key}. Then you no longer have to | |
3789 | press @key{RET} to exit fast tag selection - it will immediately exit | |
3790 | after the first change. If you then occasionally need more keys, press | |
3791 | @kbd{C-c} to turn off auto-exit for the current tag selection process | |
3792 | (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c | |
3793 | C-c}). If you set the variable to the value @code{expert}, the special | |
3794 | window is not even shown for single-key tag selection, it comes up only | |
3795 | when you press an extra @kbd{C-c}. | |
3796 | ||
3797 | @node Tag searches, , Setting tags, Tags | |
3798 | @section Tag searches | |
3799 | @cindex tag searches | |
3800 | @cindex searching for tags | |
3801 | ||
dbc28aaa | 3802 | Once a system of tags has been set up, it can be used to collect related |
4009494e GM |
3803 | information into special lists. |
3804 | ||
3805 | @table @kbd | |
3806 | @kindex C-c \ | |
dbc28aaa | 3807 | @kindex C-c / T |
4009494e | 3808 | @item C-c \ |
dbc28aaa | 3809 | @itemx C-c / T |
4009494e GM |
3810 | Create a sparse tree with all headlines matching a tags search. With a |
3811 | @kbd{C-u} prefix argument, ignore headlines that are not a TODO line. | |
3812 | @kindex C-c a m | |
3813 | @item C-c a m | |
3814 | Create a global list of tag matches from all agenda files. | |
3815 | @xref{Matching tags and properties}. | |
3816 | @kindex C-c a M | |
3817 | @item C-c a M | |
3818 | Create a global list of tag matches from all agenda files, but check | |
3819 | only TODO items and force checking subitems (see variable | |
3820 | @code{org-tags-match-list-sublevels}). | |
3821 | @end table | |
3822 | ||
3823 | @cindex Boolean logic, for tag searches | |
3824 | A @i{tags} search string can use Boolean operators @samp{&} for AND and | |
3825 | @samp{|} for OR. @samp{&} binds more strongly than @samp{|}. | |
3826 | Parenthesis are currently not implemented. A tag may also be preceded | |
3827 | by @samp{-}, to select against it, and @samp{+} is syntactic sugar for | |
3828 | positive selection. The AND operator @samp{&} is optional when @samp{+} | |
3829 | or @samp{-} is present. Examples: | |
3830 | ||
3831 | @table @samp | |
dbc28aaa CD |
3832 | @item +work-boss |
3833 | Select headlines tagged @samp{:work:}, but discard those also tagged | |
3834 | @samp{:boss:}. | |
3835 | @item work|laptop | |
3836 | Selects lines tagged @samp{:work:} or @samp{:laptop:}. | |
3837 | @item work|laptop&night | |
3838 | Like before, but require the @samp{:laptop:} lines to be tagged also | |
3839 | @samp{:night:}. | |
4009494e GM |
3840 | @end table |
3841 | ||
3842 | @cindex TODO keyword matching, with tags search | |
e45e3595 CD |
3843 | You may also test for TODO keywords (@pxref{TODO extensions}) and properties |
3844 | (@pxref{Properties and Columns}) at the same time as matching tags. For a | |
3845 | guide on how to match properties, see @ref{Property searches}. To match a | |
3846 | specific TODO keyword, include an expression like @samp{+TODO="NEXT"} as one | |
3847 | of the terms in a tags search. | |
3848 | ||
3849 | There is also the possibility to end the tags part of the match (which may | |
3850 | include several terms connected with @samp{|}) with a @samp{/} and then | |
3851 | specify a Boolean expression just for TODO keywords. The syntax is then | |
3852 | similar to the tag matches, but should be applied with consideration: For | |
3853 | example, a positive selection on several TODO keywords can not meaningfully | |
3854 | be combined with boolean AND. However, @emph{negative selection} combined | |
3855 | with AND can be meaningful. To make sure that only lines are checked that | |
3856 | actually have any TODO keyword (resulting in a speed-up), use @kbd{C-c a M}, | |
3857 | or equivalently start the TODO part after the slash with @samp{!}. Examples: | |
4009494e GM |
3858 | |
3859 | @table @samp | |
e45e3595 | 3860 | @item work+TODO="WAITING" |
dbc28aaa | 3861 | Select @samp{:work:}-tagged TODO lines with the specific TODO |
4009494e | 3862 | keyword @samp{WAITING}. |
e45e3595 CD |
3863 | @item work+TODO="WAITING"|home+TODO="WAITING" |
3864 | Waiting tasks both at work and at home. | |
3865 | @item work/WAITING | |
3866 | Same as the first example. | |
dbc28aaa CD |
3867 | @item work/!-WAITING-NEXT |
3868 | Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING} | |
4009494e | 3869 | nor @samp{NEXT} |
e45e3595 | 3870 | @item work/!+WAITING|+NEXT |
dbc28aaa | 3871 | Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or |
4009494e GM |
3872 | @samp{NEXT}. |
3873 | @end table | |
3874 | ||
3875 | @cindex regular expressions, with tags search | |
3876 | Any element of the tag/todo match can be a regular expression - in this | |
3877 | case it must be enclosed in curly braces. For example, | |
dbc28aaa | 3878 | @samp{work+@{^boss.*@}} matches headlines that contain the tag |
e45e3595 CD |
3879 | @samp{:work:} and any tag @i{starting} with @samp{boss}. You may also use a |
3880 | regular expression in @samp{TODO=@{^W@}} which would match TODO keywords | |
3881 | starting with the letter @samp{W}. | |
dbc28aaa CD |
3882 | |
3883 | @cindex level, require for tags/property match | |
3884 | @cindex category, require for tags/property match | |
3885 | You can also require a headline to be of a certain level or category, by | |
3886 | writing instead of any TAG an expression like @samp{LEVEL=3} or | |
3887 | @samp{CATEGORY="work"}, respectively. For example, a search | |
3888 | @samp{+LEVEL=3+boss/-DONE} lists all level three headlines that have the | |
a7808fba | 3889 | tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE. |
dbc28aaa | 3890 | |
e45e3595 CD |
3891 | Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any |
3892 | other properties will slow down the search. | |
3893 | ||
a7808fba | 3894 | @node Properties and Columns, Dates and Times, Tags, Top |
4009494e GM |
3895 | @chapter Properties and Columns |
3896 | @cindex properties | |
3897 | ||
3898 | Properties are a set of key-value pairs associated with an entry. There | |
a7808fba | 3899 | are two main applications for properties in Org mode. First, properties |
dbc28aaa | 3900 | are like tags, but with a value. Second, you can use properties to |
a7808fba | 3901 | implement (very basic) database capabilities in an Org buffer. For |
dbc28aaa CD |
3902 | an example of the first application, imagine maintaining a file where |
3903 | you document bugs and plan releases of a piece of software. Instead of | |
3904 | using tags like @code{:release_1:}, @code{:release_2:}, one can use a | |
3905 | property, say @code{:Release:}, that in different subtrees has different | |
3906 | values, such as @code{1.0} or @code{2.0}. For an example of the second | |
a50253cc | 3907 | application of properties, imagine keeping track of your music CDs, |
dbc28aaa CD |
3908 | where properties could be things such as the album artist, date of |
3909 | release, number of tracks, and so on. | |
3910 | ||
28a16a1b | 3911 | Properties can be conveniently edited and viewed in column view |
dbc28aaa CD |
3912 | (@pxref{Column view}). |
3913 | ||
4009494e GM |
3914 | @menu |
3915 | * Property syntax:: How properties are spelled out | |
a7808fba | 3916 | * Special properties:: Access to other Org mode features |
4009494e | 3917 | * Property searches:: Matching property values |
dbc28aaa | 3918 | * Property inheritance:: Passing values down the tree |
4009494e GM |
3919 | * Column view:: Tabular viewing and editing |
3920 | * Property API:: Properties for Lisp programmers | |
3921 | @end menu | |
3922 | ||
a7808fba CD |
3923 | @node Property syntax, Special properties, Properties and Columns, Properties and Columns |
3924 | @section Property syntax | |
4009494e GM |
3925 | @cindex property syntax |
3926 | @cindex drawer, for properties | |
3927 | ||
3928 | Properties are key-value pairs. They need to be inserted into a special | |
3929 | drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property | |
3930 | is specified on a single line, with the key (surrounded by colons) | |
3931 | first, and the value after it. Here is an example: | |
3932 | ||
3933 | @example | |
3934 | * CD collection | |
3935 | ** Classic | |
3936 | *** Goldberg Variations | |
3937 | :PROPERTIES: | |
3938 | :Title: Goldberg Variations | |
3939 | :Composer: J.S. Bach | |
28a16a1b | 3940 | :Artist: Glen Gould |
4009494e GM |
3941 | :Publisher: Deutsche Grammphon |
3942 | :NDisks: 1 | |
28a16a1b | 3943 | :END: |
4009494e GM |
3944 | @end example |
3945 | ||
dbc28aaa CD |
3946 | You may define the allowed values for a particular property @samp{:Xyz:} |
3947 | by setting a property @samp{:Xyz_ALL:}. This special property is | |
4009494e GM |
3948 | @emph{inherited}, so if you set it in a level 1 entry, it will apply to |
3949 | the entire tree. When allowed values are defined, setting the | |
3950 | corresponding property becomes easier and is less prone to typing | |
3951 | errors. For the example with the CD collection, we can predefine | |
3952 | publishers and the number of disks in a box like this: | |
3953 | ||
3954 | @example | |
3955 | * CD collection | |
3956 | :PROPERTIES: | |
3957 | :NDisks_ALL: 1 2 3 4 | |
64fb801f | 3958 | :Publisher_ALL: "Deutsche Grammophon" Philips EMI |
4009494e GM |
3959 | :END: |
3960 | @end example | |
3961 | ||
3962 | If you want to set properties that can be inherited by any entry in a | |
3963 | file, use a line like | |
3964 | ||
3965 | @example | |
3966 | #+PROPERTY: NDisks_ALL 1 2 3 4 | |
3967 | @end example | |
3968 | ||
3969 | Property values set with the global variable | |
3970 | @code{org-global-properties} can be inherited by all entries in all | |
a7808fba | 3971 | Org files. |
4009494e GM |
3972 | |
3973 | @noindent | |
3974 | The following commands help to work with properties: | |
3975 | ||
3976 | @table @kbd | |
3977 | @kindex M-@key{TAB} | |
3978 | @item M-@key{TAB} | |
3979 | After an initial colon in a line, complete property keys. All keys used | |
3980 | in the current file will be offered as possible completions. | |
dbc28aaa CD |
3981 | @kindex C-c C-x p |
3982 | @item C-c C-x p | |
3983 | Set a property. This prompts for a property name and a value. If | |
3984 | necessary, the property drawer is created as well. | |
4009494e GM |
3985 | @item M-x org-insert-property-drawer |
3986 | Insert a property drawer into the current entry. The drawer will be | |
3987 | inserted early in the entry, but after the lines with planning | |
3988 | information like deadlines. | |
3989 | @kindex C-c C-c | |
3990 | @item C-c C-c | |
3991 | With the cursor in a property drawer, this executes property commands. | |
3992 | @item C-c C-c s | |
3993 | Set a property in the current entry. Both the property and the value | |
3994 | can be inserted using completion. | |
3995 | @kindex S-@key{right} | |
3996 | @kindex S-@key{left} | |
3997 | @item S-@key{left}/@key{right} | |
3998 | Switch property at point to the next/previous allowed value. | |
3999 | @item C-c C-c d | |
4000 | Remove a property from the current entry. | |
4001 | @item C-c C-c D | |
4002 | Globally remove a property, from all entries in the current file. | |
dbc28aaa CD |
4003 | @item C-c C-c c |
4004 | Compute the property at point, using the operator and scope from the | |
4005 | nearest column format definition. | |
4009494e GM |
4006 | @end table |
4007 | ||
a7808fba CD |
4008 | @node Special properties, Property searches, Property syntax, Properties and Columns |
4009 | @section Special properties | |
4009494e GM |
4010 | @cindex properties, special |
4011 | ||
a7808fba | 4012 | Special properties provide alternative access method to Org mode |
4009494e GM |
4013 | features discussed in the previous chapters, like the TODO state or the |
4014 | priority of an entry. This interface exists so that you can include | |
dbc28aaa CD |
4015 | these states into columns view (@pxref{Column view}), or to use them in |
4016 | queries. The following property names are special and should not be | |
4017 | used as keys in the properties drawer: | |
4009494e GM |
4018 | |
4019 | @example | |
4020 | TODO @r{The TODO keyword of the entry.} | |
4021 | TAGS @r{The tags defined directly in the headline.} | |
4022 | ALLTAGS @r{All tags, including inherited ones.} | |
4023 | PRIORITY @r{The priority of the entry, a string with a single letter.} | |
4024 | DEADLINE @r{The deadline time string, without the angular brackets.} | |
4025 | SCHEDULED @r{The scheduling time stamp, without the angular brackets.} | |
dbc28aaa CD |
4026 | TIMESTAMP @r{The first keyword-less time stamp in the entry.} |
4027 | TIMESTAMP_IA @r{The first inactive time stamp in the entry.} | |
4028 | CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}} | |
4029 | @r{must be run first to compute the values.} | |
4009494e GM |
4030 | @end example |
4031 | ||
a7808fba | 4032 | @node Property searches, Property inheritance, Special properties, Properties and Columns |
4009494e GM |
4033 | @section Property searches |
4034 | @cindex properties, searching | |
dbc28aaa | 4035 | @cindex searching, of properties |
4009494e | 4036 | |
a7808fba CD |
4037 | To create sparse trees and special lists with selection based on properties, |
4038 | the same commands are used as for tag searches (@pxref{Tag searches}), and | |
4039 | the same logic applies. For example, here is a search string: | |
4009494e GM |
4040 | |
4041 | @example | |
44ce9197 CD |
4042 | +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \ |
4043 | +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>" | |
4009494e GM |
4044 | @end example |
4045 | ||
4046 | @noindent | |
44ce9197 CD |
4047 | The type of comparison will depend on how the comparison value is written: |
4048 | @itemize @minus | |
4049 | @item | |
a7808fba CD |
4050 | If the comparison value is a plain number, a numerical comparison is done, |
4051 | and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=}, | |
44ce9197 CD |
4052 | @samp{>=}, and @samp{<>}. |
4053 | @item | |
4054 | If the comparison value is enclosed in double | |
96c8522a | 4055 | quotes, a string comparison is done, and the same operators are allowed. |
44ce9197 CD |
4056 | @item |
4057 | If the comparison value is enclosed in double quotes @emph{and} angular | |
4058 | brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are | |
96c8522a CD |
4059 | assumed to be date/time specifications in the standard Org way, and the |
4060 | comparison will be done accordingly. Special values that will be recognized | |
4061 | are @code{"<now>"} for now (including time), and @code{"<today>"}, and | |
4062 | @code{"<tomorrow>"} for these days at 0:00 hours, i.e. without a time | |
4063 | specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units | |
4064 | @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year, | |
4065 | respectively, can be used. | |
44ce9197 CD |
4066 | @item |
4067 | If the comparison value is enclosed | |
4068 | in curly braces, a regexp match is performed, with @samp{=} meaning that the | |
4069 | regexp matches the property value, and @samp{<>} meaning that it does not | |
96c8522a | 4070 | match. |
44ce9197 CD |
4071 | @end itemize |
4072 | ||
4073 | So the search string in the example finds entries tagged @samp{:work:} but | |
4074 | not @samp{:boss:}, which also have a priority value @samp{A}, a | |
4075 | @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort} | |
4076 | property that is numerically smaller than 2, a @samp{:With:} property that is | |
4077 | matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled | |
4078 | on or after October 11, 2008. | |
a7808fba CD |
4079 | |
4080 | You can configure Org mode to use property inheritance during a search, but | |
4081 | beware that this can slow down searches considerably. See @ref{Property | |
4082 | inheritance} for details. | |
dbc28aaa CD |
4083 | |
4084 | There is also a special command for creating sparse trees based on a | |
4085 | single property: | |
4086 | ||
4087 | @table @kbd | |
4088 | @kindex C-c / p | |
4089 | @item C-c / p | |
4090 | Create a sparse tree based on the value of a property. This first | |
4091 | prompts for the name of a property, and then for a value. A sparse tree | |
4092 | is created with all entries that define this property with the given | |
4093 | value. If you enclose the value into curly braces, it is interpreted as | |
4094 | a regular expression and matched against the property values. | |
4095 | @end table | |
4096 | ||
a7808fba | 4097 | @node Property inheritance, Column view, Property searches, Properties and Columns |
dbc28aaa | 4098 | @section Property Inheritance |
a7808fba CD |
4099 | @cindex properties, inheritance |
4100 | @cindex inheritance, of properties | |
dbc28aaa | 4101 | |
a7808fba | 4102 | The outline structure of Org mode documents lends itself for an |
dbc28aaa | 4103 | inheritance model of properties: If the parent in a tree has a certain |
a7808fba | 4104 | property, the children can inherit this property. Org mode does not |
dbc28aaa CD |
4105 | turn this on by default, because it can slow down property searches |
4106 | significantly and is often not needed. However, if you find inheritance | |
4107 | useful, you can turn it on by setting the variable | |
4108 | @code{org-use-property-inheritance}. It may be set to @code{t}, to make | |
a7808fba CD |
4109 | all properties inherited from the parent, to a list of properties |
4110 | that should be inherited, or to a regular expression that matches | |
4111 | inherited properties. | |
dbc28aaa | 4112 | |
a7808fba | 4113 | Org mode has a few properties for which inheritance is hard-coded, at |
dbc28aaa CD |
4114 | least for the special applications for which they are used: |
4115 | ||
4116 | @table @code | |
4117 | @item COLUMNS | |
4118 | The @code{:COLUMNS:} property defines the format of column view | |
4119 | (@pxref{Column view}). It is inherited in the sense that the level | |
4120 | where a @code{:COLUMNS:} property is defined is used as the starting | |
4121 | point for a column view table, independently of the location in the | |
4122 | subtree from where columns view is turned on. | |
4123 | @item CATEGORY | |
4124 | For agenda view, a category set through a @code{:CATEGORY:} property | |
4125 | applies to the entire subtree. | |
4126 | @item ARCHIVE | |
4127 | For archiving, the @code{:ARCHIVE:} property may define the archive | |
4128 | location for the entire subtree (@pxref{Moving subtrees}). | |
28a16a1b CD |
4129 | @item LOGGING |
4130 | The LOGGING property may define logging settings for an entry or a | |
4131 | subtree (@pxref{Tracking TODO state changes}). | |
dbc28aaa CD |
4132 | @end table |
4133 | ||
a7808fba CD |
4134 | @node Column view, Property API, Property inheritance, Properties and Columns |
4135 | @section Column view | |
4009494e GM |
4136 | |
4137 | A great way to view and edit properties in an outline tree is | |
4138 | @emph{column view}. In column view, each outline item is turned into a | |
4139 | table row. Columns in this table provide access to properties of the | |
a7808fba | 4140 | entries. Org mode implements columns by overlaying a tabular structure |
4009494e GM |
4141 | over the headline of each item. While the headlines have been turned |
4142 | into a table row, you can still change the visibility of the outline | |
4143 | tree. For example, you get a compact table by switching to CONTENTS | |
4144 | view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view | |
4145 | is active), but you can still open, read, and edit the entry below each | |
4146 | headline. Or, you can switch to column view after executing a sparse | |
4147 | tree command and in this way get a table only for the selected items. | |
a7808fba | 4148 | Column view also works in agenda buffers (@pxref{Agenda Views}) where |
4009494e GM |
4149 | queries have collected selected items, possibly from a number of files. |
4150 | ||
4151 | @menu | |
4152 | * Defining columns:: The COLUMNS format property | |
4153 | * Using column view:: How to create and use column view | |
a7808fba | 4154 | * Capturing column view:: A dynamic block for column view |
4009494e GM |
4155 | @end menu |
4156 | ||
4157 | @node Defining columns, Using column view, Column view, Column view | |
a7808fba | 4158 | @subsection Defining columns |
4009494e GM |
4159 | @cindex column view, for properties |
4160 | @cindex properties, column view | |
4161 | ||
4162 | Setting up a column view first requires defining the columns. This is | |
4163 | done by defining a column format line. | |
4164 | ||
4165 | @menu | |
4166 | * Scope of column definitions:: Where defined, where valid? | |
4167 | * Column attributes:: Appearance and content of a column | |
4168 | @end menu | |
4169 | ||
4170 | @node Scope of column definitions, Column attributes, Defining columns, Defining columns | |
4171 | @subsubsection Scope of column definitions | |
4172 | ||
4173 | To define a column format for an entire file, use a line like | |
4174 | ||
4175 | @example | |
4176 | #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO | |
4177 | @end example | |
4178 | ||
dbc28aaa CD |
4179 | To specify a format that only applies to a specific tree, add a |
4180 | @code{:COLUMNS:} property to the top node of that tree, for example: | |
4181 | ||
4009494e GM |
4182 | @example |
4183 | ** Top node for columns view | |
4184 | :PROPERTIES: | |
4185 | :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO | |
4186 | :END: | |
4187 | @end example | |
4188 | ||
dbc28aaa | 4189 | If a @code{:COLUMNS:} property is present in an entry, it defines columns |
4009494e GM |
4190 | for the entry itself, and for the entire subtree below it. Since the |
4191 | column definition is part of the hierarchical structure of the document, | |
4192 | you can define columns on level 1 that are general enough for all | |
4193 | sublevels, and more specific columns further down, when you edit a | |
4194 | deeper part of the tree. | |
4195 | ||
4196 | @node Column attributes, , Scope of column definitions, Defining columns | |
4197 | @subsubsection Column attributes | |
4198 | A column definition sets the attributes of a column. The general | |
4199 | definition looks like this: | |
4200 | ||
4201 | @example | |
4202 | %[width]property[(title)][@{summary-type@}] | |
4203 | @end example | |
4204 | ||
4205 | @noindent | |
4206 | Except for the percent sign and the property name, all items are | |
4207 | optional. The individual parts have the following meaning: | |
4208 | ||
4209 | @example | |
4210 | width @r{An integer specifying the width of the column in characters.} | |
4211 | @r{If omitted, the width will be determined automatically.} | |
4212 | property @r{The property that should be edited in this column.} | |
4213 | (title) @r{The header text for the column. If omitted, the} | |
4214 | @r{property name is used.} | |
4215 | @{summary-type@} @r{The summary type. If specified, the column values for} | |
4216 | @r{parent nodes are computed from the children.} | |
4217 | @r{Supported summary types are:} | |
dbc28aaa CD |
4218 | @{+@} @r{Sum numbers in this column.} |
4219 | @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.} | |
4220 | @{$@} @r{Currency, short for @samp{+;%.2f}.} | |
4221 | @{:@} @r{Sum times, HH:MM:SS, plain numbers are hours.} | |
4222 | @{X@} @r{Checkbox status, [X] if all children are [X].} | |
28a16a1b CD |
4223 | @{X/@} @r{Checkbox status, [n/m].} |
4224 | @{X%@} @r{Checkbox status, [n%].} | |
4009494e GM |
4225 | @end example |
4226 | ||
4227 | @noindent | |
4228 | Here is an example for a complete columns definition, along with allowed | |
4229 | values. | |
4230 | ||
4231 | @example | |
dbc28aaa CD |
4232 | :COLUMNS: %20ITEM %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.} |
4233 | %10Time_Estimate@{:@} %CLOCKSUM | |
4009494e GM |
4234 | :Owner_ALL: Tammy Mark Karl Lisa Don |
4235 | :Status_ALL: "In progress" "Not started yet" "Finished" "" | |
4236 | :Approved_ALL: "[ ]" "[X]" | |
4237 | @end example | |
4238 | ||
4239 | The first column, @samp{%25ITEM}, means the first 25 characters of the | |
4240 | item itself, i.e. of the headline. You probably always should start the | |
28a16a1b CD |
4241 | column definition with the @samp{ITEM} specifier. The other specifiers |
4242 | create columns @samp{Owner} with a list of names as allowed values, for | |
4009494e GM |
4243 | @samp{Status} with four different possible values, and for a checkbox |
4244 | field @samp{Approved}. When no width is given after the @samp{%} | |
4245 | character, the column will be exactly as wide as it needs to be in order | |
4246 | to fully display all values. The @samp{Approved} column does have a | |
4247 | modified title (@samp{Approved?}, with a question mark). Summaries will | |
dbc28aaa | 4248 | be created for the @samp{Time_Estimate} column by adding time duration |
4009494e | 4249 | expressions like HH:MM, and for the @samp{Approved} column, by providing |
dbc28aaa CD |
4250 | an @samp{[X]} status if all children have been checked. The |
4251 | @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals | |
4252 | in the subtree. | |
4009494e | 4253 | |
a7808fba CD |
4254 | @node Using column view, Capturing column view, Defining columns, Column view |
4255 | @subsection Using column view | |
4009494e GM |
4256 | |
4257 | @table @kbd | |
4258 | @tsubheading{Turning column view on and off} | |
4259 | @kindex C-c C-x C-c | |
4260 | @item C-c C-x C-c | |
4261 | Create the column view for the local environment. This command searches | |
dbc28aaa | 4262 | the hierarchy, up from point, for a @code{:COLUMNS:} property that defines |
4009494e | 4263 | a format. When one is found, the column view table is established for |
dbc28aaa | 4264 | the entire tree, starting from the entry that contains the @code{:COLUMNS:} |
4009494e GM |
4265 | property. If none is found, the format is taken from the @code{#+COLUMNS} |
4266 | line or from the variable @code{org-columns-default-format}, and column | |
4267 | view is established for the current entry and its subtree. | |
28a16a1b CD |
4268 | @kindex r |
4269 | @item r | |
a7808fba | 4270 | Recreate the column view, to include recent changes made in the buffer. |
28a16a1b CD |
4271 | @kindex g |
4272 | @item g | |
4273 | Same as @kbd{r}. | |
4009494e GM |
4274 | @kindex q |
4275 | @item q | |
4276 | Exit column view. | |
4277 | @tsubheading{Editing values} | |
4278 | @item @key{left} @key{right} @key{up} @key{down} | |
4279 | Move through the column view from field to field. | |
4280 | @kindex S-@key{left} | |
4281 | @kindex S-@key{right} | |
4282 | @item S-@key{left}/@key{right} | |
4283 | Switch to the next/previous allowed value of the field. For this, you | |
4284 | have to have specified allowed values for a property. | |
b349f79f CD |
4285 | @item 1..9,0 |
4286 | Directly select the nth allowed value, @kbd{0} selects the 10th value. | |
4009494e GM |
4287 | @kindex n |
4288 | @kindex p | |
4289 | @itemx n / p | |
4290 | Same as @kbd{S-@key{left}/@key{right}} | |
4291 | @kindex e | |
4292 | @item e | |
4293 | Edit the property at point. For the special properties, this will | |
4294 | invoke the same interface that you normally use to change that | |
4295 | property. For example, when editing a TAGS property, the tag completion | |
4296 | or fast selection interface will pop up. | |
dbc28aaa CD |
4297 | @kindex C-c C-c |
4298 | @item C-c C-c | |
4299 | When there is a checkbox at point, toggle it. | |
4009494e GM |
4300 | @kindex v |
4301 | @item v | |
4302 | View the full value of this property. This is useful if the width of | |
4303 | the column is smaller than that of the value. | |
4304 | @kindex a | |
4305 | @item a | |
4306 | Edit the list of allowed values for this property. If the list is found | |
4307 | in the hierarchy, the modified values is stored there. If no list is | |
4308 | found, the new value is stored in the first entry that is part of the | |
4309 | current column view. | |
4310 | @tsubheading{Modifying the table structure} | |
4311 | @kindex < | |
4312 | @kindex > | |
4313 | @item < / > | |
4314 | Make the column narrower/wider by one character. | |
4315 | @kindex S-M-@key{right} | |
4316 | @item S-M-@key{right} | |
864c9740 | 4317 | Insert a new column, to the left of the current column. |
4009494e GM |
4318 | @kindex S-M-@key{left} |
4319 | @item S-M-@key{left} | |
4320 | Delete the current column. | |
4321 | @end table | |
4322 | ||
a7808fba CD |
4323 | @node Capturing column view, , Using column view, Column view |
4324 | @subsection Capturing column view | |
dbc28aaa CD |
4325 | |
4326 | Since column view is just an overlay over a buffer, it cannot be | |
4327 | exported or printed directly. If you want to capture a column view, use | |
a7808fba | 4328 | this @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame |
28a16a1b | 4329 | of this block looks like this: |
dbc28aaa | 4330 | |
b349f79f | 4331 | @cindex #+BEGIN: columnview |
dbc28aaa CD |
4332 | @example |
4333 | * The column view | |
4334 | #+BEGIN: columnview :hlines 1 :id "label" | |
4335 | ||
4336 | #+END: | |
4337 | @end example | |
4338 | ||
4339 | @noindent This dynamic block has the following parameters: | |
4340 | ||
4341 | @table @code | |
4342 | @item :id | |
4343 | This is most important parameter. Column view is a feature that is | |
4344 | often localized to a certain (sub)tree, and the capture block might be | |
4345 | in a different location in the file. To identify the tree whose view to | |
4346 | capture, you can use 3 values: | |
4347 | @example | |
4348 | local @r{use the tree in which the capture block is located} | |
4349 | global @r{make a global view, including all headings in the file} | |
55e0839d CD |
4350 | "file:path-to-file" |
4351 | @r{run column view at the top of this file} | |
4352 | "ID" @r{call column view in the tree that has an @code{:ID:}} | |
b349f79f CD |
4353 | @r{property with the value @i{label}. You can use} |
4354 | @r{@kbd{M-x org-id-copy} to create a globally unique ID for} | |
4355 | @r{the current entry and copy it to the kill-ring.} | |
dbc28aaa CD |
4356 | @end example |
4357 | @item :hlines | |
4358 | When @code{t}, insert a hline after every line. When a number N, insert | |
4359 | a hline before each headline with level @code{<= N}. | |
4360 | @item :vlines | |
4361 | When set to @code{t}, enforce column groups to get vertical lines. | |
28a16a1b CD |
4362 | @item :maxlevel |
4363 | When set to a number, don't capture entries below this level. | |
4364 | @item :skip-empty-rows | |
4365 | When set to @code{t}, skip row where the only non-empty specifier of the | |
4366 | column view is @code{ITEM}. | |
4367 | ||
dbc28aaa CD |
4368 | @end table |
4369 | ||
4370 | @noindent | |
4371 | The following commands insert or update the dynamic block: | |
4372 | ||
4373 | @table @kbd | |
864c9740 CD |
4374 | @kindex C-c C-x i |
4375 | @item C-c C-x i | |
dbc28aaa CD |
4376 | Insert a dynamic block capturing a column view. You will be prompted |
4377 | for the scope or id of the view. | |
4378 | @kindex C-c C-c | |
4379 | @item C-c C-c | |
4380 | @kindex C-c C-x C-u | |
4381 | @itemx C-c C-x C-u | |
4382 | Update dynamical block at point. The cursor needs to be in the | |
4383 | @code{#+BEGIN} line of the dynamic block. | |
4384 | @kindex C-u C-c C-x C-u | |
4385 | @item C-u C-c C-x C-u | |
4386 | Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if | |
a7808fba | 4387 | you have several clock table blocks in a buffer. |
dbc28aaa CD |
4388 | @end table |
4389 | ||
864c9740 CD |
4390 | You can add formulas to the column view table and you may add plotting |
4391 | instructions in front of the table - these will survive an update of the | |
4392 | block. If there is a @code{#+TBLFM:} after the table, the table will | |
4393 | actually be recalculated automatically after an update. | |
4394 | ||
a7808fba | 4395 | @node Property API, , Column view, Properties and Columns |
4009494e GM |
4396 | @section The Property API |
4397 | @cindex properties, API | |
4398 | @cindex API, for properties | |
4399 | ||
4400 | There is a full API for accessing and changing properties. This API can | |
4401 | be used by Emacs Lisp programs to work with properties and to implement | |
4402 | features based on them. For more information see @ref{Using the | |
4403 | property API}. | |
4404 | ||
864c9740 | 4405 | @node Dates and Times, Capture, Properties and Columns, Top |
dbc28aaa CD |
4406 | @chapter Dates and Times |
4407 | @cindex dates | |
4408 | @cindex times | |
4009494e GM |
4409 | @cindex time stamps |
4410 | @cindex date stamps | |
4411 | ||
dbc28aaa CD |
4412 | To assist project planning, TODO items can be labeled with a date and/or |
4413 | a time. The specially formatted string carrying the date and time | |
a7808fba | 4414 | information is called a @emph{timestamp} in Org mode. This may be a |
dbc28aaa | 4415 | little confusing because timestamp is often used as indicating when |
a7808fba | 4416 | something was created or last changed. However, in Org mode this term |
dbc28aaa | 4417 | is used in a much wider sense. |
4009494e GM |
4418 | |
4419 | @menu | |
a7808fba | 4420 | * Timestamps:: Assigning a time to a tree entry |
4009494e GM |
4421 | * Creating timestamps:: Commands which insert timestamps |
4422 | * Deadlines and scheduling:: Planning your work | |
a7808fba CD |
4423 | * Clocking work time:: Tracking how long you spend on a task |
4424 | * Effort estimates:: Planning work effort in advance | |
96c8522a | 4425 | * Relative timer:: Notes with a running timer |
4009494e GM |
4426 | @end menu |
4427 | ||
4428 | ||
a7808fba CD |
4429 | @node Timestamps, Creating timestamps, Dates and Times, Dates and Times |
4430 | @section Timestamps, deadlines and scheduling | |
4009494e GM |
4431 | @cindex time stamps |
4432 | @cindex ranges, time | |
4433 | @cindex date stamps | |
4434 | @cindex deadlines | |
4435 | @cindex scheduling | |
4436 | ||
4437 | A time stamp is a specification of a date (possibly with time or a range | |
4438 | of times) in a special format, either @samp{<2003-09-16 Tue>} or | |
4439 | @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue | |
dbc28aaa CD |
4440 | 12:00-12:30>}@footnote{This is the standard ISO date/time format. To |
4441 | use an alternative format, see @ref{Custom time format}.}. A time stamp | |
a7808fba | 4442 | can appear anywhere in the headline or body of an Org tree entry. Its |
dbc28aaa | 4443 | presence causes entries to be shown on specific dates in the agenda |
a7808fba | 4444 | (@pxref{Weekly/daily agenda}). We distinguish: |
4009494e GM |
4445 | |
4446 | @table @var | |
dbc28aaa | 4447 | @item Plain time stamp; Event; Appointment |
4009494e GM |
4448 | @cindex timestamp |
4449 | A simple time stamp just assigns a date/time to an item. This is just | |
dbc28aaa CD |
4450 | like writing down an appointment or event in a paper agenda. In the |
4451 | timeline and agenda displays, the headline of an entry associated with a | |
4452 | plain time stamp will be shown exactly on that date. | |
4009494e GM |
4453 | |
4454 | @example | |
4455 | * Meet Peter at the movies <2006-11-01 Wed 19:15> | |
4456 | * Discussion on climate change <2006-11-02 Thu 20:00-22:00> | |
4457 | @end example | |
4458 | ||
4459 | @item Time stamp with repeater interval | |
4460 | @cindex timestamp, with repeater interval | |
4461 | A time stamp may contain a @emph{repeater interval}, indicating that it | |
4462 | applies not only on the given date, but again and again after a certain | |
4463 | interval of N days (d), weeks (w), months(m), or years(y). The | |
4464 | following will show up in the agenda every Wednesday: | |
4465 | ||
4466 | @example | |
4467 | * Pick up Sam at school <2007-05-16 Wed 12:30 +1w> | |
4468 | @end example | |
4469 | ||
4470 | @item Diary-style sexp entries | |
a7808fba | 4471 | For more complex date specifications, Org mode supports using the |
4009494e GM |
4472 | special sexp diary entries implemented in the Emacs calendar/diary |
4473 | package. For example | |
4474 | ||
4475 | @example | |
4476 | * The nerd meeting on every 2nd Thursday of the month | |
4477 | <%%(diary-float t 4 2)> | |
4478 | @end example | |
4479 | ||
4480 | @item Time/Date range | |
4481 | @cindex timerange | |
4482 | @cindex date range | |
4483 | Two time stamps connected by @samp{--} denote a range. The headline | |
4484 | will be shown on the first and last day of the range, and on any dates | |
4485 | that are displayed and fall in the range. Here is an example: | |
4486 | ||
4487 | @example | |
4488 | ** Meeting in Amsterdam | |
4489 | <2004-08-23 Mon>--<2004-08-26 Thu> | |
4490 | @end example | |
4491 | ||
4492 | @item Inactive time stamp | |
4493 | @cindex timestamp, inactive | |
4494 | @cindex inactive timestamp | |
4495 | Just like a plain time stamp, but with square brackets instead of | |
4496 | angular ones. These time stamps are inactive in the sense that they do | |
4497 | @emph{not} trigger an entry to show up in the agenda. | |
4498 | ||
4499 | @example | |
4500 | * Gillian comes late for the fifth time [2006-11-01 Wed] | |
4501 | @end example | |
4502 | ||
4503 | @end table | |
4504 | ||
a7808fba | 4505 | @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times |
4009494e GM |
4506 | @section Creating timestamps |
4507 | @cindex creating timestamps | |
4508 | @cindex timestamps, creating | |
4509 | ||
a7808fba | 4510 | For Org mode to recognize time stamps, they need to be in the specific |
4009494e GM |
4511 | format. All commands listed below produce time stamps in the correct |
4512 | format. | |
4513 | ||
4514 | @table @kbd | |
4515 | @kindex C-c . | |
4516 | @item C-c . | |
864c9740 CD |
4517 | Prompt for a date and insert a corresponding time stamp. When the cursor is |
4518 | at an existing time stamp in the buffer, the command is used to modify this | |
4519 | timestamp instead of inserting a new one. When this command is used twice in | |
4520 | succession, a time range is inserted. | |
4009494e GM |
4521 | @c |
4522 | @kindex C-u C-c . | |
4523 | @item C-u C-c . | |
4524 | Like @kbd{C-c .}, but use the alternative format which contains date | |
4525 | and time. The default time can be rounded to multiples of 5 minutes, | |
4526 | see the option @code{org-time-stamp-rounding-minutes}. | |
4527 | @c | |
4528 | @kindex C-c ! | |
4529 | @item C-c ! | |
4530 | Like @kbd{C-c .}, but insert an inactive time stamp that will not cause | |
4531 | an agenda entry. | |
4532 | @c | |
4533 | @kindex C-c < | |
4534 | @item C-c < | |
4535 | Insert a time stamp corresponding to the cursor date in the Calendar. | |
4536 | @c | |
4537 | @kindex C-c > | |
4538 | @item C-c > | |
4539 | Access the Emacs calendar for the current date. If there is a | |
a7808fba | 4540 | timestamp in the current line, go to the corresponding date |
4009494e GM |
4541 | instead. |
4542 | @c | |
4543 | @kindex C-c C-o | |
4544 | @item C-c C-o | |
4545 | Access the agenda for the date given by the time stamp or -range at | |
a7808fba | 4546 | point (@pxref{Weekly/daily agenda}). |
4009494e GM |
4547 | @c |
4548 | @kindex S-@key{left} | |
4549 | @kindex S-@key{right} | |
4550 | @item S-@key{left} | |
4551 | @itemx S-@key{right} | |
4552 | Change date at cursor by one day. These key bindings conflict with | |
a7808fba | 4553 | CUA mode (@pxref{Conflicts}). |
4009494e GM |
4554 | @c |
4555 | @kindex S-@key{up} | |
4556 | @kindex S-@key{down} | |
4557 | @item S-@key{up} | |
4558 | @itemx S-@key{down} | |
4559 | Change the item under the cursor in a timestamp. The cursor can be on a | |
4560 | year, month, day, hour or minute. Note that if the cursor is in a | |
4561 | headline and not at a time stamp, these same keys modify the priority of | |
4562 | an item. (@pxref{Priorities}). The key bindings also conflict with | |
a7808fba | 4563 | CUA mode (@pxref{Conflicts}). |
4009494e GM |
4564 | @c |
4565 | @kindex C-c C-y | |
4566 | @cindex evaluate time range | |
4567 | @item C-c C-y | |
a7808fba CD |
4568 | Evaluate a time range by computing the difference between start and end. |
4569 | With a prefix argument, insert result after the time range (in a table: into | |
4570 | the following column). | |
4009494e GM |
4571 | @end table |
4572 | ||
4573 | ||
4574 | @menu | |
a7808fba CD |
4575 | * The date/time prompt:: How Org mode helps you entering date and time |
4576 | * Custom time format:: Making dates look different | |
4009494e GM |
4577 | @end menu |
4578 | ||
4579 | @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps | |
4580 | @subsection The date/time prompt | |
4581 | @cindex date, reading in minibuffer | |
4582 | @cindex time, reading in minibuffer | |
4583 | ||
a7808fba | 4584 | When Org mode prompts for a date/time, the default is shown as an ISO |
dbc28aaa CD |
4585 | date, and the prompt therefore seems to ask for an ISO date. But it |
4586 | will in fact accept any string containing some date and/or time | |
4587 | information, and it is really smart about interpreting your input. You | |
4588 | can, for example, use @kbd{C-y} to paste a (possibly multi-line) string | |
a7808fba | 4589 | copied from an email message. Org mode will find whatever information |
dbc28aaa CD |
4590 | is in there and derive anything you have not specified from the |
4591 | @emph{default date and time}. The default is usually the current date | |
4592 | and time, but when modifying an existing time stamp, or when entering | |
4593 | the second stamp of a range, it is taken from the stamp in the buffer. | |
a7808fba | 4594 | When filling in information, Org mode assumes that most of the time you |
dbc28aaa CD |
4595 | will want to enter a date in the future: If you omit the month/year and |
4596 | the given day/month is @i{before} today, it will assume that you mean a | |
4597 | future date@footnote{See the variable | |
4598 | @code{org-read-date-prefer-future}.}. | |
4599 | ||
07450bee | 4600 | For example, let's assume that today is @b{June 13, 2006}. Here is how |
a7808fba | 4601 | various inputs will be interpreted, the items filled in by Org mode are |
dbc28aaa CD |
4602 | in @b{bold}. |
4603 | ||
4604 | @example | |
4605 | 3-2-5 --> 2003-02-05 | |
4606 | 14 --> @b{2006}-@b{06}-14 | |
4607 | 12 --> @b{2006}-@b{07}-12 | |
4608 | Fri --> nearest Friday (defaultdate or later) | |
07450bee | 4609 | sep 15 --> @b{2006}-09-15 |
dbc28aaa CD |
4610 | feb 15 --> @b{2007}-02-15 |
4611 | sep 12 9 --> 2009-09-12 | |
4612 | 12:45 --> @b{2006}-@b{06}-@b{13} 12:45 | |
4613 | 22 sept 0:34 --> @b{2006}-09-22 0:34 | |
a7808fba CD |
4614 | w4 --> ISO week for of the current year @b{2006} |
4615 | 2012 w4 fri --> Friday of ISO week 4 in 2012 | |
4616 | 2012-w04-5 --> Same as above | |
dbc28aaa CD |
4617 | @end example |
4618 | ||
4619 | Furthermore you can specify a relative date by giving, as the | |
4620 | @emph{first} thing in the input: a plus/minus sign, a number and a | |
4621 | letter [dwmy] to indicate change in days weeks, months, years. With a | |
4622 | single plus or minus, the date is always relative to today. With a | |
4623 | double plus or minus, it is relative to the default date. If instead of | |
4624 | a single letter, you use the abbreviation of day name, the date will be | |
4625 | the nth such day. E.g. | |
4626 | ||
4627 | @example | |
b349f79f CD |
4628 | +0 --> today |
4629 | . --> today | |
dbc28aaa CD |
4630 | +4d --> four days from today |
4631 | +4 --> same as above | |
4632 | +2w --> two weeks from today | |
4633 | ++5 --> five days from default date | |
4634 | +2tue --> second tuesday from now. | |
4009494e GM |
4635 | @end example |
4636 | ||
4637 | The function understands English month and weekday abbreviations. If | |
4638 | you want to use unabbreviated names and/or other languages, configure | |
4639 | the variables @code{parse-time-months} and @code{parse-time-weekdays}. | |
4640 | ||
4641 | @cindex calendar, for selecting date | |
4642 | Parallel to the minibuffer prompt, a calendar is popped up@footnote{If | |
4643 | you don't need/want the calendar, configure the variable | |
4644 | @code{org-popup-calendar-for-date-prompt}.}. When you exit the date | |
4645 | prompt, either by clicking on a date in the calendar, or by pressing | |
4646 | @key{RET}, the date selected in the calendar will be combined with the | |
4647 | information entered at the prompt. You can control the calendar fully | |
4648 | from the minibuffer: | |
4649 | ||
4009494e | 4650 | @kindex < |
4009494e | 4651 | @kindex > |
4009494e | 4652 | @kindex mouse-1 |
4009494e | 4653 | @kindex S-@key{right} |
4009494e | 4654 | @kindex S-@key{left} |
4009494e | 4655 | @kindex S-@key{down} |
4009494e | 4656 | @kindex S-@key{up} |
4009494e | 4657 | @kindex M-S-@key{right} |
4009494e | 4658 | @kindex M-S-@key{left} |
4009494e | 4659 | @kindex @key{RET} |
dbc28aaa CD |
4660 | @example |
4661 | > / < @r{Scroll calendar forward/backward by one month.} | |
4662 | mouse-1 @r{Select date by clicking on it.} | |
4663 | S-@key{right}/@key{left} @r{One day forward/backward.} | |
4664 | S-@key{down}/@key{up} @r{One week forward/backward.} | |
4665 | M-S-@key{right}/@key{left} @r{One month forward/backward.} | |
4666 | @key{RET} @r{Choose date in calendar.} | |
4667 | @end example | |
4668 | ||
a7808fba CD |
4669 | The actions of the date/time prompt may seem complex, but I assure you they |
4670 | will grow on you, and you will start getting annoyed by pretty much any other | |
4671 | way of entering a date/time out there. To help you understand what is going | |
4672 | on, the current interpretation of your input will be displayed live in the | |
4673 | minibuffer@footnote{If you find this distracting, turn the display of with | |
4674 | @code{org-read-date-display-live}.}. | |
4009494e GM |
4675 | |
4676 | @node Custom time format, , The date/time prompt, Creating timestamps | |
4677 | @subsection Custom time format | |
4678 | @cindex custom date/time format | |
4679 | @cindex time format, custom | |
4680 | @cindex date format, custom | |
4681 | ||
a7808fba | 4682 | Org mode uses the standard ISO notation for dates and times as it is |
4009494e GM |
4683 | defined in ISO 8601. If you cannot get used to this and require another |
4684 | representation of date and time to keep you happy, you can get it by | |
4685 | customizing the variables @code{org-display-custom-times} and | |
4686 | @code{org-time-stamp-custom-formats}. | |
4687 | ||
4688 | @table @kbd | |
4689 | @kindex C-c C-x C-t | |
4690 | @item C-c C-x C-t | |
4691 | Toggle the display of custom formats for dates and times. | |
4692 | @end table | |
4693 | ||
4694 | @noindent | |
a7808fba | 4695 | Org mode needs the default format for scanning, so the custom date/time |
4009494e GM |
4696 | format does not @emph{replace} the default format - instead it is put |
4697 | @emph{over} the default format using text properties. This has the | |
4698 | following consequences: | |
4699 | @itemize @bullet | |
28a16a1b | 4700 | @item |
4009494e GM |
4701 | You cannot place the cursor onto a time stamp anymore, only before or |
4702 | after. | |
4703 | @item | |
4704 | The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust | |
4705 | each component of a time stamp. If the cursor is at the beginning of | |
4706 | the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day, | |
4707 | just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the | |
4708 | time will be changed by one minute. | |
4709 | @item | |
4710 | If the time stamp contains a range of clock times or a repeater, these | |
4711 | will not be overlayed, but remain in the buffer as they were. | |
4712 | @item | |
4713 | When you delete a time stamp character-by-character, it will only | |
4714 | disappear from the buffer after @emph{all} (invisible) characters | |
4715 | belonging to the ISO timestamp have been removed. | |
4716 | @item | |
4717 | If the custom time stamp format is longer than the default and you are | |
4718 | using dates in tables, table alignment will be messed up. If the custom | |
4719 | format is shorter, things do work as expected. | |
4720 | @end itemize | |
4721 | ||
4722 | ||
a7808fba CD |
4723 | @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times |
4724 | @section Deadlines and scheduling | |
4009494e | 4725 | |
dbc28aaa | 4726 | A time stamp may be preceded by special keywords to facilitate planning: |
4009494e GM |
4727 | |
4728 | @table @var | |
4729 | @item DEADLINE | |
4730 | @cindex DEADLINE keyword | |
dbc28aaa CD |
4731 | |
4732 | Meaning: the task (most likely a TODO item, though not necessarily) is supposed | |
4733 | to be finished on that date. | |
4734 | ||
4735 | On the deadline date, the task will be listed in the agenda. In | |
4736 | addition, the agenda for @emph{today} will carry a warning about the | |
4737 | approaching or missed deadline, starting | |
4738 | @code{org-deadline-warning-days} before the due date, and continuing | |
4739 | until the entry is marked DONE. An example: | |
4009494e GM |
4740 | |
4741 | @example | |
4742 | *** TODO write article about the Earth for the Guide | |
4743 | The editor in charge is [[bbdb:Ford Prefect]] | |
4744 | DEADLINE: <2004-02-29 Sun> | |
4745 | @end example | |
4746 | ||
4747 | You can specify a different lead time for warnings for a specific | |
4748 | deadlines using the following syntax. Here is an example with a warning | |
4749 | period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}. | |
4750 | ||
4751 | @item SCHEDULED | |
4752 | @cindex SCHEDULED keyword | |
dbc28aaa CD |
4753 | |
4754 | Meaning: you are planning to start working on that task on the given | |
4755 | date. | |
4756 | ||
4757 | The headline will be listed under the given date@footnote{It will still | |
4758 | be listed on that date after it has been marked DONE. If you don't like | |
4009494e GM |
4759 | this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In |
4760 | addition, a reminder that the scheduled date has passed will be present | |
4761 | in the compilation for @emph{today}, until the entry is marked DONE. | |
4762 | I.e., the task will automatically be forwarded until completed. | |
4763 | ||
4764 | @example | |
4765 | *** TODO Call Trillian for a date on New Years Eve. | |
4766 | SCHEDULED: <2004-12-25 Sat> | |
4767 | @end example | |
dbc28aaa CD |
4768 | |
4769 | @noindent | |
a7808fba | 4770 | @b{Important:} Scheduling an item in Org mode should @i{not} be |
dbc28aaa CD |
4771 | understood in the same way that we understand @i{scheduling a meeting}. |
4772 | Setting a date for a meeting is just a simple appointment, you should | |
4773 | mark this entry with a simple plain time stamp, to get this item shown | |
4774 | on the date where it applies. This is a frequent mis-understanding from | |
a7808fba | 4775 | Org-users. In Org mode, @i{scheduling} means setting a date when you |
dbc28aaa | 4776 | want to start working on an action item. |
4009494e GM |
4777 | @end table |
4778 | ||
dbc28aaa | 4779 | You may use time stamps with repeaters in scheduling and deadline |
a7808fba | 4780 | entries. Org mode will issue early and late warnings based on the |
dbc28aaa CD |
4781 | assumption that the time stamp represents the @i{nearest instance} of |
4782 | the repeater. However, the use of diary sexp entries like | |
4783 | @c | |
4784 | @code{<%%(diary-float t 42)>} | |
4785 | @c | |
a7808fba | 4786 | in scheduling and deadline timestamps is limited. Org mode does not |
dbc28aaa CD |
4787 | know enough about the internals of each sexp function to issue early and |
4788 | late warnings. However, it will show the item on each day where the | |
4789 | sexp entry matches. | |
4790 | ||
4009494e GM |
4791 | @menu |
4792 | * Inserting deadline/schedule:: Planning items | |
4793 | * Repeated tasks:: Items that show up again and again | |
4794 | @end menu | |
4795 | ||
4796 | @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling | |
a7808fba | 4797 | @subsection Inserting deadlines or schedules |
4009494e GM |
4798 | |
4799 | The following commands allow to quickly insert a deadline or to schedule | |
4800 | an item: | |
4801 | ||
4802 | @table @kbd | |
4803 | @c | |
4804 | @kindex C-c C-d | |
4805 | @item C-c C-d | |
4806 | Insert @samp{DEADLINE} keyword along with a stamp. The insertion will | |
dbc28aaa CD |
4807 | happen in the line directly following the headline. When called with a |
4808 | prefix arg, an existing deadline will be removed from the entry. | |
4009494e GM |
4809 | @c FIXME Any CLOSED timestamp will be removed.???????? |
4810 | @c | |
dbc28aaa | 4811 | @kindex C-c / d |
4009494e | 4812 | @cindex sparse tree, for deadlines |
dbc28aaa | 4813 | @item C-c / d |
4009494e GM |
4814 | Create a sparse tree with all deadlines that are either past-due, or |
4815 | which will become due within @code{org-deadline-warning-days}. | |
4816 | With @kbd{C-u} prefix, show all deadlines in the file. With a numeric | |
dbc28aaa | 4817 | prefix, check that many days. For example, @kbd{C-1 C-c / d} shows |
4009494e GM |
4818 | all deadlines due tomorrow. |
4819 | @c | |
4820 | @kindex C-c C-s | |
4821 | @item C-c C-s | |
4822 | Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will | |
4823 | happen in the line directly following the headline. Any CLOSED | |
dbc28aaa CD |
4824 | timestamp will be removed. When called with a prefix argument, remove |
4825 | the scheduling date from the entry. | |
b349f79f CD |
4826 | @c |
4827 | @kindex C-c C-x C-k | |
4828 | @kindex k a | |
4829 | @kindex k s | |
4830 | @item C-c C-x C-k | |
4831 | Mark the current entry for agenda action. After you have marked the entry | |
4832 | like this, you can open the agenda or the calendar to find an appropriate | |
4833 | date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to | |
4834 | schedule the marked item. | |
4009494e GM |
4835 | @end table |
4836 | ||
4837 | @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling | |
a7808fba | 4838 | @subsection Repeated tasks |
4009494e | 4839 | |
a7808fba | 4840 | Some tasks need to be repeated again and again. Org mode helps to |
28a16a1b CD |
4841 | organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED, |
4842 | or plain time stamp. In the following example | |
4009494e GM |
4843 | @example |
4844 | ** TODO Pay the rent | |
4845 | DEADLINE: <2005-10-01 Sat +1m> | |
4846 | @end example | |
dbc28aaa CD |
4847 | the @code{+1m} is a repeater; the intended interpretation is that the |
4848 | task has a deadline on <2005-10-01> and repeats itself every (one) month | |
28a16a1b CD |
4849 | starting from that time. If you need both a repeater and a special |
4850 | warning period in a deadline entry, the repeater comes first and the | |
4851 | warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}. | |
4009494e GM |
4852 | |
4853 | Deadlines and scheduled items produce entries in the agenda when they | |
4854 | are over-due, so it is important to be able to mark such an entry as | |
4855 | completed once you have done so. When you mark a DEADLINE or a SCHEDULE | |
a7808fba | 4856 | with the TODO keyword DONE, it will no longer produce entries in the |
28a16a1b | 4857 | agenda. The problem with this is, however, that then also the |
a7808fba | 4858 | @emph{next} instance of the repeated entry will not be active. Org mode |
4009494e GM |
4859 | deals with this in the following way: When you try to mark such an entry |
4860 | DONE (using @kbd{C-c C-t}), it will shift the base date of the repeating | |
4861 | time stamp by the repeater interval, and immediately set the entry state | |
4862 | back to TODO. In the example above, setting the state to DONE would | |
4863 | actually switch the date like this: | |
4864 | ||
4865 | @example | |
4866 | ** TODO Pay the rent | |
4867 | DEADLINE: <2005-11-01 Tue +1m> | |
4868 | @end example | |
4869 | ||
a7808fba CD |
4870 | A timestamp@footnote{You can change this using the option |
4871 | @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat}, | |
4872 | @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you | |
a50253cc | 4873 | will also be prompted for a note.} will be added under the deadline, to keep |
a7808fba | 4874 | a record that you actually acted on the previous instance of this deadline. |
4009494e GM |
4875 | |
4876 | As a consequence of shifting the base date, this entry will no longer be | |
4877 | visible in the agenda when checking past dates, but all future instances | |
4878 | will be visible. | |
4879 | ||
28a16a1b CD |
4880 | With the @samp{+1m} cookie, the date shift will always be exactly one |
4881 | month. So if you have not payed the rent for three months, marking this | |
4882 | entry DONE will still keep it as an overdue deadline. Depending on the | |
4883 | task, this may not be the best way to handle it. For example, if you | |
4884 | forgot to call you father for 3 weeks, it does not make sense to call | |
a7808fba | 4885 | him 3 times in a single day to make up for it. Finally, there are tasks |
28a16a1b | 4886 | like changing batteries which should always repeat a certain time |
a7808fba CD |
4887 | @i{after} the last time you did it. For these tasks, Org mode has |
4888 | special repeaters markers with @samp{++} and @samp{.+}. For example: | |
28a16a1b CD |
4889 | |
4890 | @example | |
4891 | ** TODO Call Father | |
4892 | DEADLINE: <2008-02-10 Sun ++1w> | |
4893 | Marking this DONE will shift the date by at least one week, | |
4894 | but also by as many weeks as it takes to get this date into | |
4895 | the future. However, it stays on a Sunday, even if you called | |
4896 | and marked it done on Saturday. | |
4897 | ** TODO Check the batteries in the smoke detectors | |
4898 | DEADLINE: <2005-11-01 Tue .+1m> | |
4899 | Marking this DONE will shift the date to one month after | |
4900 | today. | |
4901 | @end example | |
4902 | ||
4009494e GM |
4903 | You may have both scheduling and deadline information for a specific |
4904 | task - just make sure that the repeater intervals on both are the same. | |
4905 | ||
a7808fba | 4906 | @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times |
dbc28aaa | 4907 | @section Clocking work time |
4009494e | 4908 | |
a7808fba | 4909 | Org mode allows you to clock the time you spent on specific tasks in a |
4009494e GM |
4910 | project. When you start working on an item, you can start the clock. |
4911 | When you stop working on that task, or when you mark the task done, the | |
4912 | clock is stopped and the corresponding time interval is recorded. It | |
4913 | also computes the total time spent on each subtree of a project. | |
4914 | ||
4915 | @table @kbd | |
4916 | @kindex C-c C-x C-i | |
4917 | @item C-c C-x C-i | |
4918 | Start the clock on the current item (clock-in). This inserts the CLOCK | |
dbc28aaa CD |
4919 | keyword together with a timestamp. If this is not the first clocking of |
4920 | this item, the multiple CLOCK lines will be wrapped into a | |
4921 | @code{:CLOCK:} drawer (see also the variable | |
a7808fba CD |
4922 | @code{org-clock-into-drawer}). When called with a @kbd{C-u} prefix argument, |
4923 | select the task from a list of recently clocked tasks. With two @kbd{C-u | |
4924 | C-u} prefixes, clock into the task at point and mark it as the default task. | |
4925 | The default task will always be available when selecting a clocking task, | |
4926 | with letter @kbd{d}. | |
4009494e GM |
4927 | @kindex C-c C-x C-o |
4928 | @item C-c C-x C-o | |
a20d3598 | 4929 | Stop the clock (clock-out). This inserts another timestamp at the same |
4009494e GM |
4930 | location where the clock was last started. It also directly computes |
4931 | the resulting time in inserts it after the time range as @samp{=> | |
28a16a1b CD |
4932 | HH:MM}. See the variable @code{org-log-note-clock-out} for the |
4933 | possibility to record an additional note together with the clock-out | |
4934 | time stamp@footnote{The corresponding in-buffer setting is: | |
4935 | @code{#+STARTUP: lognoteclock-out}}. | |
4009494e GM |
4936 | @kindex C-c C-y |
4937 | @item C-c C-y | |
4938 | Recompute the time interval after changing one of the time stamps. This | |
4939 | is only necessary if you edit the time stamps directly. If you change | |
4940 | them with @kbd{S-@key{cursor}} keys, the update is automatic. | |
4941 | @kindex C-c C-t | |
4942 | @item C-c C-t | |
4943 | Changing the TODO state of an item to DONE automatically stops the clock | |
4944 | if it is running in this same item. | |
4945 | @kindex C-c C-x C-x | |
4946 | @item C-c C-x C-x | |
4947 | Cancel the current clock. This is useful if a clock was started by | |
4948 | mistake, or if you ended up working on something else. | |
dbc28aaa CD |
4949 | @kindex C-c C-x C-j |
4950 | @item C-c C-x C-j | |
a7808fba CD |
4951 | Jump to the entry that contains the currently running clock. With a |
4952 | @kbd{C-u} prefix arg, select the target task from a list of recently clocked | |
4953 | tasks. | |
4009494e GM |
4954 | @kindex C-c C-x C-d |
4955 | @item C-c C-x C-d | |
4956 | Display time summaries for each subtree in the current buffer. This | |
4957 | puts overlays at the end of each headline, showing the total time | |
4958 | recorded under that heading, including the time of any subheadings. You | |
4959 | can use visibility cycling to study the tree, but the overlays disappear | |
4960 | when you change the buffer (see variable | |
4961 | @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}. | |
4962 | @kindex C-c C-x C-r | |
4963 | @item C-c C-x C-r | |
4964 | Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock | |
a7808fba | 4965 | report as an Org mode table into the current file. When the cursor is |
dbc28aaa CD |
4966 | at an existing clock table, just update it. When called with a prefix |
4967 | argument, jump to the first clock report in the current document and | |
4968 | update it. | |
b349f79f | 4969 | @cindex #+BEGIN: clocktable |
4009494e | 4970 | @example |
dbc28aaa | 4971 | #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file |
4009494e GM |
4972 | #+END: clocktable |
4973 | @end example | |
4974 | @noindent | |
dbc28aaa CD |
4975 | If such a block already exists at point, its content is replaced by the |
4976 | new table. The @samp{BEGIN} line can specify options: | |
4009494e | 4977 | @example |
dbc28aaa | 4978 | :maxlevel @r{Maximum level depth to which times are listed in the table.} |
4009494e | 4979 | :emphasize @r{When @code{t}, emphasize level one and level two items} |
dbc28aaa CD |
4980 | :scope @r{The scope to consider. This can be any of the following:} |
4981 | nil @r{the current buffer or narrowed region} | |
4982 | file @r{the full current buffer} | |
4983 | subtree @r{the subtree where the clocktable is located} | |
4984 | treeN @r{the surrounding level N tree, for example @code{tree3}} | |
4985 | tree @r{the surrounding level 1 tree} | |
4986 | agenda @r{all agenda files} | |
4987 | ("file"..) @r{scan these files} | |
a7808fba CD |
4988 | file-with-archives @r{current file and its archives} |
4989 | agenda-with-archives @r{all agenda files, including archives} | |
4990 | :block @r{The time block to consider. This block is specified either} | |
4991 | @r{absolute, or relative to the current time and may be any of} | |
4992 | @r{these formats:} | |
4993 | 2007-12-31 @r{New year eve 2007} | |
4994 | 2007-12 @r{December 2007} | |
4995 | 2007-W50 @r{ISO-week 50 in 2007} | |
4996 | 2007 @r{the year 2007} | |
4997 | today, yesterday, today-N @r{a relative day} | |
4998 | thisweek, lastweek, thisweek-N @r{a relative week} | |
4999 | thismonth, lastmonth, thismonth-N @r{a relative month} | |
5000 | thisyear, lastyear, thisyear-N @r{a relative year} | |
5001 | @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.} | |
4009494e GM |
5002 | :tstart @r{A time string specifying when to start considering times} |
5003 | :tend @r{A time string specifying when to stop considering times} | |
a7808fba CD |
5004 | :step @r{@code{week} or @code{day}, to split the table into chunks.} |
5005 | @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.} | |
28a16a1b | 5006 | :link @r{Link the item headlines in the table to their origins} |
e45e3595 CD |
5007 | :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.} |
5008 | @r{As a special case, @samp{:formula %} adds column with % time.} | |
5009 | @r{If you do not specify a formula here, any existing formula} | |
5010 | @r{below the clock table will survive updates and be evaluated.} | |
4009494e | 5011 | @end example |
dbc28aaa CD |
5012 | So to get a clock summary of the current level 1 tree, for the current |
5013 | day, you could write | |
4009494e | 5014 | @example |
a7808fba | 5015 | #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t |
4009494e GM |
5016 | #+END: clocktable |
5017 | @end example | |
5018 | and to use a specific time range you could write@footnote{Note that all | |
5019 | parameters must be specified in a single line - the line is broken here | |
5020 | only to fit it onto the manual.} | |
5021 | @example | |
28a16a1b | 5022 | #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>" |
4009494e | 5023 | :tend "<2006-08-10 Thu 12:00>" |
4009494e GM |
5024 | #+END: clocktable |
5025 | @end example | |
e45e3595 CD |
5026 | A summary of the current subtree with % times would be |
5027 | @example | |
5028 | #+BEGIN: clocktable :scope subtree :link t :formula % | |
5029 | #+END: clocktable | |
5030 | @end example | |
dbc28aaa CD |
5031 | @kindex C-c C-c |
5032 | @item C-c C-c | |
5033 | @kindex C-c C-x C-u | |
5034 | @itemx C-c C-x C-u | |
5035 | Update dynamical block at point. The cursor needs to be in the | |
5036 | @code{#+BEGIN} line of the dynamic block. | |
4009494e GM |
5037 | @kindex C-u C-c C-x C-u |
5038 | @item C-u C-c C-x C-u | |
5039 | Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if | |
a7808fba CD |
5040 | you have several clock table blocks in a buffer. |
5041 | @kindex S-@key{left} | |
5042 | @kindex S-@key{right} | |
5043 | @item S-@key{left} | |
5044 | @itemx S-@key{right} | |
5045 | Shift the current @code{:block} interval and update the table. The cursor | |
5046 | needs to be in the @code{#+BEGIN: clocktable} line for this command. If | |
5047 | @code{:block} is @code{today}, it will be shifted to @code{today-1} etc. | |
4009494e GM |
5048 | @end table |
5049 | ||
5050 | The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in | |
a7808fba | 5051 | the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been |
4009494e GM |
5052 | worked on or closed during a day. |
5053 | ||
96c8522a | 5054 | @node Effort estimates, Relative timer, Clocking work time, Dates and Times |
a7808fba | 5055 | @section Effort estimates |
96c8522a | 5056 | @cindex effort estimates |
a7808fba CD |
5057 | |
5058 | If you want to plan your work in a very detailed way, or if you need to | |
5059 | produce offers with quotations of the estimated work effort, you may want to | |
5060 | assign effort estimates to entries. If you are also clocking your work, you | |
5061 | may later want to compare the planned effort with the actual working time, a | |
5062 | great way to improve planning estimates. Effort estimates are stored in a | |
5063 | special property @samp{Effort}@footnote{You may change the property being | |
5064 | used with the variable @code{org-effort-property}.}. Clearly the best way to | |
5065 | work with effort estimates is through column view (@pxref{Column view}). You | |
5066 | should start by setting up discrete values for effort estimates, and a | |
5067 | @code{COLUMNS} format that displays these values together with clock sums (if | |
5068 | you want to clock your time). For a specific buffer you can use | |
5069 | ||
5070 | @example | |
5071 | #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00 | |
5072 | #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM | |
5073 | @end example | |
5074 | ||
5075 | @noindent | |
71d35b24 CD |
5076 | or, even better, you can set up these values globally by customizing the |
5077 | variables @code{org-global-properties} and @code{org-columns-default-format}. | |
5078 | In particular if you want to use this setup also in the agenda, a global | |
5079 | setup may be advised. | |
a7808fba CD |
5080 | |
5081 | The way to assign estimates to individual items is then to switch to column | |
5082 | mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the | |
5083 | value. The values you enter will immediately be summed up in the hierarchy. | |
5084 | In the column next to it, any clocked time will be displayed. | |
5085 | ||
5086 | If you switch to column view in the daily/weekly agenda, the effort column | |
5087 | will summarize the estimated work effort for each day@footnote{Please note | |
5088 | the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda | |
b349f79f | 5089 | column view}).}, and you can use this to find space in your schedule. To get |
a7808fba CD |
5090 | an overview of the entire part of the day that is committed, you can set the |
5091 | option @code{org-agenda-columns-add-appointments-to-effort-sum}. The | |
5092 | appointments on a day that take place over a specified time interval will | |
5093 | then also be added to the load estimate of the day. | |
5094 | ||
71d35b24 CD |
5095 | Effort estimates can be used in secondary agenda filtering that is triggered |
5096 | with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have | |
5097 | these estimates defined consistently, two or three key presses will narrow | |
5098 | down the list to stuff that fits into an available time slot. | |
864c9740 | 5099 | |
96c8522a CD |
5100 | @node Relative timer, , Effort estimates, Dates and Times |
5101 | @section Taking notes with a relative timer | |
5102 | @cindex relative timer | |
5103 | ||
5104 | When taking notes during, for example, a meeting or a video viewing, it can | |
5105 | be useful to have access to times relative to a starting time. Org provides | |
5106 | such a relative timer and make it easy to create timed notes. | |
5107 | ||
5108 | @table @kbd | |
5109 | @kindex C-c C-x . | |
5110 | @item C-c C-x . | |
5111 | Insert a relative time into the buffer. The first time you use this, the | |
5112 | timer will be started. When called with a prefix argument, the timer is | |
5113 | restarted. | |
5114 | @kindex C-c C-x - | |
5115 | @item C-c C-x - | |
5116 | Insert a description list item with the current relative time. With a prefix | |
5117 | argument, first reset the timer to 0. | |
5118 | @kindex M-@key{RET} | |
5119 | @item M-@key{RET} | |
377952e0 | 5120 | Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert |
96c8522a | 5121 | new timer items. |
55e0839d CD |
5122 | @kindex C-c C-x , |
5123 | @item C-c C-x , | |
5124 | Pause the timer, or continue it if it is already paused. With prefix | |
5125 | argument, stop it entirely. | |
5126 | @kindex C-u C-c C-x , | |
5127 | @item C-u C-c C-x , | |
5128 | Stop the timer. After this, you can only start a new timer, not continue the | |
5129 | old one. This command also removes the timer from the mode line. | |
96c8522a CD |
5130 | @kindex C-c C-x 0 |
5131 | @item C-c C-x 0 | |
5132 | Reset the timer without inserting anything into the buffer. By default, the | |
5133 | timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to | |
5134 | specific starting offset. The user is prompted for the offset, with a | |
5135 | default taken from a timer string at point, if any, So this can be used to | |
5136 | restart taking notes after a break in the process. When called with a double | |
5137 | prefix argument @kbd{C-c C-u}, change all timer strings in the active region | |
5138 | by a certain amount. This can be used to fix timer strings if the timer was | |
5139 | not started at exactly the right moment. | |
5140 | @end table | |
5141 | ||
864c9740 CD |
5142 | @node Capture, Agenda Views, Dates and Times, Top |
5143 | @chapter Capture | |
5144 | @cindex capture | |
5145 | ||
5146 | An important part of any organization system is the ability to quickly | |
5147 | capture new ideas and tasks, and to associate reference material with them. | |
5148 | Org uses the @file{remember} package to create tasks, and stores files | |
5149 | related to a task (@i{attachments}) in a special directory. | |
5150 | ||
5151 | @menu | |
5152 | * Remember:: Capture new tasks/ideas with little interruption | |
5153 | * Attachments:: Add files to tasks. | |
5154 | @end menu | |
5155 | ||
5156 | @node Remember, Attachments, Capture, Capture | |
5157 | @section Remember | |
dbc28aaa CD |
5158 | @cindex @file{remember.el} |
5159 | ||
5160 | The @i{Remember} package by John Wiegley lets you store quick notes with | |
5161 | little interruption of your work flow. See | |
5162 | @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more | |
5163 | information. It is an excellent way to add new notes and tasks to | |
a7808fba | 5164 | Org files. Org significantly expands the possibilities of |
dbc28aaa CD |
5165 | @i{remember}: You may define templates for different note types, and |
5166 | associate target files and headlines with specific templates. It also | |
5167 | allows you to select the location where a note should be stored | |
5168 | interactively, on the fly. | |
5169 | ||
5170 | @menu | |
a7808fba | 5171 | * Setting up Remember:: Some code for .emacs to get things going |
dbc28aaa CD |
5172 | * Remember templates:: Define the outline of different note types |
5173 | * Storing notes:: Directly get the note to where it belongs | |
5174 | * Refiling notes:: Moving a note or task to a project | |
5175 | @end menu | |
5176 | ||
a7808fba | 5177 | @node Setting up Remember, Remember templates, Remember, Remember |
864c9740 | 5178 | @subsection Setting up Remember |
dbc28aaa CD |
5179 | |
5180 | The following customization will tell @i{remember} to use org files as | |
a7808fba | 5181 | target, and to create annotations compatible with Org links. |
dbc28aaa CD |
5182 | |
5183 | @example | |
5184 | (org-remember-insinuate) | |
5185 | (setq org-directory "~/path/to/my/orgfiles/") | |
5186 | (setq org-default-notes-file (concat org-directory "/notes.org")) | |
5187 | (define-key global-map "\C-cr" 'org-remember) | |
5188 | @end example | |
5189 | ||
5190 | The last line binds the command @code{org-remember} to a global | |
5191 | key@footnote{Please select your own key, @kbd{C-c r} is only a | |
5192 | suggestion.}. @code{org-remember} basically just calls @code{remember}, | |
5193 | but it makes a few things easier: If there is an active region, it will | |
5194 | automatically copy the region into the remember buffer. It also allows | |
5195 | to jump to the buffer and location where remember notes are being | |
28a16a1b | 5196 | stored: Just call @code{org-remember} with a prefix argument. If you |
a7808fba | 5197 | use two prefix arguments, Org jumps to the location where the last |
28a16a1b | 5198 | remember note was stored. |
dbc28aaa | 5199 | |
64fb801f CD |
5200 | The remember buffer will actually use @code{org-mode} as its major mode, so |
5201 | that all editing features of Org-mode are available. In addition to this, a | |
5202 | minor mode @code{org-remember-mode} is turned on, for the single purpose that | |
5203 | you can use its keymap @code{org-remember-mode-map} to overwrite some of | |
5204 | Org-mode's key bindings. | |
5205 | ||
b349f79f CD |
5206 | You can also call @code{org-remember} in a special way from the agenda, |
5207 | using the @kbd{k r} key combination. With this access, any time stamps | |
5208 | inserted by the selected remember template (see below) will default to | |
5209 | the cursor date in the agenda, rather than to the current date. | |
5210 | ||
a7808fba | 5211 | @node Remember templates, Storing notes, Setting up Remember, Remember |
864c9740 | 5212 | @subsection Remember templates |
dbc28aaa CD |
5213 | @cindex templates, for remember |
5214 | ||
a7808fba | 5215 | In combination with Org, you can use templates to generate |
dbc28aaa CD |
5216 | different types of @i{remember} notes. For example, if you would like |
5217 | to use one template to create general TODO entries, another one for | |
5218 | journal entries, and a third one for collecting random ideas, you could | |
5219 | use: | |
5220 | ||
5221 | @example | |
5222 | (setq org-remember-templates | |
5223 | '(("Todo" ?t "* TODO %?\n %i\n %a" "~/org/TODO.org" "Tasks") | |
5224 | ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org") | |
5225 | ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas"))) | |
5226 | @end example | |
5227 | ||
5228 | @noindent In these entries, the first string is just a name, and the | |
5229 | character specifies how to select the template. It is useful if the | |
b349f79f CD |
5230 | character is also the first letter of the name. The next string specifies |
5231 | the template. Two more (optional) strings give the file in which, and the | |
5232 | headline under which the new note should be stored. The file (if not present | |
5233 | or @code{nil}) defaults to @code{org-default-notes-file}, the heading to | |
5234 | @code{org-remember-default-headline}. If the file name is not an absolute | |
5235 | path, it will be interpreted relative to @code{org-directory}. The heading | |
5236 | can also be the symbols @code{top} or @code{bottom} to send note as level 1 | |
5237 | entries to the beginning or end of the file, respectively. | |
5238 | ||
5239 | An optional sixth element specifies the contexts in which the user can select | |
5240 | the template. This element can be a list of major modes or a function. | |
5241 | @code{org-remember} will first check whether the function returns @code{t} or | |
a50253cc | 5242 | if we are in any of the listed major mode, and exclude templates for which |
b349f79f CD |
5243 | this condition is not fulfilled. Templates that do not specify this element |
5244 | at all, or that use @code{nil} or @code{t} as a value will always be | |
5245 | selectable. | |
28a16a1b CD |
5246 | |
5247 | So for example: | |
5248 | ||
5249 | @example | |
5250 | (setq org-remember-templates | |
5251 | '(("Bug" ?b "* BUG %?\n %i\n %a" "~/org/BUGS.org" "Bugs" (emacs-lisp-mode)) | |
b349f79f | 5252 | ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org" "X" my-check) |
28a16a1b CD |
5253 | ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas"))) |
5254 | @end example | |
5255 | ||
5256 | The first template will only be available when invoking @code{org-remember} | |
5257 | from an buffer in @code{emacs-lisp-mode}. The second template will only be | |
5258 | available when the function @code{my-check} returns @code{t}. The third | |
5259 | template will be proposed in any context. | |
5260 | ||
b349f79f CD |
5261 | When you call @kbd{M-x org-remember} (or @kbd{M-x remember}) to remember |
5262 | something, Org will prompt for a key to select the template (if you have | |
dbc28aaa CD |
5263 | more than one template) and then prepare the buffer like |
5264 | @example | |
5265 | * TODO | |
5266 | [[file:link to where you called remember]] | |
5267 | @end example | |
5268 | ||
5269 | @noindent | |
5270 | During expansion of the template, special @kbd{%}-escapes allow dynamic | |
5271 | insertion of content: | |
5272 | @example | |
5273 | %^@{prompt@} @r{prompt the user for a string and replace this sequence with it.} | |
5274 | @r{You may specify a default value and a completion table with} | |
5275 | @r{%^@{prompt|default|completion2|completion3...@}} | |
5276 | @r{The arrow keys access a prompt-specific history.} | |
b349f79f CD |
5277 | %a @r{annotation, normally the link created with @code{org-store-link}} |
5278 | %A @r{like @code{%a}, but prompt for the description part} | |
5279 | %i @r{initial content, the region when remember is called with C-u.} | |
5280 | @r{The entire text will be indented like @code{%i} itself.} | |
dbc28aaa CD |
5281 | %t @r{time stamp, date only} |
5282 | %T @r{time stamp with date and time} | |
5283 | %u, %U @r{like the above, but inactive time stamps} | |
5284 | %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}} | |
5285 | @r{You may define a prompt like @code{%^@{Birthday@}t}} | |
5286 | %n @r{user name (taken from @code{user-full-name})} | |
a7808fba CD |
5287 | %c @r{Current kill ring head.} |
5288 | %x @r{Content of the X clipboard.} | |
5289 | %^C @r{Interactive selection of which kill or clip to use.} | |
5290 | %^L @r{Like @code{%^C}, but insert as link.} | |
dbc28aaa | 5291 | %^g @r{prompt for tags, with completion on tags in target file.} |
864c9740 CD |
5292 | %k @r{title of currently clocked task} |
5293 | %K @r{link to currently clocked task} | |
dbc28aaa | 5294 | %^G @r{prompt for tags, with completion all tags in all agenda files.} |
864c9740 | 5295 | %^@{prop@}p @r{Prompt the user for a value for property @code{prop}} |
dbc28aaa CD |
5296 | %:keyword @r{specific information for certain link types, see below} |
5297 | %[pathname] @r{insert the contents of the file given by @code{pathname}} | |
5298 | %(sexp) @r{evaluate elisp @code{(sexp)} and replace with the result} | |
5299 | %! @r{immediately store note after completing the template} | |
5300 | @r{(skipping the @kbd{C-c C-c} that normally triggers storing)} | |
b349f79f | 5301 | %& @r{jump to target location immediately after storing note} |
dbc28aaa CD |
5302 | @end example |
5303 | ||
5304 | @noindent | |
5305 | For specific link types, the following keywords will be | |
5306 | defined@footnote{If you define your own link types (@pxref{Adding | |
5307 | hyperlink types}), any property you store with | |
5308 | @code{org-store-link-props} can be accessed in remember templates in a | |
5309 | similar way.}: | |
5310 | ||
5311 | @example | |
5312 | Link type | Available keywords | |
5313 | -------------------+---------------------------------------------- | |
5314 | bbdb | %:name %:company | |
28a16a1b | 5315 | bbdb | %::server %:port %:nick |
dbc28aaa CD |
5316 | vm, wl, mh, rmail | %:type %:subject %:message-id |
5317 | | %:from %:fromname %:fromaddress | |
5318 | | %:to %:toname %:toaddress | |
28a16a1b | 5319 | | %: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 |
5320 | gnus | %:group, @r{for messages also all email fields} |
5321 | w3, w3m | %:url | |
5322 | info | %:file %:node | |
5323 | calendar | %:date" | |
5324 | @end example | |
5325 | ||
5326 | @noindent | |
5327 | To place the cursor after template expansion use: | |
5328 | ||
5329 | @example | |
5330 | %? @r{After completing the template, position cursor here.} | |
5331 | @end example | |
5332 | ||
5333 | @noindent | |
28a16a1b | 5334 | If you change your mind about which template to use, call |
dbc28aaa CD |
5335 | @code{org-remember} in the remember buffer. You may then select a new |
5336 | template that will be filled with the previous context information. | |
5337 | ||
5338 | @node Storing notes, Refiling notes, Remember templates, Remember | |
864c9740 | 5339 | @subsection Storing notes |
dbc28aaa | 5340 | |
b349f79f CD |
5341 | When you are finished preparing a note with @i{remember}, you have to press |
5342 | @kbd{C-c C-c} to file the note away. If you have started the clock in the | |
5343 | remember buffer, you will first be asked if you want to clock out | |
5344 | now@footnote{To avoid this query, configure the variable | |
5345 | @code{org-remember-clock-out-on-exit}.}. If you answer @kbd{n}, the clock | |
44ce9197 | 5346 | will continue to run after the note was filed away. |
b349f79f CD |
5347 | |
5348 | The handler will then store the note in the file and under the headline | |
5349 | specified in the template, or it will use the default file and headlines. | |
5350 | The window configuration will be restored, sending you back to the working | |
5351 | context before the call to @code{remember}. To re-use the location found | |
5352 | during the last call to @code{remember}, exit the remember buffer with | |
864c9740 CD |
5353 | @kbd{C-0 C-c C-c}, i.e. specify a zero prefix argument to @kbd{C-c C-c}. |
5354 | Another special case is @kbd{C-2 C-c C-c} which files the note as a child of | |
5355 | the currently clocked item. | |
dbc28aaa CD |
5356 | |
5357 | If you want to store the note directly to a different place, use | |
864c9740 | 5358 | @kbd{C-1 C-c C-c} instead to exit remember@footnote{Configure the |
dbc28aaa CD |
5359 | variable @code{org-remember-store-without-prompt} to make this behavior |
5360 | the default.}. The handler will then first prompt for a target file - | |
5361 | if you press @key{RET}, the value specified for the template is used. | |
5362 | Then the command offers the headings tree of the selected file, with the | |
5363 | cursor position at the default headline (if you had specified one in the | |
5364 | template). You can either immediately press @key{RET} to get the note | |
5365 | placed there. Or you can use the following keys to find a different | |
5366 | location: | |
5367 | @example | |
5368 | @key{TAB} @r{Cycle visibility.} | |
5369 | @key{down} / @key{up} @r{Next/previous visible headline.} | |
5370 | n / p @r{Next/previous visible headline.} | |
5371 | f / b @r{Next/previous headline same level.} | |
5372 | u @r{One level up.} | |
5373 | @c 0-9 @r{Digit argument.} | |
5374 | @end example | |
5375 | @noindent | |
5376 | Pressing @key{RET} or @key{left} or @key{right} | |
5377 | then leads to the following result. | |
5378 | ||
5379 | @multitable @columnfractions 0.2 0.15 0.65 | |
5380 | @item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted} | |
5381 | @item on headline @tab @key{RET} @tab as sublevel of the heading at cursor, first or last | |
5382 | @item @tab @tab depending on @code{org-reverse-note-order}. | |
5383 | @item @tab @key{left}/@key{right} @tab as same level, before/after current heading | |
5384 | @item buffer-start @tab @key{RET} @tab as level 2 heading at end of file or level 1 at beginning | |
5385 | @item @tab @tab depending on @code{org-reverse-note-order}. | |
5386 | @item not on headline @tab @key{RET} | |
5387 | @tab at cursor position, level taken from context. | |
5388 | @end multitable | |
5389 | ||
864c9740 CD |
5390 | Before inserting the text into a tree, the function ensures that the text has |
5391 | a headline, i.e. a first line that starts with a @samp{*}. If not, a | |
5392 | headline is constructed from the current date. If you have indented the text | |
5393 | of the note below the headline, the indentation will be adapted if inserting | |
5394 | the note into the tree requires demotion from level 1. | |
dbc28aaa CD |
5395 | |
5396 | @node Refiling notes, , Storing notes, Remember | |
864c9740 | 5397 | @subsection Refiling notes |
dbc28aaa CD |
5398 | @cindex refiling notes |
5399 | ||
5400 | Remember is usually used to quickly capture notes and tasks into one or | |
5401 | a few capture lists. When reviewing the captured data, you may want to | |
5402 | refile some of the entries into a different list, for example into a | |
5403 | project. Cutting, finding the right location and then pasting the note | |
5404 | is cumbersome. To simplify this process, you can use the following | |
5405 | special command: | |
5406 | ||
5407 | @table @kbd | |
5408 | @kindex C-c C-w | |
5409 | @item C-c C-w | |
e45e3595 CD |
5410 | Refile the entry or region at point. This command offers possible locations |
5411 | for refiling the entry and lets you select one with completion. The item (or | |
5412 | all items in the region) is filed below the target heading as a subitem. | |
d60b1ba1 | 5413 | Depending on @code{org-reverse-note-order}, it will be either the first or |
e45e3595 CD |
5414 | last subitem.@* |
5415 | By default, all level 1 headlines in the current buffer are considered to be | |
5416 | targets, but you can have more complex definitions across a number of files. | |
5417 | See the variable @code{org-refile-targets} for details. If you would like to | |
d60b1ba1 CD |
5418 | select a location via a file-path-like completion along the outline path, see |
5419 | the variables @code{org-refile-use-outline-path} and | |
5420 | @code{org-outline-path-complete-in-steps}. | |
28a16a1b CD |
5421 | @kindex C-u C-c C-w |
5422 | @item C-u C-c C-w | |
5423 | Use the refile interface to jump to a heading. | |
5424 | @kindex C-u C-u C-c C-w | |
a7808fba | 5425 | @item C-u C-u C-c C-w |
28a16a1b | 5426 | Jump to the location where @code{org-refile} last moved a tree to. |
dbc28aaa CD |
5427 | @end table |
5428 | ||
864c9740 CD |
5429 | @node Attachments, , Remember, Capture |
5430 | @section Attachments | |
5431 | @cindex attachments | |
5432 | ||
5433 | It is often useful to associate reference material with an outline node/task. | |
5434 | Small chunks of plain text can simply be stored in the subtree of a project. | |
5435 | Hyperlinks (@pxref{Hyperlinks}) can be used to establish associations with | |
5436 | files that live elsewhere on your computer or in the cloud, like emails or | |
5437 | source code files belonging to a project. Another method is @i{attachments}, | |
5438 | which are files located in a directory belonging to an outline node. Org | |
5439 | uses directories named by the unique ID of each entry. These directories are | |
5440 | located in the @file{data} directory which lives in the same directory where | |
5441 | your org-file lives@footnote{If you move entries or Org-files from one | |
5442 | directory to the next, you may want to configure @code{org-attach-directory} | |
5443 | to contain an absolute path.}. If you initialize this directory with | |
5444 | @code{git-init}, Org will automatically commit changes when it sees them. | |
5445 | The attachment system has been contributed to Org by John Wiegley. | |
5446 | ||
55e0839d CD |
5447 | In cases where this seems better, you can also attach a directory of your |
5448 | choice to an entry. You can also make children inherit the attachment | |
5449 | directory from a parent, so that an entire subtree uses the same attached | |
5450 | directory. | |
5451 | ||
864c9740 CD |
5452 | @noindent The following commands deal with attachments. |
5453 | ||
5454 | @table @kbd | |
5455 | ||
5456 | @kindex C-c C-a | |
5457 | @item C-c C-a | |
5458 | The dispatcher for commands related to the attachment system. After these | |
5459 | keys, a list of commands is displayed and you need to press an additional key | |
5460 | to select a command: | |
5461 | ||
5462 | @table @kbd | |
96c8522a CD |
5463 | @kindex C-c C-a a |
5464 | @item a | |
864c9740 CD |
5465 | Select a file and move it into the task's attachment directory. The file |
5466 | will be copied, moved, or linked, depending on @code{org-attach-method}. | |
5467 | Note that hard links are not supported on all systems. | |
5468 | ||
5469 | @kindex C-c C-a c | |
96c8522a CD |
5470 | @kindex C-c C-a m |
5471 | @kindex C-c C-a l | |
864c9740 CD |
5472 | @item c/m/l |
5473 | Attach a file using the copy/move/link method. | |
5474 | Note that hard links are not supported on all systems. | |
5475 | ||
5476 | @kindex C-c C-a n | |
5477 | @item n | |
5478 | Create a new attachment as an Emacs buffer. | |
5479 | ||
5480 | @kindex C-c C-a z | |
5481 | @item z | |
5482 | Synchronize the current task with its attachment directory, in case you added | |
5483 | attachments yourself. | |
5484 | ||
5485 | @kindex C-c C-a o | |
5486 | @item o | |
5487 | Open current task's attachment. If there are more than one, prompt for a | |
5488 | file name first. Opening will follow the rules set by @code{org-file-apps}. | |
a50253cc | 5489 | For more details, see the information on following hyperlinks |
864c9740 CD |
5490 | (@pxref{Handling links}). |
5491 | ||
5492 | @kindex C-c C-a O | |
5493 | @item O | |
5494 | Also open the attachment, but force opening the file in Emacs. | |
5495 | ||
5496 | @kindex C-c C-a f | |
5497 | @item f | |
5498 | Open the current task's attachment directory. | |
5499 | ||
5500 | @kindex C-c C-a F | |
5501 | @item F | |
5502 | Also open the directory, but force using @code{dired} in Emacs. | |
5503 | ||
5504 | @kindex C-c C-a d | |
5505 | @item d | |
5506 | Select and delete a single attachment. | |
5507 | ||
5508 | @kindex C-c C-a D | |
5509 | @item D | |
5510 | Delete all of a task's attachments. A safer way is to open the directory in | |
5511 | dired and delete from there. | |
55e0839d CD |
5512 | |
5513 | @kindex C-c C-a s | |
5514 | @item C-c C-a s | |
5515 | Set a specific directory as the entry's attachment directory. This works by | |
5516 | putting the directory path into the @code{ATTACH_DIR} property. | |
5517 | ||
5518 | @kindex C-c C-a i | |
5519 | @item C-c C-a i | |
5520 | Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the | |
5521 | same directory for attachments as the parent. | |
864c9740 CD |
5522 | @end table |
5523 | @end table | |
5524 | ||
5525 | @node Agenda Views, Embedded LaTeX, Capture, Top | |
4009494e GM |
5526 | @chapter Agenda Views |
5527 | @cindex agenda views | |
5528 | ||
a7808fba | 5529 | Due to the way Org works, TODO items, time-stamped items, and |
4009494e | 5530 | tagged headlines can be scattered throughout a file or even a number of |
dbc28aaa CD |
5531 | files. To get an overview of open action items, or of events that are |
5532 | important for a particular date, this information must be collected, | |
4009494e GM |
5533 | sorted and displayed in an organized way. |
5534 | ||
a7808fba | 5535 | Org can select items based on various criteria, and display them |
28a16a1b | 5536 | in a separate buffer. Seven different view types are provided: |
4009494e GM |
5537 | |
5538 | @itemize @bullet | |
5539 | @item | |
5540 | an @emph{agenda} that is like a calendar and shows information | |
5541 | for specific dates, | |
5542 | @item | |
5543 | a @emph{TODO list} that covers all unfinished | |
5544 | action items, | |
5545 | @item | |
864c9740 CD |
5546 | a @emph{match view}, showings headlines based on the tags, properties and |
5547 | TODO state associated with them, | |
4009494e | 5548 | @item |
a7808fba | 5549 | a @emph{timeline view} that shows all events in a single Org file, |
4009494e GM |
5550 | in time-sorted view, |
5551 | @item | |
28a16a1b CD |
5552 | a @emph{keyword search view} that shows all entries from multiple files |
5553 | that contain specified keywords. | |
5554 | @item | |
4009494e GM |
5555 | a @emph{stuck projects view} showing projects that currently don't move |
5556 | along, and | |
5557 | @item | |
5558 | @emph{custom views} that are special tag/keyword searches and | |
5559 | combinations of different views. | |
5560 | @end itemize | |
5561 | ||
5562 | @noindent | |
5563 | The extracted information is displayed in a special @emph{agenda | |
5564 | buffer}. This buffer is read-only, but provides commands to visit the | |
a7808fba | 5565 | corresponding locations in the original Org files, and even to |
28a16a1b | 5566 | edit these files remotely. |
4009494e GM |
5567 | |
5568 | Two variables control how the agenda buffer is displayed and whether the | |
5569 | window configuration is restored when the agenda exits: | |
5570 | @code{org-agenda-window-setup} and | |
5571 | @code{org-agenda-restore-windows-after-quit}. | |
5572 | ||
5573 | @menu | |
5574 | * Agenda files:: Files being searched for agenda information | |
5575 | * Agenda dispatcher:: Keyboard access to agenda views | |
5576 | * Built-in agenda views:: What is available out of the box? | |
5577 | * Presentation and sorting:: How agenda items are prepared for display | |
a7808fba | 5578 | * Agenda commands:: Remote editing of Org trees |
4009494e | 5579 | * Custom agenda views:: Defining special searches and views |
a7808fba | 5580 | * Agenda column view:: Using column view for collected entries |
4009494e GM |
5581 | @end menu |
5582 | ||
a7808fba | 5583 | @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views |
4009494e GM |
5584 | @section Agenda files |
5585 | @cindex agenda files | |
5586 | @cindex files for agenda | |
5587 | ||
dbc28aaa CD |
5588 | The information to be shown is normally collected from all @emph{agenda |
5589 | files}, the files listed in the variable | |
5590 | @code{org-agenda-files}@footnote{If the value of that variable is not a | |
5591 | list, but a single file name, then the list of agenda files will be | |
5592 | maintained in that external file.}. If a directory is part of this list, | |
5593 | all files with the extension @file{.org} in this directory will be part | |
5594 | of the list. | |
5595 | ||
a7808fba | 5596 | Thus even if you only work with a single Org file, this file should |
dbc28aaa CD |
5597 | be put into that list@footnote{When using the dispatcher, pressing |
5598 | @kbd{<} before selecting a command will actually limit the command to | |
5599 | the current file, and ignore @code{org-agenda-files} until the next | |
4009494e GM |
5600 | dispatcher command.}. You can customize @code{org-agenda-files}, but |
5601 | the easiest way to maintain it is through the following commands | |
5602 | ||
5603 | @cindex files, adding to agenda list | |
5604 | @table @kbd | |
5605 | @kindex C-c [ | |
5606 | @item C-c [ | |
5607 | Add current file to the list of agenda files. The file is added to | |
5608 | the front of the list. If it was already in the list, it is moved to | |
a7808fba | 5609 | the front. With a prefix argument, file is added/moved to the end. |
4009494e GM |
5610 | @kindex C-c ] |
5611 | @item C-c ] | |
5612 | Remove current file from the list of agenda files. | |
5613 | @kindex C-, | |
5614 | @kindex C-' | |
5615 | @item C-, | |
5616 | @itemx C-' | |
5617 | Cycle through agenda file list, visiting one file after the other. | |
a7808fba CD |
5618 | @kindex M-x org-iswitchb |
5619 | @item M-x org-iswitchb | |
5620 | Command to use an @code{iswitchb}-like interface to switch to and between Org | |
5621 | buffers. | |
4009494e GM |
5622 | @end table |
5623 | ||
5624 | @noindent | |
5625 | The Org menu contains the current list of files and can be used | |
5626 | to visit any of them. | |
5627 | ||
dbc28aaa CD |
5628 | If you would like to focus the agenda temporarily onto a file not in |
5629 | this list, or onto just one file in the list or even only a subtree in a | |
5630 | file, this can be done in different ways. For a single agenda command, | |
5631 | you may press @kbd{<} once or several times in the dispatcher | |
5632 | (@pxref{Agenda dispatcher}). To restrict the agenda scope for an | |
5633 | extended period, use the following commands: | |
5634 | ||
5635 | @table @kbd | |
5636 | @kindex C-c C-x < | |
5637 | @item C-c C-x < | |
5638 | Permanently restrict the agenda to the current subtree. When with a | |
5639 | prefix argument, or with the cursor before the first headline in a file, | |
5640 | the agenda scope is set to the entire file. This restriction remains in | |
5641 | effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<} | |
5642 | or @kbd{>} in the agenda dispatcher. If there is a window displaying an | |
5643 | agenda view, the new restriction takes effect immediately. | |
67df9cfb CD |
5644 | @kindex C-c C-x > |
5645 | @item C-c C-x > | |
dbc28aaa CD |
5646 | Remove the permanent restriction created by @kbd{C-c C-x <}. |
5647 | @end table | |
5648 | ||
5649 | @noindent | |
5650 | When working with @file{Speedbar}, you can use the following commands in | |
a7808fba | 5651 | the Speedbar frame: |
dbc28aaa CD |
5652 | @table @kbd |
5653 | @kindex < | |
5654 | @item < @r{in the speedbar frame} | |
5655 | Permanently restrict the agenda to the item at the cursor in the | |
a7808fba | 5656 | Speedbar frame, either an Org file or a subtree in such a file. |
dbc28aaa CD |
5657 | If there is a window displaying an agenda view, the new restriction takes |
5658 | effect immediately. | |
67df9cfb | 5659 | @kindex > |
dbc28aaa CD |
5660 | @item > @r{in the speedbar frame} |
5661 | Lift the restriction again. | |
5662 | @end table | |
5663 | ||
a7808fba | 5664 | @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views |
4009494e GM |
5665 | @section The agenda dispatcher |
5666 | @cindex agenda dispatcher | |
5667 | @cindex dispatching agenda commands | |
5668 | The views are created through a dispatcher that should be bound to a | |
5669 | global key, for example @kbd{C-c a} (@pxref{Installation}). In the | |
5670 | following we will assume that @kbd{C-c a} is indeed how the dispatcher | |
5671 | is accessed and list keyboard access to commands accordingly. After | |
5672 | pressing @kbd{C-c a}, an additional letter is required to execute a | |
5673 | command. The dispatcher offers the following default commands: | |
5674 | @table @kbd | |
5675 | @item a | |
a7808fba | 5676 | Create the calendar-like agenda (@pxref{Weekly/daily agenda}). |
4009494e GM |
5677 | @item t @r{/} T |
5678 | Create a list of all TODO items (@pxref{Global TODO list}). | |
5679 | @item m @r{/} M | |
5680 | Create a list of headlines matching a TAGS expression (@pxref{Matching | |
5681 | tags and properties}). | |
5682 | @item L | |
5683 | Create the timeline view for the current buffer (@pxref{Timeline}). | |
28a16a1b CD |
5684 | @item s |
5685 | Create a list of entries selected by a boolean expression of keywords | |
5686 | and/or regular expressions that must or must not occur in the entry. | |
dbc28aaa CD |
5687 | @item / |
5688 | Search for a regular expression in all agenda files and additionally in | |
5689 | the files listed in @code{org-agenda-multi-occur-extra-files}. This | |
5690 | uses the Emacs command @code{multi-occur}. A prefix argument can be | |
5691 | used to specify the number of context lines for each match, default is | |
5692 | 1. | |
28a16a1b CD |
5693 | @item # @r{/} ! |
5694 | Create a list of stuck projects (@pxref{Stuck projects}). | |
dbc28aaa CD |
5695 | @item < |
5696 | Restrict an agenda command to the current buffer@footnote{For backward | |
5697 | compatibility, you can also press @kbd{1} to restrict to the current | |
5698 | buffer.}. After pressing @kbd{<}, you still need to press the character | |
5699 | selecting the command. | |
5700 | @item < < | |
4009494e | 5701 | If there is an active region, restrict the following agenda command to |
dbc28aaa CD |
5702 | the region. Otherwise, restrict it to the current subtree@footnote{For |
5703 | backward compatibility, you can also press @kbd{0} to restrict to the | |
5704 | current buffer.}. After pressing @kbd{< <}, you still need to press the | |
5705 | character selecting the command. | |
4009494e GM |
5706 | @end table |
5707 | ||
5708 | You can also define custom commands that will be accessible through the | |
5709 | dispatcher, just like the default commands. This includes the | |
5710 | possibility to create extended agenda buffers that contain several | |
5711 | blocks together, for example the weekly agenda, the global TODO list and | |
5712 | a number of special tags matches. @xref{Custom agenda views}. | |
5713 | ||
a7808fba | 5714 | @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views |
4009494e GM |
5715 | @section The built-in agenda views |
5716 | ||
5717 | In this section we describe the built-in views. | |
5718 | ||
5719 | @menu | |
a7808fba | 5720 | * Weekly/daily agenda:: The calendar page with current tasks |
4009494e GM |
5721 | * Global TODO list:: All unfinished action items |
5722 | * Matching tags and properties:: Structured information with fine-tuned search | |
5723 | * Timeline:: Time-sorted view for single file | |
28a16a1b | 5724 | * Keyword search:: Finding entries by keyword |
4009494e GM |
5725 | * Stuck projects:: Find projects you need to review |
5726 | @end menu | |
5727 | ||
a7808fba | 5728 | @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views |
4009494e GM |
5729 | @subsection The weekly/daily agenda |
5730 | @cindex agenda | |
5731 | @cindex weekly agenda | |
5732 | @cindex daily agenda | |
5733 | ||
5734 | The purpose of the weekly/daily @emph{agenda} is to act like a page of a | |
5735 | paper agenda, showing all the tasks for the current week or day. | |
5736 | ||
5737 | @table @kbd | |
5738 | @cindex org-agenda, command | |
5739 | @kindex C-c a a | |
5740 | @item C-c a a | |
864c9740 CD |
5741 | Compile an agenda for the current week from a list of org files. The agenda |
5742 | shows the entries for each day. With a numeric prefix@footnote{For backward | |
5743 | compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be | |
5744 | listed before the agenda. This feature is deprecated, use the dedicated TODO | |
5745 | list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1 | |
5746 | C-c a a}) you may set the number of days to be displayed (see also the | |
5747 | variable @code{org-agenda-ndays}) | |
4009494e GM |
5748 | @end table |
5749 | ||
5750 | Remote editing from the agenda buffer means, for example, that you can | |
5751 | change the dates of deadlines and appointments from the agenda buffer. | |
5752 | The commands available in the Agenda buffer are listed in @ref{Agenda | |
5753 | commands}. | |
5754 | ||
5755 | @subsubheading Calendar/Diary integration | |
5756 | @cindex calendar integration | |
5757 | @cindex diary integration | |
5758 | ||
5759 | Emacs contains the calendar and diary by Edward M. Reingold. The | |
5760 | calendar displays a three-month calendar with holidays from different | |
5761 | countries and cultures. The diary allows you to keep track of | |
5762 | anniversaries, lunar phases, sunrise/set, recurrent appointments | |
5763 | (weekly, monthly) and more. In this way, it is quite complementary to | |
a7808fba | 5764 | Org. It can be very useful to combine output from Org with |
4009494e GM |
5765 | the diary. |
5766 | ||
a7808fba | 5767 | In order to include entries from the Emacs diary into Org mode's |
4009494e GM |
5768 | agenda, you only need to customize the variable |
5769 | ||
5770 | @lisp | |
5771 | (setq org-agenda-include-diary t) | |
5772 | @end lisp | |
5773 | ||
5774 | @noindent After that, everything will happen automatically. All diary | |
5775 | entries including holidays, anniversaries etc will be included in the | |
a7808fba | 5776 | agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and |
4009494e GM |
5777 | @key{RET} can be used from the agenda buffer to jump to the diary |
5778 | file in order to edit existing diary entries. The @kbd{i} command to | |
5779 | insert new entries for the current date works in the agenda buffer, as | |
5780 | well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display | |
5781 | Sunrise/Sunset times, show lunar phases and to convert to other | |
5782 | calendars, respectively. @kbd{c} can be used to switch back and forth | |
5783 | between calendar and agenda. | |
5784 | ||
5785 | If you are using the diary only for sexp entries and holidays, it is | |
5786 | faster to not use the above setting, but instead to copy or even move | |
a7808fba | 5787 | the entries into an Org file. Org mode evaluates diary-style sexp |
4009494e GM |
5788 | entries, and does it faster because there is no overhead for first |
5789 | creating the diary display. Note that the sexp entries must start at | |
5790 | the left margin, no white space is allowed before them. For example, | |
a7808fba | 5791 | the following segment of an Org file will be processed and entries |
4009494e GM |
5792 | will be made in the agenda: |
5793 | ||
5794 | @example | |
5795 | * Birthdays and similar stuff | |
5796 | #+CATEGORY: Holiday | |
5797 | %%(org-calendar-holiday) ; special function for holiday names | |
5798 | #+CATEGORY: Ann | |
5799 | %%(diary-anniversary 14 5 1956) Arthur Dent is %d years old | |
5800 | %%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old | |
5801 | @end example | |
5802 | ||
dbc28aaa CD |
5803 | @subsubheading Appointment reminders |
5804 | @cindex @file{appt.el} | |
5805 | @cindex appointment reminders | |
5806 | ||
5807 | Org can interact with Emacs appointments notification facility. | |
5808 | ||
5809 | To add all the appointments of your agenda files, use the command | |
5810 | @code{org-agenda-to-appt}. This commands also lets you filter through | |
5811 | the list of your appointments and add only those belonging to a specific | |
5812 | category or matching a regular expression. See the docstring for | |
5813 | details. | |
5814 | ||
a7808fba | 5815 | @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views |
4009494e GM |
5816 | @subsection The global TODO list |
5817 | @cindex global TODO list | |
5818 | @cindex TODO list, global | |
5819 | ||
5820 | The global TODO list contains all unfinished TODO items, formatted and | |
5821 | collected into a single place. | |
5822 | ||
5823 | @table @kbd | |
5824 | @kindex C-c a t | |
5825 | @item C-c a t | |
5826 | Show the global TODO list. This collects the TODO items from all | |
a7808fba | 5827 | agenda files (@pxref{Agenda Views}) into a single buffer. The buffer is in |
4009494e GM |
5828 | @code{agenda-mode}, so there are commands to examine and manipulate |
5829 | the TODO entries directly from that buffer (@pxref{Agenda commands}). | |
5830 | @kindex C-c a T | |
5831 | @item C-c a T | |
5832 | @cindex TODO keyword matching | |
5833 | Like the above, but allows selection of a specific TODO keyword. You | |
5834 | can also do this by specifying a prefix argument to @kbd{C-c a t}. With | |
5835 | a @kbd{C-u} prefix you are prompted for a keyword, and you may also | |
5836 | specify several keywords by separating them with @samp{|} as boolean OR | |
5837 | operator. With a numeric prefix, the Nth keyword in | |
5838 | @code{org-todo-keywords} is selected. | |
5839 | @kindex r | |
5840 | The @kbd{r} key in the agenda buffer regenerates it, and you can give | |
5841 | a prefix argument to this command to change the selected TODO keyword, | |
5842 | for example @kbd{3 r}. If you often need a search for a specific | |
5843 | keyword, define a custom command for it (@pxref{Agenda dispatcher}).@* | |
5844 | Matching specific TODO keywords can also be done as part of a tags | |
5845 | search (@pxref{Tag searches}). | |
5846 | @end table | |
5847 | ||
5848 | Remote editing of TODO items means that you can change the state of a | |
5849 | TODO entry with a single key press. The commands available in the | |
5850 | TODO list are described in @ref{Agenda commands}. | |
5851 | ||
a7808fba CD |
5852 | @cindex sublevels, inclusion into TODO list |
5853 | Normally the global TODO list simply shows all headlines with TODO | |
4009494e GM |
5854 | keywords. This list can become very long. There are two ways to keep |
5855 | it more compact: | |
5856 | @itemize @minus | |
5857 | @item | |
5858 | Some people view a TODO item that has been @emph{scheduled} for | |
a7808fba | 5859 | execution (@pxref{Timestamps}) as no longer @emph{open}. Configure the |
4009494e GM |
5860 | variable @code{org-agenda-todo-ignore-scheduled} to exclude scheduled |
5861 | items from the global TODO list. | |
5862 | @item | |
5863 | TODO items may have sublevels to break up the task into subtasks. In | |
5864 | such cases it may be enough to list only the highest level TODO headline | |
5865 | and omit the sublevels from the global list. Configure the variable | |
5866 | @code{org-agenda-todo-list-sublevels} to get this behavior. | |
5867 | @end itemize | |
5868 | ||
5869 | @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views | |
a7808fba | 5870 | @subsection Matching tags and properties |
4009494e GM |
5871 | @cindex matching, of tags |
5872 | @cindex matching, of properties | |
5873 | @cindex tags view | |
864c9740 | 5874 | @cindex match view |
4009494e GM |
5875 | |
5876 | If headlines in the agenda files are marked with @emph{tags} | |
5877 | (@pxref{Tags}), you can select headlines based on the tags that apply | |
5878 | to them and collect them into an agenda buffer. | |
5879 | ||
5880 | @table @kbd | |
5881 | @kindex C-c a m | |
5882 | @item C-c a m | |
5883 | Produce a list of all headlines that match a given set of tags. The | |
5884 | command prompts for a selection criterion, which is a boolean logic | |
dbc28aaa CD |
5885 | expression with tags, like @samp{+work+urgent-withboss} or |
5886 | @samp{work|home} (@pxref{Tags}). If you often need a specific search, | |
4009494e GM |
5887 | define a custom command for it (@pxref{Agenda dispatcher}). |
5888 | @kindex C-c a M | |
5889 | @item C-c a M | |
5890 | Like @kbd{C-c a m}, but only select headlines that are also TODO items | |
5891 | and force checking subitems (see variable | |
a7808fba | 5892 | @code{org-tags-match-list-sublevels}). Matching specific TODO keywords |
4009494e GM |
5893 | together with a tags match is also possible, see @ref{Tag searches}. |
5894 | @end table | |
5895 | ||
5896 | The commands available in the tags list are described in @ref{Agenda | |
5897 | commands}. | |
5898 | ||
28a16a1b | 5899 | @node Timeline, Keyword search, Matching tags and properties, Built-in agenda views |
4009494e GM |
5900 | @subsection Timeline for a single file |
5901 | @cindex timeline, single file | |
5902 | @cindex time-sorted view | |
5903 | ||
a7808fba | 5904 | The timeline summarizes all time-stamped items from a single Org mode |
4009494e GM |
5905 | file in a @emph{time-sorted view}. The main purpose of this command is |
5906 | to give an overview over events in a project. | |
5907 | ||
5908 | @table @kbd | |
5909 | @kindex C-c a L | |
5910 | @item C-c a L | |
5911 | Show a time-sorted view of the org file, with all time-stamped items. | |
5912 | When called with a @kbd{C-u} prefix, all unfinished TODO entries | |
5913 | (scheduled or not) are also listed under the current date. | |
5914 | @end table | |
5915 | ||
5916 | @noindent | |
5917 | The commands available in the timeline buffer are listed in | |
5918 | @ref{Agenda commands}. | |
5919 | ||
28a16a1b CD |
5920 | @node Keyword search, Stuck projects, Timeline, Built-in agenda views |
5921 | @subsection Keyword search | |
5922 | @cindex keyword search | |
5923 | @cindex searching, for keywords | |
5924 | ||
a7808fba | 5925 | This agenda view is a general text search facility for Org mode entries. |
28a16a1b CD |
5926 | It is particularly useful to find notes. |
5927 | ||
5928 | @table @kbd | |
5929 | @kindex C-c a s | |
5930 | @item C-c a s | |
5931 | This is a special search that lets you select entries by keywords or | |
5932 | regular expression, using a boolean logic. For example, the search | |
5933 | string | |
5934 | ||
5935 | @example | |
5936 | +computer +wifi -ethernet -@{8\.11[bg]@} | |
5937 | @end example | |
4009494e | 5938 | |
28a16a1b CD |
5939 | @noindent |
5940 | will search for note entries that contain the keywords @code{computer} | |
5941 | and @code{wifi}, but not the keyword @code{ethernet}, and which are also | |
5942 | not matched by the regular expression @code{8\.11[bg]}, meaning to | |
5943 | exclude both 8.11b and 8.11g. | |
5944 | ||
5945 | Note that in addition to the agenda files, this command will also search | |
5946 | the files listed in @code{org-agenda-text-search-extra-files}. | |
5947 | @end table | |
5948 | ||
5949 | @node Stuck projects, , Keyword search, Built-in agenda views | |
4009494e GM |
5950 | @subsection Stuck projects |
5951 | ||
5952 | If you are following a system like David Allen's GTD to organize your | |
5953 | work, one of the ``duties'' you have is a regular review to make sure | |
5954 | that all projects move along. A @emph{stuck} project is a project that | |
5955 | has no defined next actions, so it will never show up in the TODO lists | |
a7808fba | 5956 | Org mode produces. During the review, you need to identify such |
4009494e GM |
5957 | projects and define next actions for them. |
5958 | ||
5959 | @table @kbd | |
5960 | @kindex C-c a # | |
5961 | @item C-c a # | |
5962 | List projects that are stuck. | |
5963 | @kindex C-c a ! | |
5964 | @item C-c a ! | |
5965 | Customize the variable @code{org-stuck-projects} to define what a stuck | |
5966 | project is and how to find it. | |
5967 | @end table | |
5968 | ||
5969 | You almost certainly will have to configure this view before it will | |
5970 | work for you. The built-in default assumes that all your projects are | |
5971 | level-2 headlines, and that a project is not stuck if it has at least | |
a7808fba | 5972 | one entry marked with a TODO keyword TODO or NEXT or NEXTACTION. |
4009494e | 5973 | |
864c9740 | 5974 | Let's assume that you, in your own way of using Org mode, identify |
a7808fba | 5975 | projects with a tag PROJECT, and that you use a TODO keyword MAYBE to |
864c9740 | 5976 | indicate a project that should not be considered yet. Let's further |
a7808fba | 5977 | assume that the TODO keyword DONE marks finished projects, and that NEXT |
4009494e GM |
5978 | and TODO indicate next actions. The tag @@SHOP indicates shopping and |
5979 | is a next action even without the NEXT tag. Finally, if the project | |
5980 | contains the special word IGNORE anywhere, it should not be listed | |
5981 | either. In this case you would start by identifying eligible projects | |
5982 | with a tags/todo match @samp{+PROJECT/-MAYBE-DONE}, and then check for | |
5983 | TODO, NEXT, @@SHOP, and IGNORE in the subtree to identify projects that | |
5984 | are not stuck. The correct customization for this is | |
5985 | ||
5986 | @lisp | |
5987 | (setq org-stuck-projects | |
5988 | '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP") | |
5989 | "\\<IGNORE\\>")) | |
5990 | @end lisp | |
5991 | ||
5992 | ||
a7808fba | 5993 | @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views |
4009494e GM |
5994 | @section Presentation and sorting |
5995 | @cindex presentation, of agenda items | |
5996 | ||
a7808fba | 5997 | Before displaying items in an agenda view, Org mode visually prepares |
4009494e GM |
5998 | the items and sorts them. Each item occupies a single line. The line |
5999 | starts with a @emph{prefix} that contains the @emph{category} | |
6000 | (@pxref{Categories}) of the item and other important information. You can | |
6001 | customize the prefix using the option @code{org-agenda-prefix-format}. | |
6002 | The prefix is followed by a cleaned-up version of the outline headline | |
6003 | associated with the item. | |
6004 | ||
6005 | @menu | |
6006 | * Categories:: Not all tasks are equal | |
6007 | * Time-of-day specifications:: How the agenda knows the time | |
6008 | * Sorting of agenda items:: The order of things | |
6009 | @end menu | |
6010 | ||
6011 | @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting | |
6012 | @subsection Categories | |
6013 | ||
6014 | @cindex category | |
6015 | The category is a broad label assigned to each agenda item. By default, | |
6016 | the category is simply derived from the file name, but you can also | |
dbc28aaa CD |
6017 | specify it with a special line in the buffer, like this@footnote{For |
6018 | backward compatibility, the following also works: If there are several | |
6019 | such lines in a file, each specifies the category for the text below it. | |
6020 | The first category also applies to any text before the first CATEGORY | |
6021 | line. However, using this method is @emph{strongly} deprecated as it is | |
6022 | incompatible with the outline structure of the document. The correct | |
6023 | method for setting multiple categories in a buffer is using a | |
6024 | property.}: | |
4009494e GM |
6025 | |
6026 | @example | |
6027 | #+CATEGORY: Thesis | |
6028 | @end example | |
6029 | ||
dbc28aaa CD |
6030 | @noindent |
6031 | If you would like to have a special CATEGORY for a single entry or a | |
55e0839d CD |
6032 | (sub)tree, give the entry a @code{:CATEGORY:} property with the |
6033 | special category you want to apply as the value. | |
dbc28aaa CD |
6034 | |
6035 | @noindent | |
6036 | The display in the agenda buffer looks best if the category is not | |
6037 | longer than 10 characters. | |
4009494e GM |
6038 | |
6039 | @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting | |
a7808fba | 6040 | @subsection Time-of-day specifications |
4009494e GM |
6041 | @cindex time-of-day specification |
6042 | ||
a7808fba | 6043 | Org mode checks each agenda item for a time-of-day specification. The |
4009494e GM |
6044 | time can be part of the time stamp that triggered inclusion into the |
6045 | agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time | |
6046 | ranges can be specified with two time stamps, like | |
6047 | @c | |
6048 | @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}. | |
6049 | ||
6050 | In the headline of the entry itself, a time(range) may also appear as | |
44ce9197 | 6051 | plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda |
a7808fba | 6052 | integrates the Emacs diary (@pxref{Weekly/daily agenda}), time |
4009494e GM |
6053 | specifications in diary entries are recognized as well. |
6054 | ||
a7808fba | 6055 | For agenda display, Org mode extracts the time and displays it in a |
4009494e GM |
6056 | standard 24 hour format as part of the prefix. The example times in |
6057 | the previous paragraphs would end up in the agenda like this: | |
6058 | ||
6059 | @example | |
6060 | 8:30-13:00 Arthur Dent lies in front of the bulldozer | |
6061 | 12:45...... Ford Prefect arrives and takes Arthur to the pub | |
6062 | 19:00...... The Vogon reads his poem | |
a50253cc | 6063 | 20:30-22:15 Marvin escorts the Hitchhikers to the bridge |
4009494e GM |
6064 | @end example |
6065 | ||
6066 | @cindex time grid | |
6067 | If the agenda is in single-day mode, or for the display of today, the | |
6068 | timed entries are embedded in a time grid, like | |
6069 | ||
6070 | @example | |
6071 | 8:00...... ------------------ | |
6072 | 8:30-13:00 Arthur Dent lies in front of the bulldozer | |
6073 | 10:00...... ------------------ | |
6074 | 12:00...... ------------------ | |
6075 | 12:45...... Ford Prefect arrives and takes Arthur to the pub | |
6076 | 14:00...... ------------------ | |
6077 | 16:00...... ------------------ | |
6078 | 18:00...... ------------------ | |
6079 | 19:00...... The Vogon reads his poem | |
6080 | 20:00...... ------------------ | |
2096a1b6 | 6081 | 20:30-22:15 Marvin escorts the Hitchhikers to the bridge |
4009494e GM |
6082 | @end example |
6083 | ||
6084 | The time grid can be turned on and off with the variable | |
6085 | @code{org-agenda-use-time-grid}, and can be configured with | |
6086 | @code{org-agenda-time-grid}. | |
6087 | ||
6088 | @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting | |
6089 | @subsection Sorting of agenda items | |
6090 | @cindex sorting, of agenda items | |
6091 | @cindex priorities, of agenda items | |
6092 | Before being inserted into a view, the items are sorted. How this is | |
6093 | done depends on the type of view. | |
6094 | @itemize @bullet | |
6095 | @item | |
6096 | For the daily/weekly agenda, the items for each day are sorted. The | |
6097 | default order is to first collect all items containing an explicit | |
6098 | time-of-day specification. These entries will be shown at the beginning | |
6099 | of the list, as a @emph{schedule} for the day. After that, items remain | |
6100 | grouped in categories, in the sequence given by @code{org-agenda-files}. | |
6101 | Within each category, items are sorted by priority (@pxref{Priorities}), | |
6102 | which is composed of the base priority (2000 for priority @samp{A}, 1000 | |
6103 | for @samp{B}, and 0 for @samp{C}), plus additional increments for | |
6104 | overdue scheduled or deadline items. | |
28a16a1b | 6105 | @item |
4009494e GM |
6106 | For the TODO list, items remain in the order of categories, but within |
6107 | each category, sorting takes place according to priority | |
6108 | (@pxref{Priorities}). | |
6109 | @item | |
6110 | For tags matches, items are not sorted at all, but just appear in the | |
6111 | sequence in which they are found in the agenda files. | |
6112 | @end itemize | |
6113 | ||
6114 | Sorting can be customized using the variable | |
a7808fba | 6115 | @code{org-agenda-sorting-strategy}, and may also include criteria based on |
71d35b24 | 6116 | the estimated effort of an entry (@pxref{Effort estimates}). |
4009494e | 6117 | |
a7808fba | 6118 | @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views |
4009494e GM |
6119 | @section Commands in the agenda buffer |
6120 | @cindex commands, in agenda buffer | |
6121 | ||
6122 | Entries in the agenda buffer are linked back to the org file or diary | |
6123 | file where they originate. You are not allowed to edit the agenda | |
6124 | buffer itself, but commands are provided to show and jump to the | |
6125 | original entry location, and to edit the org-files ``remotely'' from | |
6126 | the agenda buffer. In this way, all information is stored only once, | |
6127 | removing the risk that your agenda and note files may diverge. | |
6128 | ||
6129 | Some commands can be executed with mouse clicks on agenda lines. For | |
6130 | the other commands, the cursor needs to be in the desired line. | |
6131 | ||
6132 | @table @kbd | |
6133 | @tsubheading{Motion} | |
6134 | @cindex motion commands in agenda | |
6135 | @kindex n | |
6136 | @item n | |
dbc28aaa | 6137 | Next line (same as @key{up} and @kbd{C-p}). |
4009494e GM |
6138 | @kindex p |
6139 | @item p | |
dbc28aaa | 6140 | Previous line (same as @key{down} and @kbd{C-n}). |
a7808fba | 6141 | @tsubheading{View/Go to org file} |
4009494e GM |
6142 | @kindex mouse-3 |
6143 | @kindex @key{SPC} | |
6144 | @item mouse-3 | |
6145 | @itemx @key{SPC} | |
6146 | Display the original location of the item in another window. | |
b6cb4cd5 CD |
6147 | With prefix arg, make sure that the entire entry is made visible in the |
6148 | outline, not only the heading. | |
4009494e GM |
6149 | @c |
6150 | @kindex L | |
6151 | @item L | |
6152 | Display original location and recenter that window. | |
6153 | @c | |
6154 | @kindex mouse-2 | |
6155 | @kindex mouse-1 | |
6156 | @kindex @key{TAB} | |
6157 | @item mouse-2 | |
6158 | @itemx mouse-1 | |
6159 | @itemx @key{TAB} | |
6160 | Go to the original location of the item in another window. Under Emacs | |
6161 | 22, @kbd{mouse-1} will also works for this. | |
6162 | @c | |
6163 | @kindex @key{RET} | |
6164 | @itemx @key{RET} | |
6165 | Go to the original location of the item and delete other windows. | |
6166 | @c | |
6167 | @kindex f | |
6168 | @item f | |
6169 | Toggle Follow mode. In Follow mode, as you move the cursor through | |
6170 | the agenda buffer, the other window always shows the corresponding | |
6171 | location in the org file. The initial setting for this mode in new | |
6172 | agenda buffers can be set with the variable | |
6173 | @code{org-agenda-start-with-follow-mode}. | |
6174 | @c | |
6175 | @kindex b | |
6176 | @item b | |
a7808fba CD |
6177 | Display the entire subtree of the current item in an indirect buffer. With a |
6178 | numeric prefix argument N, go up to level N and then take that tree. If N is | |
6179 | negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the | |
6180 | previously used indirect buffer. | |
4009494e GM |
6181 | @c |
6182 | @kindex l | |
6183 | @item l | |
55e0839d | 6184 | Toggle Logbook mode. In Logbook mode, entries that were marked DONE while |
e45e3595 CD |
6185 | logging was on (variable @code{org-log-done}) are shown in the agenda, as are |
6186 | entries that have been clocked on that day. You can configure the entry | |
6187 | types that should be included in log mode using the variable | |
6188 | @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show | |
6189 | all possible logbook entries, including state changes. When called with two | |
6190 | prefix args @kbd{C-u C-u}, show only logging information, nothing else. | |
a7808fba | 6191 | @c |
44ce9197 CD |
6192 | @kindex v |
6193 | @item v | |
55e0839d CD |
6194 | Toggle Archives mode. In archives mode, trees that are marked |
6195 | @code{ARCHIVED} are also scanned when producing the agenda. When you call | |
6196 | this command with a @kbd{C-u} prefix argument, even all archive files are | |
6197 | included. To exit archives mode, press @kbd{v} again. | |
44ce9197 | 6198 | @c |
a7808fba CD |
6199 | @kindex R |
6200 | @item R | |
6201 | Toggle Clockreport mode. In clockreport mode, the daily/weekly agenda will | |
6202 | always show a table with the clocked times for the timespan and file scope | |
6203 | covered by the current agenda view. The initial setting for this mode in new | |
6204 | agenda buffers can be set with the variable | |
6205 | @code{org-agenda-start-with-clockreport-mode}. | |
4009494e GM |
6206 | |
6207 | @tsubheading{Change display} | |
6208 | @cindex display changing, in agenda | |
6209 | @kindex o | |
6210 | @item o | |
6211 | Delete other windows. | |
6212 | @c | |
6213 | @kindex d | |
6214 | @kindex w | |
6215 | @kindex m | |
6216 | @kindex y | |
6217 | @item d w m y | |
6218 | Switch to day/week/month/year view. When switching to day or week view, | |
a7808fba CD |
6219 | this setting becomes the default for subsequent agenda commands. Since |
6220 | month and year views are slow to create, they do not become the default. | |
6221 | A numeric prefix argument may be used to jump directly to a specific day | |
6222 | of the year, ISO week, month, or year, respectively. For example, | |
6223 | @kbd{32 d} jumps to February 1st, @kbd{9 w} to ISO week number 9. When | |
6224 | setting day, week, or month view, a year may be encoded in the prefix | |
6225 | argument as well. For example, @kbd{200712 w} will jump to week 12 in | |
6226 | 2007. If such a year specification has only one or two digits, it will | |
6227 | be mapped to the interval 1938-2037. | |
4009494e GM |
6228 | @c |
6229 | @kindex D | |
6230 | @item D | |
a7808fba | 6231 | Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}. |
4009494e | 6232 | @c |
28a16a1b CD |
6233 | @kindex G |
6234 | @item G | |
4009494e GM |
6235 | Toggle the time grid on and off. See also the variables |
6236 | @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}. | |
6237 | @c | |
6238 | @kindex r | |
6239 | @item r | |
6240 | Recreate the agenda buffer, for example to reflect the changes | |
6241 | after modification of the time stamps of items with S-@key{left} and | |
a7808fba | 6242 | S-@key{right}. When the buffer is the global TODO list, a prefix |
4009494e GM |
6243 | argument is interpreted to create a selective list for a specific TODO |
6244 | keyword. | |
28a16a1b CD |
6245 | @kindex g |
6246 | @item g | |
6247 | Same as @kbd{r}. | |
4009494e GM |
6248 | @c |
6249 | @kindex s | |
dbc28aaa | 6250 | @kindex C-x C-s |
4009494e | 6251 | @item s |
dbc28aaa | 6252 | @itemx C-x C-s |
a7808fba | 6253 | Save all Org buffers in the current Emacs session. |
4009494e GM |
6254 | @c |
6255 | @kindex @key{right} | |
6256 | @item @key{right} | |
6257 | Display the following @code{org-agenda-ndays} days. For example, if | |
6258 | the display covers a week, switch to the following week. With prefix | |
6259 | arg, go forward that many times @code{org-agenda-ndays} days. | |
6260 | @c | |
6261 | @kindex @key{left} | |
6262 | @item @key{left} | |
6263 | Display the previous dates. | |
6264 | @c | |
6265 | @kindex . | |
6266 | @item . | |
a7808fba CD |
6267 | Go to today. |
6268 | @c | |
6269 | @kindex C-c C-x C-c | |
6270 | @item C-c C-x C-c | |
6271 | Invoke column view (@pxref{Column view}) in the agenda buffer. The column | |
6272 | view format is taken from the entry at point, or (if there is no entry at | |
6273 | point), from the first entry in the agenda view. So whatever the format for | |
6274 | that entry would be in the original buffer (taken from a property, from a | |
6275 | @code{#+COLUMNS} line, or from the default variable | |
6276 | @code{org-columns-default-format}), will be used in the agenda. | |
4009494e | 6277 | |
864c9740 | 6278 | @tsubheading{Secondary filtering and query editing} |
71d35b24 CD |
6279 | @cindex filtering, by tag and effort, in agenda |
6280 | @cindex tag filtering, in agenda | |
6281 | @cindex effort filtering, in agenda | |
28a16a1b CD |
6282 | @cindex query editing, in agenda |
6283 | ||
864c9740 CD |
6284 | @kindex / |
6285 | @item / | |
71d35b24 CD |
6286 | Filter the current agenda view with respect to a tag and/or effort estimates. |
6287 | The difference between this and a custom agenda commands is that filtering is | |
6288 | very fast, so that you can switch quickly between different filters without | |
6289 | having to recreate the agenda. | |
6290 | ||
6291 | You will be prompted for a tag selection letter. Pressing @key{TAB} at that | |
6292 | prompt will offer use completion to select a tag (including any tags that do | |
6293 | not have a selection character). The command then hides all entries that do | |
6294 | not contain or inherit this tag. When called with prefix arg, remove the | |
6295 | entries that @emph{do} have the tag. A second @kbd{/} at the prompt will | |
6296 | turn off the filter and unhide any hidden entries. If the first key you | |
6297 | press is either @kbd{+} or @kbd{-}, the previous filter will be narrowed by | |
6298 | requiring or forbidding the selected additional tag. Instead of pressing | |
64fb801f CD |
6299 | @kbd{+} or @kbd{-} after @kbd{/}, you can also immediately use the @kbd{\} |
6300 | command. | |
71d35b24 CD |
6301 | |
6302 | In order to filter for effort estimates, you should set-up allowed | |
6303 | efforts globally, for example | |
6304 | @lisp | |
6305 | (setq org-global-properties | |
6306 | '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00"))) | |
6307 | @end lisp | |
6308 | You can then filter for an effort by first typing an operator, one of @kbd{<}, | |
6309 | @kbd{>}, and @kbd{=}, and then the one-digit index of an effort estimate in | |
6310 | your array of allowed values, where @kbd{0} means the 10th value. The filter | |
6311 | will then restrict to entries with effort smaller-or-equal, equal, or | |
6312 | larger-or-equal than the selected value. If the digits 0-9 are not used as | |
6313 | fast access keys to tags, you can also simply press the index digit directly | |
6314 | without an operator. In this case, @kbd{<} will be assumed. | |
6315 | ||
6316 | @kindex \ | |
6317 | @item \ | |
6318 | Narrow the current agenda filter by an additional condition. When called with | |
6319 | prefix arg, remove the entries that @emph{do} have the tag, or that do match | |
6320 | the effort criterion. You can achieve the same effect by pressing @kbd{+} or | |
6321 | @kbd{-} as the first key after the @kbd{/} command. | |
864c9740 | 6322 | |
28a16a1b CD |
6323 | @kindex [ |
6324 | @kindex ] | |
6325 | @kindex @{ | |
6326 | @kindex @} | |
6327 | @item [ ] @{ @} | |
864c9740 CD |
6328 | In the @i{search view} (@pxref{Keyword search}), these keys add new search |
6329 | words (@kbd{[} and @kbd{]}) or new regular expressions (@kbd{@{} and | |
6330 | @kbd{@}}) to the query string. The opening bracket/brace will add a positive | |
6331 | search term prefixed by @samp{+}, indicating that this search term @i{must} | |
6332 | occur/match in the entry. The closing bracket/brace will add a negative | |
6333 | search term which @i{must not} occur/match in the entry for it to be | |
6334 | selected. | |
28a16a1b CD |
6335 | |
6336 | ||
4009494e GM |
6337 | @tsubheading{Remote editing} |
6338 | @cindex remote editing, from agenda | |
6339 | ||
6340 | @item 0-9 | |
6341 | Digit argument. | |
6342 | @c | |
6343 | @cindex undoing remote-editing events | |
6344 | @cindex remote editing, undo | |
6345 | @kindex C-_ | |
6346 | @item C-_ | |
6347 | Undo a change due to a remote editing command. The change is undone | |
6348 | both in the agenda buffer and in the remote buffer. | |
6349 | @c | |
6350 | @kindex t | |
6351 | @item t | |
6352 | Change the TODO state of the item, both in the agenda and in the | |
6353 | original org file. | |
6354 | @c | |
6355 | @kindex C-k | |
6356 | @item C-k | |
6357 | Delete the current agenda item along with the entire subtree belonging | |
a7808fba | 6358 | to it in the original Org file. If the text to be deleted remotely |
4009494e GM |
6359 | is longer than one line, the kill needs to be confirmed by the user. See |
6360 | variable @code{org-agenda-confirm-kill}. | |
6361 | @c | |
a7808fba CD |
6362 | @kindex a |
6363 | @item a | |
6364 | Toggle the ARCHIVE tag for the current headline. | |
6365 | @c | |
6366 | @kindex A | |
6367 | @item A | |
b349f79f | 6368 | Move the subtree corresponding to the current entry to its @emph{Archive |
a7808fba CD |
6369 | Sibling}. |
6370 | @c | |
4009494e GM |
6371 | @kindex $ |
6372 | @item $ | |
a7808fba | 6373 | Archive the subtree corresponding to the current headline. This means the |
b349f79f | 6374 | entry will be moved to the configured archive location, most likely a |
a7808fba | 6375 | different file. |
4009494e GM |
6376 | @c |
6377 | @kindex T | |
6378 | @item T | |
96c8522a CD |
6379 | Show all tags associated with the current item. This is useful if you have |
6380 | turned off @code{org-agenda-show-inherited-tags}, but still want to see all | |
6381 | tags of a headline occasionally. | |
4009494e GM |
6382 | @c |
6383 | @kindex : | |
6384 | @item : | |
dbc28aaa CD |
6385 | Set tags for the current headline. If there is an active region in the |
6386 | agenda, change a tag for all headings in the region. | |
4009494e | 6387 | @c |
4009494e GM |
6388 | @kindex , |
6389 | @item , | |
a7808fba | 6390 | Set the priority for the current item. Org mode prompts for the |
4009494e GM |
6391 | priority character. If you reply with @key{SPC}, the priority cookie |
6392 | is removed from the entry. | |
6393 | @c | |
6394 | @kindex P | |
6395 | @item P | |
6396 | Display weighted priority of current item. | |
6397 | @c | |
6398 | @kindex + | |
6399 | @kindex S-@key{up} | |
6400 | @item + | |
6401 | @itemx S-@key{up} | |
6402 | Increase the priority of the current item. The priority is changed in | |
6403 | the original buffer, but the agenda is not resorted. Use the @kbd{r} | |
6404 | key for this. | |
6405 | @c | |
6406 | @kindex - | |
6407 | @kindex S-@key{down} | |
6408 | @item - | |
6409 | @itemx S-@key{down} | |
6410 | Decrease the priority of the current item. | |
6411 | @c | |
864c9740 CD |
6412 | @kindex C-c C-a |
6413 | @item C-c C-a | |
6414 | Dispatcher for all command related to attachments. | |
6415 | @c | |
4009494e GM |
6416 | @kindex C-c C-s |
6417 | @item C-c C-s | |
6418 | Schedule this item | |
6419 | @c | |
6420 | @kindex C-c C-d | |
6421 | @item C-c C-d | |
6422 | Set a deadline for this item. | |
6423 | @c | |
b349f79f CD |
6424 | @kindex k |
6425 | @item k | |
6426 | Agenda actions, to set dates for selected items to the cursor date. | |
6427 | This command also works in the calendar! The command prompts for an | |
a50253cc | 6428 | additional key: |
b349f79f CD |
6429 | @example |
6430 | m @r{Mark the entry at point for action. You can also make entries} | |
6431 | @r{in Org files with @kbd{C-c C-x C-k}.} | |
6432 | d @r{Set the deadline of the marked entry to the date at point.} | |
6433 | s @r{Schedule the marked entry at the date at point.} | |
6434 | r @r{Call @code{org-remember} with the cursor date as default date.} | |
6435 | @end example | |
a50253cc | 6436 | Press @kbd{r} afterward to refresh the agenda and see the effect of the |
b349f79f CD |
6437 | command. |
6438 | @c | |
4009494e GM |
6439 | @kindex S-@key{right} |
6440 | @item S-@key{right} | |
a7808fba CD |
6441 | Change the time stamp associated with the current line by one day into the |
6442 | future. With a numeric prefix argument, change it by that many days. For | |
6443 | example, @kbd{3 6 5 S-@key{right}} will change it by a year. The stamp is | |
6444 | changed in the original org file, but the change is not directly reflected in | |
6445 | the agenda buffer. Use the @kbd{r} key to update the buffer. | |
4009494e GM |
6446 | @c |
6447 | @kindex S-@key{left} | |
6448 | @item S-@key{left} | |
6449 | Change the time stamp associated with the current line by one day | |
6450 | into the past. | |
6451 | @c | |
6452 | @kindex > | |
6453 | @item > | |
6454 | Change the time stamp associated with the current line to today. | |
6455 | The key @kbd{>} has been chosen, because it is the same as @kbd{S-.} | |
6456 | on my keyboard. | |
6457 | @c | |
6458 | @kindex I | |
6459 | @item I | |
6460 | Start the clock on the current item. If a clock is running already, it | |
6461 | is stopped first. | |
6462 | @c | |
6463 | @kindex O | |
6464 | @item O | |
6465 | Stop the previously started clock. | |
6466 | @c | |
6467 | @kindex X | |
6468 | @item X | |
6469 | Cancel the currently running clock. | |
6470 | ||
dbc28aaa CD |
6471 | @kindex J |
6472 | @item J | |
6473 | Jump to the running clock in another window. | |
6474 | ||
4009494e GM |
6475 | @tsubheading{Calendar commands} |
6476 | @cindex calendar commands, from agenda | |
6477 | @kindex c | |
6478 | @item c | |
6479 | Open the Emacs calendar and move to the date at the agenda cursor. | |
6480 | @c | |
6481 | @item c | |
a7808fba | 6482 | When in the calendar, compute and show the Org mode agenda for the |
4009494e GM |
6483 | date at the cursor. |
6484 | @c | |
6485 | @cindex diary entries, creating from agenda | |
6486 | @kindex i | |
6487 | @item i | |
6488 | Insert a new entry into the diary. Prompts for the type of entry | |
6489 | (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new | |
6490 | entry in the diary, just as @kbd{i d} etc. would do in the calendar. | |
6491 | The date is taken from the cursor position. | |
6492 | @c | |
6493 | @kindex M | |
6494 | @item M | |
6495 | Show the phases of the moon for the three months around current date. | |
6496 | @c | |
6497 | @kindex S | |
6498 | @item S | |
6499 | Show sunrise and sunset times. The geographical location must be set | |
6500 | with calendar variables, see documentation of the Emacs calendar. | |
6501 | @c | |
6502 | @kindex C | |
6503 | @item C | |
6504 | Convert the date at cursor into many other cultural and historic | |
6505 | calendars. | |
6506 | @c | |
6507 | @kindex H | |
6508 | @item H | |
6509 | Show holidays for three month around the cursor date. | |
a7808fba CD |
6510 | |
6511 | @item M-x org-export-icalendar-combine-agenda-files | |
4009494e | 6512 | Export a single iCalendar file containing entries from all agenda files. |
a7808fba | 6513 | This is a globally available command, and also available in the agenda menu. |
4009494e GM |
6514 | |
6515 | @tsubheading{Exporting to a file} | |
6516 | @kindex C-x C-w | |
6517 | @item C-x C-w | |
6518 | @cindex exporting agenda views | |
6519 | @cindex agenda views, exporting | |
6520 | Write the agenda view to a file. Depending on the extension of the | |
6521 | selected file name, the view will be exported as HTML (extension | |
6522 | @file{.html} or @file{.htm}), Postscript (extension @file{.ps}), or | |
6523 | plain text (any other extension). Use the variable | |
6524 | @code{org-agenda-exporter-settings} to set options for @file{ps-print} | |
6525 | and for @file{htmlize} to be used during export. | |
6526 | ||
6527 | @tsubheading{Quit and Exit} | |
6528 | @kindex q | |
6529 | @item q | |
6530 | Quit agenda, remove the agenda buffer. | |
6531 | @c | |
6532 | @kindex x | |
6533 | @cindex agenda files, removing buffers | |
6534 | @item x | |
6535 | Exit agenda, remove the agenda buffer and all buffers loaded by Emacs | |
6536 | for the compilation of the agenda. Buffers created by the user to | |
6537 | visit org files will not be removed. | |
6538 | @end table | |
6539 | ||
6540 | ||
a7808fba | 6541 | @node Custom agenda views, Agenda column view, Agenda commands, Agenda Views |
4009494e GM |
6542 | @section Custom agenda views |
6543 | @cindex custom agenda views | |
6544 | @cindex agenda views, custom | |
6545 | ||
6546 | Custom agenda commands serve two purposes: to store and quickly access | |
6547 | frequently used TODO and tags searches, and to create special composite | |
6548 | agenda buffers. Custom agenda commands will be accessible through the | |
6549 | dispatcher (@pxref{Agenda dispatcher}), just like the default commands. | |
6550 | ||
6551 | @menu | |
6552 | * Storing searches:: Type once, use often | |
6553 | * Block agenda:: All the stuff you need in a single buffer | |
6554 | * Setting Options:: Changing the rules | |
a7808fba CD |
6555 | * Exporting Agenda Views:: Writing agendas to files |
6556 | * Using the agenda elsewhere:: Using agenda information in other programs | |
4009494e GM |
6557 | @end menu |
6558 | ||
6559 | @node Storing searches, Block agenda, Custom agenda views, Custom agenda views | |
6560 | @subsection Storing searches | |
6561 | ||
6562 | The first application of custom searches is the definition of keyboard | |
6563 | shortcuts for frequently used searches, either creating an agenda | |
6564 | buffer, or a sparse tree (the latter covering of course only the current | |
6565 | buffer). | |
6566 | @kindex C-c a C | |
6567 | Custom commands are configured in the variable | |
6568 | @code{org-agenda-custom-commands}. You can customize this variable, for | |
6569 | example by pressing @kbd{C-c a C}. You can also directly set it with | |
6570 | Emacs Lisp in @file{.emacs}. The following example contains all valid | |
6571 | search types: | |
6572 | ||
6573 | @lisp | |
6574 | @group | |
6575 | (setq org-agenda-custom-commands | |
6576 | '(("w" todo "WAITING") | |
6577 | ("W" todo-tree "WAITING") | |
dbc28aaa CD |
6578 | ("u" tags "+boss-urgent") |
6579 | ("v" tags-todo "+boss-urgent") | |
6580 | ("U" tags-tree "+boss-urgent") | |
6581 | ("f" occur-tree "\\<FIXME\\>") | |
6582 | ("h" . "HOME+Name tags searches") ; description for "h" prefix | |
6583 | ("hl" tags "+home+Lisa") | |
6584 | ("hp" tags "+home+Peter") | |
6585 | ("hk" tags "+home+Kim"))) | |
4009494e GM |
6586 | @end group |
6587 | @end lisp | |
6588 | ||
6589 | @noindent | |
dbc28aaa CD |
6590 | The initial string in each entry defines the keys you have to press |
6591 | after the dispatcher command @kbd{C-c a} in order to access the command. | |
6592 | Usually this will be just a single character, but if you have many | |
6593 | similar commands, you can also define two-letter combinations where the | |
6594 | first character is the same in several combinations and serves as a | |
6595 | prefix key@footnote{You can provide a description for a prefix key by | |
6596 | inserting a cons cell with the prefix and the description.}. The second | |
6597 | parameter is the search type, followed by the string or regular | |
6598 | expression to be used for the matching. The example above will | |
6599 | therefore define: | |
4009494e GM |
6600 | |
6601 | @table @kbd | |
6602 | @item C-c a w | |
6603 | as a global search for TODO entries with @samp{WAITING} as the TODO | |
6604 | keyword | |
6605 | @item C-c a W | |
6606 | as the same search, but only in the current buffer and displaying the | |
6607 | results as a sparse tree | |
6608 | @item C-c a u | |
dbc28aaa CD |
6609 | as a global tags search for headlines marked @samp{:boss:} but not |
6610 | @samp{:urgent:} | |
4009494e GM |
6611 | @item C-c a v |
6612 | as the same search as @kbd{C-c a u}, but limiting the search to | |
6613 | headlines that are also TODO items | |
6614 | @item C-c a U | |
6615 | as the same search as @kbd{C-c a u}, but only in the current buffer and | |
6616 | displaying the result as a sparse tree | |
6617 | @item C-c a f | |
6618 | to create a sparse tree (again: current buffer only) with all entries | |
dbc28aaa CD |
6619 | containing the word @samp{FIXME} |
6620 | @item C-c a h | |
6621 | as a prefix command for a HOME tags search where you have to press an | |
6622 | additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa, | |
6623 | Peter, or Kim) as additional tag to match. | |
4009494e GM |
6624 | @end table |
6625 | ||
6626 | @node Block agenda, Setting Options, Storing searches, Custom agenda views | |
6627 | @subsection Block agenda | |
6628 | @cindex block agenda | |
6629 | @cindex agenda, with block views | |
6630 | ||
6631 | Another possibility is the construction of agenda views that comprise | |
6632 | the results of @emph{several} commands, each of which creates a block in | |
6633 | the agenda buffer. The available commands include @code{agenda} for the | |
6634 | daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo} | |
a7808fba | 6635 | for the global TODO list (as constructed with @kbd{C-c a t}), and the |
4009494e GM |
6636 | matching commands discussed above: @code{todo}, @code{tags}, and |
6637 | @code{tags-todo}. Here are two examples: | |
6638 | ||
6639 | @lisp | |
6640 | @group | |
6641 | (setq org-agenda-custom-commands | |
6642 | '(("h" "Agenda and Home-related tasks" | |
28a16a1b | 6643 | ((agenda "") |
dbc28aaa CD |
6644 | (tags-todo "home") |
6645 | (tags "garden"))) | |
4009494e | 6646 | ("o" "Agenda and Office-related tasks" |
28a16a1b | 6647 | ((agenda "") |
dbc28aaa CD |
6648 | (tags-todo "work") |
6649 | (tags "office"))))) | |
4009494e GM |
6650 | @end group |
6651 | @end lisp | |
6652 | ||
6653 | @noindent | |
6654 | This will define @kbd{C-c a h} to create a multi-block view for stuff | |
6655 | you need to attend to at home. The resulting agenda buffer will contain | |
6656 | your agenda for the current week, all TODO items that carry the tag | |
dbc28aaa | 6657 | @samp{home}, and also all lines tagged with @samp{garden}. Finally the |
4009494e GM |
6658 | command @kbd{C-c a o} provides a similar view for office tasks. |
6659 | ||
4009494e | 6660 | @node Setting Options, Exporting Agenda Views, Block agenda, Custom agenda views |
a7808fba | 6661 | @subsection Setting options for custom commands |
4009494e GM |
6662 | @cindex options, for custom agenda views |
6663 | ||
a7808fba | 6664 | Org mode contains a number of variables regulating agenda construction |
4009494e GM |
6665 | and display. The global variables define the behavior for all agenda |
6666 | commands, including the custom commands. However, if you want to change | |
6667 | some settings just for a single custom view, you can do so. Setting | |
6668 | options requires inserting a list of variable names and values at the | |
6669 | right spot in @code{org-agenda-custom-commands}. For example: | |
6670 | ||
6671 | @lisp | |
6672 | @group | |
6673 | (setq org-agenda-custom-commands | |
6674 | '(("w" todo "WAITING" | |
6675 | ((org-agenda-sorting-strategy '(priority-down)) | |
6676 | (org-agenda-prefix-format " Mixed: "))) | |
dbc28aaa | 6677 | ("U" tags-tree "+boss-urgent" |
4009494e | 6678 | ((org-show-following-heading nil) |
28a16a1b CD |
6679 | (org-show-hierarchy-above nil))) |
6680 | ("N" search "" | |
6681 | ((org-agenda-files '("~org/notes.org")) | |
6682 | (org-agenda-text-search-extra-files nil))))) | |
4009494e GM |
6683 | @end group |
6684 | @end lisp | |
6685 | ||
6686 | @noindent | |
6687 | Now the @kbd{C-c a w} command will sort the collected entries only by | |
dbc28aaa | 6688 | priority, and the prefix format is modified to just say @samp{ Mixed: } |
4009494e GM |
6689 | instead of giving the category of the entry. The sparse tags tree of |
6690 | @kbd{C-c a U} will now turn out ultra-compact, because neither the | |
6691 | headline hierarchy above the match, nor the headline following the match | |
28a16a1b CD |
6692 | will be shown. The command @kbd{C-c a N} will do a text search limited |
6693 | to only a single file. | |
4009494e GM |
6694 | |
6695 | For command sets creating a block agenda, | |
6696 | @code{org-agenda-custom-commands} has two separate spots for setting | |
6697 | options. You can add options that should be valid for just a single | |
6698 | command in the set, and options that should be valid for all commands in | |
6699 | the set. The former are just added to the command entry, the latter | |
6700 | must come after the list of command entries. Going back to the block | |
6701 | agenda example (@pxref{Block agenda}), let's change the sorting strategy | |
6702 | for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort | |
6703 | the results for GARDEN tags query in the opposite order, | |
6704 | @code{priority-up}. This would look like this: | |
6705 | ||
6706 | @lisp | |
6707 | @group | |
6708 | (setq org-agenda-custom-commands | |
6709 | '(("h" "Agenda and Home-related tasks" | |
6710 | ((agenda) | |
dbc28aaa CD |
6711 | (tags-todo "home") |
6712 | (tags "garden" | |
4009494e GM |
6713 | ((org-agenda-sorting-strategy '(priority-up))))) |
6714 | ((org-agenda-sorting-strategy '(priority-down)))) | |
6715 | ("o" "Agenda and Office-related tasks" | |
6716 | ((agenda) | |
dbc28aaa CD |
6717 | (tags-todo "work") |
6718 | (tags "office"))))) | |
4009494e GM |
6719 | @end group |
6720 | @end lisp | |
6721 | ||
6722 | As you see, the values and parenthesis setting is a little complex. | |
6723 | When in doubt, use the customize interface to set this variable - it | |
6724 | fully supports its structure. Just one caveat: When setting options in | |
6725 | this interface, the @emph{values} are just lisp expressions. So if the | |
6726 | value is a string, you need to add the double quotes around the value | |
6727 | yourself. | |
6728 | ||
6729 | ||
a7808fba | 6730 | @node Exporting Agenda Views, Using the agenda elsewhere, Setting Options, Custom agenda views |
4009494e GM |
6731 | @subsection Exporting Agenda Views |
6732 | @cindex agenda views, exporting | |
6733 | ||
6734 | If you are away from your computer, it can be very useful to have a | |
a7808fba | 6735 | printed version of some agenda views to carry around. Org mode can |
4009494e | 6736 | export custom agenda views as plain text, HTML@footnote{You need to |
2096a1b6 | 6737 | install Hrvoje Niksic's @file{htmlize.el}.}, postscript, and iCalendar |
28a16a1b | 6738 | files. If you want to do this only occasionally, use the command |
4009494e GM |
6739 | |
6740 | @table @kbd | |
6741 | @kindex C-x C-w | |
6742 | @item C-x C-w | |
6743 | @cindex exporting agenda views | |
6744 | @cindex agenda views, exporting | |
6745 | Write the agenda view to a file. Depending on the extension of the | |
6746 | selected file name, the view will be exported as HTML (extension | |
28a16a1b CD |
6747 | @file{.html} or @file{.htm}), Postscript (extension @file{.ps}), |
6748 | iCalendar (extension @file{.ics}), or plain text (any other extension). | |
6749 | Use the variable @code{org-agenda-exporter-settings} to | |
6750 | set options for @file{ps-print} and for @file{htmlize} to be used during | |
6751 | export, for example | |
6752 | ||
4009494e GM |
6753 | @lisp |
6754 | (setq org-agenda-exporter-settings | |
6755 | '((ps-number-of-columns 2) | |
6756 | (ps-landscape-mode t) | |
6757 | (htmlize-output-type 'css))) | |
6758 | @end lisp | |
6759 | @end table | |
6760 | ||
6761 | If you need to export certain agenda views frequently, you can associate | |
6762 | any custom agenda command with a list of output file names | |
6763 | @footnote{If you want to store standard views like the weekly agenda | |
6764 | or the global TODO list as well, you need to define custom commands for | |
28a16a1b | 6765 | them in order to be able to specify file names.}. Here is an example |
4009494e GM |
6766 | that first does define custom commands for the agenda and the global |
6767 | todo list, together with a number of files to which to export them. | |
28a16a1b | 6768 | Then we define two block agenda commands and specify file names for them |
4009494e GM |
6769 | as well. File names can be relative to the current working directory, |
6770 | or absolute. | |
6771 | ||
6772 | @lisp | |
6773 | @group | |
6774 | (setq org-agenda-custom-commands | |
6775 | '(("X" agenda "" nil ("agenda.html" "agenda.ps")) | |
6776 | ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps")) | |
6777 | ("h" "Agenda and Home-related tasks" | |
28a16a1b | 6778 | ((agenda "") |
dbc28aaa CD |
6779 | (tags-todo "home") |
6780 | (tags "garden")) | |
4009494e GM |
6781 | nil |
6782 | ("~/views/home.html")) | |
6783 | ("o" "Agenda and Office-related tasks" | |
6784 | ((agenda) | |
dbc28aaa CD |
6785 | (tags-todo "work") |
6786 | (tags "office")) | |
4009494e | 6787 | nil |
28a16a1b | 6788 | ("~/views/office.ps" "~/calendars/office.ics")))) |
4009494e GM |
6789 | @end group |
6790 | @end lisp | |
6791 | ||
6792 | The extension of the file name determines the type of export. If it is | |
a7808fba | 6793 | @file{.html}, Org mode will use the @file{htmlize.el} package to convert |
4009494e GM |
6794 | the buffer to HTML and save it to this file name. If the extension is |
6795 | @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce | |
28a16a1b CD |
6796 | postscript output. If the extension is @file{.ics}, iCalendar export is |
6797 | run export over all files that were used to construct the agenda, and | |
6798 | limit the export to entries listed in the agenda now. Any other | |
6799 | extension produces a plain ASCII file. | |
4009494e GM |
6800 | |
6801 | The export files are @emph{not} created when you use one of those | |
28a16a1b CD |
6802 | commands interactively because this might use too much overhead. |
6803 | Instead, there is a special command to produce @emph{all} specified | |
6804 | files in one step: | |
4009494e GM |
6805 | |
6806 | @table @kbd | |
6807 | @kindex C-c a e | |
6808 | @item C-c a e | |
28a16a1b | 6809 | Export all agenda views that have export file names associated with |
4009494e GM |
6810 | them. |
6811 | @end table | |
6812 | ||
6813 | You can use the options section of the custom agenda commands to also | |
6814 | set options for the export commands. For example: | |
6815 | ||
6816 | @lisp | |
6817 | (setq org-agenda-custom-commands | |
6818 | '(("X" agenda "" | |
6819 | ((ps-number-of-columns 2) | |
6820 | (ps-landscape-mode t) | |
6821 | (org-agenda-prefix-format " [ ] ") | |
6822 | (org-agenda-with-colors nil) | |
6823 | (org-agenda-remove-tags t)) | |
6824 | ("theagenda.ps")))) | |
6825 | @end lisp | |
6826 | ||
6827 | @noindent | |
6828 | This command sets two options for the postscript exporter, to make it | |
6829 | print in two columns in landscape format - the resulting page can be cut | |
6830 | in two and then used in a paper agenda. The remaining settings modify | |
6831 | the agenda prefix to omit category and scheduling information, and | |
6832 | instead include a checkbox to check off items. We also remove the tags | |
6833 | to make the lines compact, and we don't want to use colors for the | |
6834 | black-and-white printer. Settings specified in | |
6835 | @code{org-agenda-exporter-settings} will also apply, but the settings | |
6836 | in @code{org-agenda-custom-commands} take precedence. | |
6837 | ||
6838 | @noindent | |
6839 | From the command line you may also use | |
6840 | @example | |
6841 | emacs -f org-batch-store-agenda-views -kill | |
6842 | @end example | |
6843 | @noindent | |
71d35b24 CD |
6844 | or, if you need to modify some parameters@footnote{Quoting may depend on the |
6845 | system you use, please check th FAQ for examples.} | |
4009494e GM |
6846 | @example |
6847 | emacs -eval '(org-batch-store-agenda-views \ | |
6848 | org-agenda-ndays 30 \ | |
dbc28aaa | 6849 | org-agenda-start-day "2007-11-01" \ |
4009494e GM |
6850 | org-agenda-include-diary nil \ |
6851 | org-agenda-files (quote ("~/org/project.org")))' \ | |
6852 | -kill | |
6853 | @end example | |
6854 | @noindent | |
6855 | which will create the agenda views restricted to the file | |
6856 | @file{~/org/project.org}, without diary entries and with 30 days | |
28a16a1b | 6857 | extent. |
4009494e | 6858 | |
a7808fba CD |
6859 | @node Using the agenda elsewhere, , Exporting Agenda Views, Custom agenda views |
6860 | @subsection Using agenda information outside of Org | |
4009494e GM |
6861 | @cindex agenda, pipe |
6862 | @cindex Scripts, for agenda processing | |
6863 | ||
a7808fba | 6864 | Org provides commands to access agenda information for the command |
4009494e GM |
6865 | line in emacs batch mode. This extracted information can be sent |
6866 | directly to a printer, or it can be read by a program that does further | |
6867 | processing of the data. The first of these commands is the function | |
6868 | @code{org-batch-agenda}, that produces an agenda view and sends it as | |
6869 | ASCII text to STDOUT. The command takes a single string as parameter. | |
6870 | If the string has length 1, it is used as a key to one of the commands | |
6871 | you have configured in @code{org-agenda-custom-commands}, basically any | |
6872 | key you can use after @kbd{C-c a}. For example, to directly print the | |
6873 | current TODO list, you could use | |
6874 | ||
6875 | @example | |
6876 | emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr | |
6877 | @end example | |
6878 | ||
6879 | If the parameter is a string with 2 or more characters, it is used as a | |
6880 | tags/todo match string. For example, to print your local shopping list | |
6881 | (all items with the tag @samp{shop}, but excluding the tag | |
6882 | @samp{NewYork}), you could use | |
6883 | ||
6884 | @example | |
28a16a1b | 6885 | emacs -batch -l ~/.emacs \ |
4009494e GM |
6886 | -eval '(org-batch-agenda "+shop-NewYork")' | lpr |
6887 | @end example | |
6888 | ||
6889 | @noindent | |
6890 | You may also modify parameters on the fly like this: | |
6891 | ||
6892 | @example | |
6893 | emacs -batch -l ~/.emacs \ | |
6894 | -eval '(org-batch-agenda "a" \ | |
6895 | org-agenda-ndays 30 \ | |
6896 | org-agenda-include-diary nil \ | |
6897 | org-agenda-files (quote ("~/org/project.org")))' \ | |
6898 | | lpr | |
6899 | @end example | |
6900 | ||
6901 | @noindent | |
6902 | which will produce a 30 day agenda, fully restricted to the Org file | |
6903 | @file{~/org/projects.org}, not even including the diary. | |
6904 | ||
6905 | If you want to process the agenda data in more sophisticated ways, you | |
6906 | can use the command @code{org-batch-agenda-csv} to get a comma-separated | |
6907 | list of values for each agenda item. Each line in the output will | |
6908 | contain a number of fields separated by commas. The fields in a line | |
6909 | are: | |
6910 | ||
6911 | @example | |
6912 | category @r{The category of the item} | |
6913 | head @r{The headline, without TODO kwd, TAGS and PRIORITY} | |
6914 | type @r{The type of the agenda entry, can be} | |
6915 | todo @r{selected in TODO match} | |
6916 | tagsmatch @r{selected in tags match} | |
6917 | diary @r{imported from diary} | |
6918 | deadline @r{a deadline} | |
6919 | scheduled @r{scheduled} | |
6920 | timestamp @r{appointment, selected by timestamp} | |
6921 | closed @r{entry was closed on date} | |
6922 | upcoming-deadline @r{warning about nearing deadline} | |
6923 | past-scheduled @r{forwarded scheduled item} | |
6924 | block @r{entry has date block including date} | |
a7808fba | 6925 | todo @r{The TODO keyword, if any} |
4009494e GM |
6926 | tags @r{All tags including inherited ones, separated by colons} |
6927 | date @r{The relevant date, like 2007-2-14} | |
6928 | time @r{The time, like 15:00-16:50} | |
6929 | extra @r{String with extra planning info} | |
6930 | priority-l @r{The priority letter if any was given} | |
6931 | priority-n @r{The computed numerical priority} | |
6932 | @end example | |
6933 | ||
6934 | @noindent | |
6935 | Time and date will only be given if a timestamp (or deadline/scheduled) | |
6936 | lead to the selection of the item. | |
6937 | ||
6938 | A CSV list like this is very easy to use in a post processing script. | |
6939 | For example, here is a Perl program that gets the TODO list from | |
a7808fba | 6940 | Emacs/Org and prints all the items, preceded by a checkbox: |
4009494e GM |
6941 | |
6942 | @example | |
6943 | @group | |
6944 | #!/usr/bin/perl | |
6945 | ||
6946 | # define the Emacs command to run | |
6947 | $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'"; | |
6948 | ||
6949 | # run it and capture the output | |
6950 | $agenda = qx@{$cmd 2>/dev/null@}; | |
6951 | ||
6952 | # loop over all lines | |
6953 | foreach $line (split(/\n/,$agenda)) @{ | |
6954 | ||
6955 | # get the individual values | |
6956 | ($category,$head,$type,$todo,$tags,$date,$time,$extra, | |
6957 | $priority_l,$priority_n) = split(/,/,$line); | |
6958 | ||
a50253cc | 6959 | # process and print |
4009494e GM |
6960 | print "[ ] $head\n"; |
6961 | @} | |
6962 | @end group | |
6963 | @end example | |
6964 | ||
a7808fba CD |
6965 | @node Agenda column view, , Custom agenda views, Agenda Views |
6966 | @section Using column view in the agenda | |
6967 | @cindex column view, in agenda | |
6968 | @cindex agenda, column view | |
6969 | ||
6970 | Column view (@pxref{Column view}) is normally used to view and edit | |
6971 | properties embedded in the hierarchical structure of an Org file. It can be | |
6972 | quite useful to use column view also from the agenda, where entries are | |
6973 | collected by certain criteria. | |
6974 | ||
6975 | @table @kbd | |
6976 | @kindex C-c C-x C-c | |
6977 | @item C-c C-x C-c | |
6978 | Turn on column view in the agenda. | |
6979 | @end table | |
6980 | ||
6981 | To understand how to use this properly, it is important to realize that the | |
6982 | entries in the agenda are no longer in their proper outline environment. | |
6983 | This causes the following issues: | |
6984 | ||
6985 | @enumerate | |
6986 | @item | |
6987 | Org needs to make a decision which @code{COLUMNS} format to use. Since the | |
6988 | entries in the agenda are collected from different files, and different files | |
6989 | may have different @code{COLUMNS} formats, this is a non-trivial problem. | |
6990 | Org first checks if the variable @code{org-overriding-columns-format} is | |
6991 | currently set, and if yes takes the format from there. Otherwise it takes | |
6992 | the format associated with the first item in the agenda, or, if that item | |
6993 | does not have a specific format (defined in a property, or in it's file), it | |
6994 | uses @code{org-columns-default-format}. | |
6995 | @item | |
6996 | If any of the columns has a summary type defined (@pxref{Column attributes}), | |
6997 | turning on column view in the agenda will visit all relevant agenda files and | |
6998 | make sure that the computations of this property are up to date. This is | |
6999 | also true for the special @code{CLOCKSUM} property. Org will then sum the | |
7000 | values displayed in the agenda. In the daily/weekly agenda, the sums will | |
7001 | cover a single day, in all other views they cover the entire block. It is | |
7002 | vital to realize that the agenda may show the same entry @emph{twice} (for | |
7003 | example as scheduled and as a deadline), and it may show two entries from the | |
7004 | same hierarchy (for example a @emph{parent} and it's @emph{child}). In these | |
7005 | cases, the summation in the agenda will lead to incorrect results because | |
7006 | some values will count double. | |
7007 | @item | |
7008 | When the column view in the agenda shows the @code{CLOCKSUM}, that is always | |
7009 | the entire clocked time for this item. So even in the daily/weekly agenda, | |
7010 | the clocksum listed in column view may originate from times outside the | |
7011 | current view. This has the advantage that you can compare these values with | |
7012 | a column listing the planned total effort for a task - one of the major | |
7013 | applications for column view in the agenda. If you want information about | |
7014 | clocked time in the displayed period use clock table mode (press @kbd{R} in | |
7015 | the agenda). | |
7016 | @end enumerate | |
7017 | ||
7018 | ||
7019 | @node Embedded LaTeX, Exporting, Agenda Views, Top | |
4009494e GM |
7020 | @chapter Embedded LaTeX |
7021 | @cindex @TeX{} interpretation | |
7022 | @cindex La@TeX{} interpretation | |
7023 | ||
7024 | Plain ASCII is normally sufficient for almost all note taking. One | |
a7808fba CD |
7025 | exception, however, are scientific notes which need to be able to contain |
7026 | mathematical symbols and the occasional formula. La@TeX{}@footnote{La@TeX{} | |
7027 | is a macro system based on Donald E. Knuth's @TeX{} system. Many of the | |
7028 | features described here as ``La@TeX{}'' are really from @TeX{}, but for | |
7029 | simplicity I am blurring this distinction.} is widely used to typeset | |
7030 | scientific documents. Org mode supports embedding La@TeX{} code into its | |
7031 | files, because many academics are used to reading La@TeX{} source code, and | |
7032 | because it can be readily processed into images for HTML production. | |
4009494e GM |
7033 | |
7034 | It is not necessary to mark La@TeX{} macros and code in any special way. | |
a7808fba | 7035 | If you observe a few conventions, Org mode knows how to find it and what |
4009494e GM |
7036 | to do with it. |
7037 | ||
7038 | @menu | |
7039 | * Math symbols:: TeX macros for symbols and Greek letters | |
a7808fba | 7040 | * Subscripts and superscripts:: Simple syntax for raising/lowering text |
4009494e GM |
7041 | * LaTeX fragments:: Complex formulas made easy |
7042 | * Processing LaTeX fragments:: Previewing LaTeX processing | |
7043 | * CDLaTeX mode:: Speed up entering of formulas | |
7044 | @end menu | |
7045 | ||
a7808fba | 7046 | @node Math symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX |
4009494e GM |
7047 | @section Math symbols |
7048 | @cindex math symbols | |
7049 | @cindex TeX macros | |
7050 | ||
55e0839d CD |
7051 | You can use La@TeX{} macros to insert special symbols like @samp{\alpha} to |
7052 | indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion | |
7053 | for these macros is available, just type @samp{\} and maybe a few letters, | |
7054 | and press @kbd{M-@key{TAB}} to see possible completions. Unlike La@TeX{} | |
7055 | code, Org mode allows these macros to be present without surrounding math | |
7056 | delimiters, for example: | |
4009494e GM |
7057 | |
7058 | @example | |
7059 | Angles are written as Greek letters \alpha, \beta and \gamma. | |
7060 | @end example | |
7061 | ||
7062 | During HTML export (@pxref{HTML export}), these symbols are translated | |
7063 | into the proper syntax for HTML, for the above examples this is | |
864c9740 CD |
7064 | @samp{α} and @samp{→}, respectively. If you need such a symbol |
7065 | inside a word, terminate it like this: @samp{\Aacute@{@}stor}. | |
4009494e | 7066 | |
a7808fba CD |
7067 | @node Subscripts and superscripts, LaTeX fragments, Math symbols, Embedded LaTeX |
7068 | @section Subscripts and superscripts | |
4009494e GM |
7069 | @cindex subscript |
7070 | @cindex superscript | |
7071 | ||
7072 | Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super- | |
7073 | and subscripts. Again, these can be used without embedding them in | |
7074 | math-mode delimiters. To increase the readability of ASCII text, it is | |
7075 | not necessary (but OK) to surround multi-character sub- and superscripts | |
7076 | with curly braces. For example | |
7077 | ||
7078 | @example | |
7079 | The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of | |
7080 | the sun is R_@{sun@} = 6.96 x 10^8 m. | |
7081 | @end example | |
7082 | ||
7083 | To avoid interpretation as raised or lowered text, you can quote | |
7084 | @samp{^} and @samp{_} with a backslash: @samp{\_} and @samp{\^}. | |
7085 | ||
7086 | During HTML export (@pxref{HTML export}), subscript and superscripts | |
7087 | are surrounded with @code{<sub>} and @code{<sup>} tags, respectively. | |
7088 | ||
a7808fba | 7089 | @node LaTeX fragments, Processing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX |
4009494e GM |
7090 | @section LaTeX fragments |
7091 | @cindex LaTeX fragments | |
7092 | ||
7093 | With symbols, sub- and superscripts, HTML is pretty much at its end when | |
7094 | it comes to representing mathematical formulas@footnote{Yes, there is | |
7095 | MathML, but that is not yet fully supported by many browsers, and there | |
7096 | is no decent converter for turning La@TeX{} or ASCII representations of | |
7097 | formulas into MathML. So for the time being, converting formulas into | |
7098 | images seems the way to go.}. More complex expressions need a dedicated | |
a7808fba | 7099 | formula processor. To this end, Org mode can contain arbitrary La@TeX{} |
4009494e GM |
7100 | fragments. It provides commands to preview the typeset result of these |
7101 | fragments, and upon export to HTML, all fragments will be converted to | |
7102 | images and inlined into the HTML document@footnote{The La@TeX{} export | |
7103 | will not use images for displaying La@TeX{} fragments but include these | |
7104 | fragments directly into the La@TeX{} code.}. For this to work you | |
7105 | need to be on a system with a working La@TeX{} installation. You also | |
7106 | need the @file{dvipng} program, available at | |
7107 | @url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that | |
7108 | will be used when processing a fragment can be configured with the | |
7109 | variable @code{org-format-latex-header}. | |
7110 | ||
7111 | La@TeX{} fragments don't need any special marking at all. The following | |
7112 | snippets will be identified as La@TeX{} source code: | |
7113 | @itemize @bullet | |
7114 | @item | |
7115 | Environments of any kind. The only requirement is that the | |
7116 | @code{\begin} statement appears on a new line, preceded by only | |
7117 | whitespace. | |
7118 | @item | |
7119 | Text within the usual La@TeX{} math delimiters. To avoid conflicts with | |
55e0839d CD |
7120 | currency specifications, single @samp{$} characters are only recognized as |
7121 | math delimiters if the enclosed text contains at most two line breaks, is | |
7122 | directly attached to the @samp{$} characters with no whitespace in between, | |
7123 | and if the closing @samp{$} is followed by whitespace, punctuation or a dash. | |
7124 | For the other delimiters, there is no such restriction, so when in doubt, use | |
7125 | @samp{\(...\)} as inline math delimiters. | |
4009494e GM |
7126 | @end itemize |
7127 | ||
7128 | @noindent For example: | |
7129 | ||
7130 | @example | |
7131 | \begin@{equation@} % arbitrary environments, | |
7132 | x=\sqrt@{b@} % even tables, figures | |
7133 | \end@{equation@} % etc | |
7134 | ||
7135 | If $a^2=b$ and \( b=2 \), then the solution must be | |
7136 | either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \]. | |
7137 | @end example | |
7138 | ||
7139 | @noindent | |
7140 | If you need any of the delimiter ASCII sequences for other purposes, you | |
7141 | can configure the option @code{org-format-latex-options} to deselect the | |
7142 | ones you do not wish to have interpreted by the La@TeX{} converter. | |
7143 | ||
7144 | @node Processing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX | |
7145 | @section Processing LaTeX fragments | |
7146 | @cindex LaTeX fragments, preview | |
7147 | ||
7148 | La@TeX{} fragments can be processed to produce a preview images of the | |
7149 | typeset expressions: | |
7150 | ||
7151 | @table @kbd | |
7152 | @kindex C-c C-x C-l | |
7153 | @item C-c C-x C-l | |
7154 | Produce a preview image of the La@TeX{} fragment at point and overlay it | |
7155 | over the source code. If there is no fragment at point, process all | |
7156 | fragments in the current entry (between two headlines). When called | |
7157 | with a prefix argument, process the entire subtree. When called with | |
7158 | two prefix arguments, or when the cursor is before the first headline, | |
7159 | process the entire buffer. | |
7160 | @kindex C-c C-c | |
7161 | @item C-c C-c | |
7162 | Remove the overlay preview images. | |
7163 | @end table | |
7164 | ||
7165 | During HTML export (@pxref{HTML export}), all La@TeX{} fragments are | |
7166 | converted into images and inlined into the document if the following | |
7167 | setting is active: | |
7168 | ||
7169 | @lisp | |
7170 | (setq org-export-with-LaTeX-fragments t) | |
7171 | @end lisp | |
7172 | ||
7173 | @node CDLaTeX mode, , Processing LaTeX fragments, Embedded LaTeX | |
7174 | @section Using CDLaTeX to enter math | |
7175 | @cindex CDLaTeX | |
7176 | ||
a7808fba | 7177 | CDLaTeX mode is a minor mode that is normally used in combination with a |
4009494e | 7178 | major La@TeX{} mode like AUCTeX in order to speed-up insertion of |
a7808fba CD |
7179 | environments and math templates. Inside Org mode, you can make use of |
7180 | some of the features of CDLaTeX mode. You need to install | |
4009494e GM |
7181 | @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with |
7182 | AUCTeX) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}. | |
a7808fba CD |
7183 | Don't use CDLaTeX mode itself under Org mode, but use the light |
7184 | version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it | |
4009494e | 7185 | on for the current buffer with @code{M-x org-cdlatex-mode}, or for all |
a7808fba | 7186 | Org files with |
4009494e GM |
7187 | |
7188 | @lisp | |
7189 | (add-hook 'org-mode-hook 'turn-on-org-cdlatex) | |
7190 | @end lisp | |
7191 | ||
7192 | When this mode is enabled, the following features are present (for more | |
a7808fba | 7193 | details see the documentation of CDLaTeX mode): |
4009494e GM |
7194 | @itemize @bullet |
7195 | @kindex C-c @{ | |
7196 | @item | |
7197 | Environment templates can be inserted with @kbd{C-c @{}. | |
7198 | @item | |
7199 | @kindex @key{TAB} | |
7200 | The @key{TAB} key will do template expansion if the cursor is inside a | |
a7808fba | 7201 | La@TeX{} fragment@footnote{Org mode has a method to test if the cursor is |
4009494e GM |
7202 | inside such a fragment, see the documentation of the function |
7203 | @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will | |
7204 | expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor | |
7205 | correctly inside the first brace. Another @key{TAB} will get you into | |
7206 | the second brace. Even outside fragments, @key{TAB} will expand | |
7207 | environment abbreviations at the beginning of a line. For example, if | |
7208 | you write @samp{equ} at the beginning of a line and press @key{TAB}, | |
7209 | this abbreviation will be expanded to an @code{equation} environment. | |
7210 | To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}. | |
7211 | @item | |
7212 | @kindex _ | |
7213 | @kindex ^ | |
7214 | Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these | |
7215 | characters together with a pair of braces. If you use @key{TAB} to move | |
7216 | out of the braces, and if the braces surround only a single character or | |
7217 | macro, they are removed again (depending on the variable | |
7218 | @code{cdlatex-simplify-sub-super-scripts}). | |
7219 | @item | |
7220 | @kindex ` | |
7221 | Pressing the backquote @kbd{`} followed by a character inserts math | |
7222 | macros, also outside La@TeX{} fragments. If you wait more than 1.5 seconds | |
7223 | after the backquote, a help window will pop up. | |
7224 | @item | |
7225 | @kindex ' | |
7226 | Pressing the normal quote @kbd{'} followed by another character modifies | |
7227 | the symbol before point with an accent or a font. If you wait more than | |
7228 | 1.5 seconds after the backquote, a help window will pop up. Character | |
7229 | modification will work only inside La@TeX{} fragments, outside the quote | |
7230 | is normal. | |
7231 | @end itemize | |
7232 | ||
7233 | @node Exporting, Publishing, Embedded LaTeX, Top | |
7234 | @chapter Exporting | |
7235 | @cindex exporting | |
7236 | ||
a7808fba | 7237 | Org mode documents can be exported into a variety of other formats. For |
4009494e | 7238 | printing and sharing of notes, ASCII export produces a readable and |
a7808fba | 7239 | simple version of an Org file. HTML export allows you to publish a |
4009494e GM |
7240 | notes file on the web, while the XOXO format provides a solid base for |
7241 | exchange with a broad range of other applications. La@TeX{} export lets | |
a7808fba | 7242 | you use Org mode and its structured editing functions to easily create |
4009494e GM |
7243 | La@TeX{} files. To incorporate entries with associated times like |
7244 | deadlines or appointments into a desktop calendar program like iCal, | |
a7808fba CD |
7245 | Org mode can also produce extracts in the iCalendar format. Currently |
7246 | Org mode only supports export, not import of these different formats. | |
4009494e | 7247 | |
b6cb4cd5 CD |
7248 | Org supports export of selected regions when @code{transient-mark-mode} is |
7249 | enabled (default in Emacs 23). | |
7250 | ||
b349f79f CD |
7251 | @menu |
7252 | * Markup rules:: Which structures are recognized? | |
864c9740 | 7253 | * Selective export:: Using tags to select and exclude trees |
b349f79f CD |
7254 | * Export options:: Per-file export settings |
7255 | * The export dispatcher:: How to access exporter commands | |
7256 | * ASCII export:: Exporting to plain ASCII | |
7257 | * HTML export:: Exporting to HTML | |
71d35b24 | 7258 | * LaTeX and PDF export:: Exporting to LaTeX, and processing to PDF |
b349f79f CD |
7259 | * XOXO export:: Exporting to XOXO |
7260 | * iCalendar export:: Exporting in iCalendar format | |
7261 | @end menu | |
7262 | ||
864c9740 | 7263 | @node Markup rules, Selective export, Exporting, Exporting |
b349f79f CD |
7264 | @section Markup rules |
7265 | ||
7266 | When exporting Org mode documents, the exporter tries to reflect the | |
7267 | structure of the document as accurately as possible in the back-end. Since | |
7268 | export targets like HTML or La@TeX{} allow much richer formatting, Org mode | |
7269 | has rules how to prepare text for rich export. This section summarizes the | |
7270 | markup rule used in an Org mode buffer. | |
7271 | ||
7272 | @menu | |
7273 | * Document title:: How the document title is determined | |
7274 | * Headings and sections:: The main structure of the exported document | |
7275 | * Table of contents:: If, where, how to create a table of contents | |
7276 | * Initial text:: Text before the first headline | |
7277 | * Lists:: Plain lists are exported | |
7278 | * Paragraphs:: What determines beginning and ending | |
7279 | * Literal examples:: Source code and other examples | |
7280 | * Include files:: Include the contents of a file during export | |
7281 | * Tables exported:: Tables are exported richly | |
67df9cfb | 7282 | * Inlined images:: How to inline images during export |
55e0839d | 7283 | * Footnote markup:: |
b349f79f CD |
7284 | * Emphasis and monospace:: To bold or not to bold |
7285 | * TeX macros and LaTeX fragments:: Create special, rich export. | |
7286 | * Horizontal rules:: A line across the page | |
7287 | * Comment lines:: Some lines will not be exported | |
7288 | @end menu | |
7289 | ||
7290 | @node Document title, Headings and sections, Markup rules, Markup rules | |
7291 | @subheading Document title | |
7292 | @cindex document title, markup rules | |
7293 | ||
7294 | @noindent | |
7295 | The title of the exported document is taken from the special line | |
7296 | ||
7297 | @example | |
7298 | #+TITLE: This is the title of the document | |
7299 | @end example | |
7300 | ||
7301 | @noindent | |
7302 | If this line does not exist, the title is derived from the first non-empty, | |
7303 | non-comment line in the buffer. If no such line exists, or if you have | |
7304 | turned off exporting of the text before the first headline (see below), the | |
7305 | title will be the file name without extension. | |
7306 | ||
7307 | If you are exporting only a subtree by marking is as the region, the heading | |
7308 | of the subtree will become the title of the document. If the subtree has a | |
7309 | property @code{EXPORT_TITLE}, that will take precedence. | |
7310 | ||
7311 | @node Headings and sections, Table of contents, Document title, Markup rules | |
7312 | @subheading Headings and sections | |
7313 | @cindex headings and sections, markup rules | |
7314 | ||
7315 | The outline structure of the document as described in @ref{Document | |
7316 | Structure} forms the basis for defining sections of the exported document. | |
7317 | However, since the outline structure is also used for (for example) lists of | |
7318 | tasks, only the first three outline levels will be used as headings. Deeper | |
7319 | levels will become itemized lists. You can change the location of this | |
7320 | switch, globally by setting the variable @code{org-headline-levels}, or on a | |
7321 | per file basis with a line | |
7322 | ||
7323 | @example | |
7324 | #+OPTIONS: H:4 | |
7325 | @end example | |
7326 | ||
7327 | @node Table of contents, Initial text, Headings and sections, Markup rules | |
7328 | @subheading Table of contents | |
7329 | @cindex table of contents, markup rules | |
7330 | ||
7331 | The table of contents is normally inserted directly before the first headline | |
7332 | of the file. If you would like to get it to a different location, insert the | |
7333 | string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired | |
7334 | location. The depth of the table of contents is by default the same as the | |
7335 | number of headline levels, but you can choose a smaller number or turn off | |
7336 | the table of contents entirely by configuring the variable | |
7337 | @code{org-export-with-toc}, or on a per-file basis with a line like | |
7338 | ||
7339 | @example | |
7340 | #+OPTIONS: toc:2 (only to two levels in TOC) | |
7341 | #+OPTIONS: toc:nil (no TOC at all) | |
7342 | @end example | |
7343 | ||
7344 | @node Initial text, Lists, Table of contents, Markup rules | |
7345 | @subheading Text before the first headline | |
7346 | @cindex text before first headline, markup rules | |
7347 | @cindex #+TEXT | |
7348 | ||
7349 | Org mode normally exports the text before the first headline, and even uses | |
7350 | the first line as the document title. The text will be fully marked up. If | |
7351 | you need to include literal HTML or La@TeX{} code, use the special constructs | |
7352 | described below in the sections for the individual exporters. | |
7353 | ||
7354 | Some people like to use the space before the first headline for setup and | |
7355 | internal links and therefore would like to control the exported text before | |
7356 | the first headline in a different way. You can do so by setting the variable | |
7357 | @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file | |
7358 | basis, you can get the same effect with @samp{#+OPTIONS: skip:t}. | |
7359 | ||
7360 | @noindent | |
7361 | If you still want to have some text before the first headline, use the | |
7362 | @code{#+TEXT} construct: | |
7363 | ||
7364 | @example | |
7365 | #+OPTIONS: skip:t | |
7366 | #+TEXT: This text will go before the *first* headline. | |
7367 | #+TEXT: [TABLE-OF-CONTENTS] | |
7368 | #+TEXT: This goes between the table of contents and the first headline | |
7369 | @end example | |
7370 | ||
7371 | @node Lists, Paragraphs, Initial text, Markup rules | |
7372 | @subheading Lists | |
7373 | @cindex lists, markup rules | |
7374 | ||
7375 | Plain lists as described in @ref{Plain lists} are translated to the back-ends | |
7376 | syntax for such lists. Most back-ends support unordered, ordered, and | |
7377 | description lists. | |
7378 | ||
7379 | @node Paragraphs, Literal examples, Lists, Markup rules | |
7380 | @subheading Paragraphs, line breaks, and quoting | |
7381 | @cindex paragraphs, markup rules | |
7382 | ||
7383 | Paragraphs are separated by at least one empty line. If you need to enforce | |
7384 | a line break within a paragraph, use @samp{\\} at the end of a line. | |
7385 | ||
7386 | To keep the line breaks in a region, but otherwise use normal formatting, you | |
7387 | can use this construct, which can also be used to format poetry. | |
7388 | ||
7389 | @example | |
7390 | #+BEGIN_VERSE | |
864c9740 CD |
7391 | Great clouds overhead |
7392 | Tiny black birds rise and fall | |
7393 | Snow covers Emacs | |
96c8522a | 7394 | |
864c9740 | 7395 | -- AlexSchroeder |
b349f79f CD |
7396 | #+END_VERSE |
7397 | @end example | |
7398 | ||
7399 | When quoting a passage from another document, it is customary to format this | |
7400 | as a paragraph that is indented on both the left and the right margin. You | |
7401 | can include quotations in Org mode documents like this: | |
7402 | ||
7403 | @example | |
7404 | #+BEGIN_QUOTE | |
7405 | Everything should be made as simple as possible, | |
7406 | but not any simpler -- Albert Einstein | |
7407 | #+END_QUOTE | |
7408 | @end example | |
7409 | ||
7410 | ||
7411 | @node Literal examples, Include files, Paragraphs, Markup rules | |
7412 | @subheading Literal examples | |
7413 | @cindex literal examples, markup rules | |
55e0839d | 7414 | @cindex code line refenences, markup rules |
b349f79f CD |
7415 | |
7416 | You can include literal examples that should not be subjected to | |
7417 | markup. Such examples will be typeset in monospace, so this is well suited | |
7418 | for source code and similar examples. | |
7419 | @cindex #+BEGIN_EXAMPLE | |
7420 | ||
7421 | @example | |
7422 | #+BEGIN_EXAMPLE | |
7423 | Some example from a text file. | |
7424 | #+END_EXAMPLE | |
7425 | @end example | |
7426 | ||
7427 | For simplicity when using small examples, you can also start the example | |
55e0839d CD |
7428 | lines with a colon followed by a space. There may also be additional |
7429 | whitespace before the colon: | |
b349f79f CD |
7430 | |
7431 | @example | |
55e0839d CD |
7432 | Here is an example |
7433 | : Some example from a text file. | |
b349f79f CD |
7434 | @end example |
7435 | ||
7436 | @cindex formatting source code, markup rules | |
7437 | If the example is source code from a programming language, or any other text | |
7438 | that can be marked up by font-lock in Emacs, you can ask for the example to | |
7439 | look like the fontified Emacs buffer@footnote{Currently this works only for | |
7440 | the HTML back-end, and requires the @file{htmlize.el} package version 1.34 or | |
7441 | later.}. This is done with the @samp{src} block, where you also need to | |
7442 | specify the name of the major mode that should be used to fontify the | |
7443 | example: | |
7444 | @cindex #+BEGIN_SRC | |
7445 | ||
7446 | @example | |
7447 | #+BEGIN_SRC emacs-lisp | |
7448 | (defun org-xor (a b) | |
7449 | "Exclusive or." | |
7450 | (if a (not b) b)) | |
7451 | #+END_SRC | |
7452 | @end example | |
7453 | ||
55e0839d CD |
7454 | Both in @code{example} and in @code{src} snippets, you can add a @code{-n} |
7455 | switch to the end of the @code{BEGIN} line, to get the lines of the example | |
7456 | numbered. If you use a @code{+n} switch, the numbering from the previous | |
7457 | numbered snippet will be continued in the current one. In literal examples, | |
7458 | Org will interpret strings like @samp{(ref:name)} as labels, and use them as | |
7459 | targets for special hyperlinks like @code{[[(name)]]} (i.e. the reference | |
2096a1b6 | 7460 | name enclosed in single parenthesis). In HTML, hovering the mouse over such |
55e0839d CD |
7461 | a link will remote-highlight the corresponding code line, which is kind of |
7462 | cool. If the example/src snippet is numbered, you can also add a @code{-r} | |
7463 | switch. Then labels will be @i{removed} from the source code and the links | |
7464 | will be @i{replaced}@footnote{If you want to explain the use of such labels | |
7465 | themelves in org-mode example code, you can use the @code{-k} switch to make | |
7466 | sure they are not touched.} with line numbers from the code listing. Here is | |
7467 | an example: | |
7468 | ||
7469 | @example | |
7470 | #+BEGIN_SRC emacs-lisp -n -r | |
7471 | (save-excursion (ref:sc) | |
7472 | (goto-char (point-min)) (ref:jump) | |
7473 | #+END SRC | |
7474 | In line [[(sc)]] we remember the current positon. [[(jump)][Line (jump)]] | |
7475 | jumps to point-min. | |
7476 | @end example | |
7477 | ||
7478 | If the syntax for the label format conflicts with the language syntax, use a | |
7479 | @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal | |
7480 | -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}. | |
7481 | ||
2096a1b6 GM |
7482 | HTML export also allows examples to be published as text areas, @pxref{Text |
7483 | areas in HTML export}. | |
55e0839d | 7484 | |
b349f79f CD |
7485 | @table @kbd |
7486 | @kindex C-c ' | |
7487 | @item C-c ' | |
7488 | Edit the source code example at point in its native mode. This works by | |
7489 | switching to an indirect buffer, narrowing the buffer and switching to the | |
864c9740 CD |
7490 | other mode. You need to exit by pressing @kbd{C-c '} again@footnote{Upon |
7491 | exit, lines starting with @samp{*} or @samp{#} will get a comma prepended, to | |
7492 | keep them from being interpreted by Org as outline nodes or special | |
7493 | comments. These commas will be striped for editing with @kbd{C-c '}, and | |
7494 | also for export.}. Fixed-width | |
7495 | regions (where each line starts with a colon followed by a space) will be | |
7496 | edited using @code{artist-mode}@footnote{You may select a different-mode with | |
7497 | the variable @code{org-edit-fixed-width-region-mode}.} to allow creating | |
7498 | ASCII drawings easily. Using this command in an empty line will create a new | |
7499 | fixed-width region. | |
55e0839d CD |
7500 | @kindex C-c l |
7501 | @item C-c l | |
7502 | Calling @code{org-store-link} while editing a source code example in a | |
7503 | temporary buffer created with @kbd{C-c '} will prompt for a label, make sure | |
7504 | that it is unique in the current buffer, and insert it with the proper | |
7505 | formatting like @samp{(ref:label)} at the end of the current line. Then the | |
7506 | label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}. | |
b349f79f CD |
7507 | @end table |
7508 | ||
7509 | ||
7510 | @node Include files, Tables exported, Literal examples, Markup rules | |
7511 | @subheading Include files | |
7512 | @cindex include files, markup rules | |
7513 | ||
7514 | During export, you can include the content of another file. For example, to | |
7515 | include your .emacs file, you could use: | |
7516 | @cindex #+INCLUDE | |
7517 | ||
7518 | @example | |
7519 | #+INCLUDE: "~/.emacs" src emacs-lisp | |
7520 | @end example | |
7521 | ||
7522 | The optional second and third parameter are the markup (@samp{quote}, | |
7523 | @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the | |
7524 | language for formatting the contents. The markup is optional, if it is not | |
7525 | given, the text will be assumed to be in Org mode format and will be | |
44ce9197 CD |
7526 | processed normally. The include line will also allow additional keyword |
7527 | parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the | |
55e0839d CD |
7528 | first line and for each following line, as well as any options accepted by |
7529 | the selected markup. For example, to include a file as an item, use | |
44ce9197 CD |
7530 | |
7531 | @example | |
7532 | #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " " | |
7533 | @end example | |
b349f79f CD |
7534 | |
7535 | @table @kbd | |
7536 | @kindex C-c ' | |
7537 | @item C-c ' | |
7538 | Visit the include file at point. | |
7539 | @end table | |
7540 | ||
67df9cfb | 7541 | @node Tables exported, Inlined images, Include files, Markup rules |
b349f79f CD |
7542 | @subheading Tables |
7543 | @cindex tables, markup rules | |
7544 | ||
7545 | Both the native Org mode tables (@pxref{Tables}) and tables formatted with | |
7546 | the @file{table.el} package will be exported properly. For Org mode tables, | |
7547 | the lines before the first horizontal separator line will become table header | |
a50253cc | 7548 | lines. You can use the following lines somewhere before the table to assign |
67df9cfb CD |
7549 | a caption and a label for cross references: |
7550 | ||
7551 | @example | |
7552 | #+CAPTION: This is the caption for the next table (or link) | |
7553 | #+LABEL: tbl:basic-data | |
7554 | @end example | |
7555 | ||
55e0839d | 7556 | @node Inlined images, Footnote markup, Tables exported, Markup rules |
67df9cfb CD |
7557 | @subheading Inlined Images |
7558 | @cindex inlined images, markup rules | |
7559 | ||
7560 | Some backends (HTML and LaTeX) allow to directly include images into the | |
7561 | exported document. Org does this, if a link to an image files does not have | |
7562 | a description part, for example @code{[[./img/a.jpg]]}. If you wish to | |
7563 | define a caption for the image and maybe a label for internal cross | |
7564 | references, you can use (before, but close to the link) | |
7565 | ||
7566 | @example | |
7567 | #+CAPTION: This is the caption for the next figure link (or table) | |
7568 | #+LABEL: fig:SED-HR4049 | |
7569 | @end example | |
b349f79f | 7570 | |
67df9cfb CD |
7571 | You may also define additional attributes for the figure. As this is |
7572 | backend-specific, see the sections about the individual backends for more | |
7573 | information. | |
7574 | ||
55e0839d CD |
7575 | @node Footnote markup, Emphasis and monospace, Inlined images, Markup rules |
7576 | @subheading Footnote markup | |
b349f79f CD |
7577 | @cindex footnotes, markup rules |
7578 | @cindex @file{footnote.el} | |
7579 | ||
55e0839d CD |
7580 | Footnotes defined in the way descriped in @ref{Footnotes} will be exported by |
7581 | all backends. Org does allow multiple references to the same note, and | |
7582 | different backends support this to varying degree. | |
b349f79f | 7583 | |
55e0839d | 7584 | @node Emphasis and monospace, TeX macros and LaTeX fragments, Footnote markup, Markup rules |
b349f79f CD |
7585 | @subheading Emphasis and monospace |
7586 | ||
7587 | @cindex underlined text, markup rules | |
7588 | @cindex bold text, markup rules | |
7589 | @cindex italic text, markup rules | |
7590 | @cindex verbatim text, markup rules | |
7591 | @cindex code text, markup rules | |
7592 | @cindex strike-through text, markup rules | |
7593 | You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=} | |
7594 | and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text | |
7595 | in the code and verbatim string is not processed for Org mode specific | |
7596 | syntax, it is exported verbatim. | |
7597 | ||
7598 | @node TeX macros and LaTeX fragments, Horizontal rules, Emphasis and monospace, Markup rules | |
7599 | @subheading @TeX{} macros and La@TeX{} fragments | |
7600 | @cindex LaTeX fragments, markup rules | |
7601 | @cindex TeX macros, markup rules | |
7602 | @cindex HTML entities | |
7603 | @cindex LaTeX entities | |
7604 | ||
7605 | A @TeX{}-like syntax is used to specify special characters. Where possible, | |
7606 | these will be transformed into the native format of the exporter back-end. | |
7607 | Strings like @code{\alpha} will be exported as @code{α} in the HTML | |
7608 | output, and as @code{$\alpha$} in the La@TeX{} output. Similarly, | |
7609 | @code{\nbsp} will become @code{ } in HTML and @code{~} in La@TeX{}. | |
7610 | This applies for a large number of entities, with names taken from both HTML | |
7611 | and La@TeX{}, see the variable @code{org-html-entities} for the complete | |
7612 | list. If you are unsure about a name, use @kbd{M-@key{TAB}} for completion | |
55e0839d | 7613 | after having typed the backslash and maybe a few characters |
b349f79f CD |
7614 | (@pxref{Completion}). |
7615 | ||
7616 | La@TeX{} fragments are converted into images for HTML export, and they are | |
7617 | written literally into the La@TeX{} export. See also @ref{Embedded LaTeX}. | |
7618 | ||
7619 | Finally, @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and | |
7620 | @samp{...} are all converted into special commands creating hyphens of | |
7621 | different lengths or a compact set of dots. | |
7622 | ||
7623 | @node Horizontal rules, Comment lines, TeX macros and LaTeX fragments, Markup rules | |
7624 | @subheading Horizontal rules | |
7625 | @cindex horizontal rules, markup rules | |
7626 | A line consisting of only dashes, and at least 5 of them, will be | |
7627 | exported as a horizontal line (@samp{<hr/>} in HTML). | |
7628 | ||
7629 | @node Comment lines, , Horizontal rules, Markup rules | |
7630 | @subheading Comment lines | |
7631 | @cindex comment lines | |
7632 | @cindex exporting, not | |
7633 | ||
7634 | Lines starting with @samp{#} in column zero are treated as comments and will | |
7635 | never be exported. Also entire subtrees starting with the word | |
7636 | @samp{COMMENT} will never be exported. Finally, regions surrounded by | |
7637 | @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported. | |
7638 | ||
7639 | @table @kbd | |
7640 | @kindex C-c ; | |
7641 | @item C-c ; | |
7642 | Toggle the COMMENT keyword at the beginning of an entry. | |
7643 | @end table | |
7644 | ||
864c9740 CD |
7645 | @node Selective export, Export options, Markup rules, Exporting |
7646 | @section Selective export | |
7647 | @cindex export, selective by tags | |
7648 | ||
7649 | You may use tags to select the parts of a document that should be exported, | |
7650 | or to exclude parts from export. This behavior is governed by two variables: | |
7651 | @code{org-export-select-tags} and @code{org-export-exclude-tags}. | |
7652 | ||
7653 | Org first checks if any of the @emph{select} tags is present in the buffer. | |
7654 | If yes, all trees that do not carry one of these tags will be excluded. If a | |
7655 | selected tree is a subtree, the heading hierarchy above it will also be | |
7656 | selected for export, but not the text below those headings. | |
7657 | ||
7658 | @noindent | |
7659 | If none of the select tags is found, the whole buffer will be selected for | |
7660 | export. | |
7661 | ||
7662 | @noindent | |
7663 | Finally, all subtrees that are marked by any of the @emph{exclude} tags will | |
7664 | be removed from the export buffer. | |
7665 | ||
7666 | @node Export options, The export dispatcher, Selective export, Exporting | |
b349f79f CD |
7667 | @section Export options |
7668 | @cindex options, for export | |
7669 | ||
7670 | @cindex completion, of option keywords | |
7671 | The exporter recognizes special lines in the buffer which provide | |
7672 | additional information. These lines may be put anywhere in the file. | |
7673 | The whole set of lines can be inserted into the buffer with @kbd{C-c | |
7674 | C-e t}. For individual lines, a good way to make sure the keyword is | |
7675 | correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion | |
7676 | (@pxref{Completion}). | |
7677 | ||
7678 | @table @kbd | |
7679 | @kindex C-c C-e t | |
7680 | @item C-c C-e t | |
7681 | Insert template with export options, see example below. | |
7682 | @end table | |
7683 | ||
7684 | @cindex #+TITLE: | |
7685 | @cindex #+AUTHOR: | |
7686 | @cindex #+DATE: | |
7687 | @cindex #+EMAIL: | |
7688 | @cindex #+LANGUAGE: | |
7689 | @cindex #+TEXT: | |
7690 | @cindex #+OPTIONS: | |
7691 | @cindex #+LINK_UP: | |
7692 | @cindex #+LINK_HOME: | |
864c9740 CD |
7693 | @cindex #+EXPORT_SELECT_TAGS: |
7694 | @cindex #+EXPORT_EXCLUDE_TAGS: | |
b349f79f CD |
7695 | @example |
7696 | #+TITLE: the title to be shown (default is the buffer name) | |
7697 | #+AUTHOR: the author (default taken from @code{user-full-name}) | |
7698 | #+DATE: A date, fixed, of a format string for @code{format-time-string} | |
7699 | #+EMAIL: his/her email address (default from @code{user-mail-address}) | |
7700 | #+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language}) | |
7701 | #+TEXT: Some descriptive text to be inserted at the beginning. | |
7702 | #+TEXT: Several lines may be given. | |
7703 | #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ... | |
7704 | #+LINK_UP: the ``up'' link of an exported page | |
7705 | #+LINK_HOME: the ``home'' link of an exported page | |
864c9740 CD |
7706 | #+EXPORT_SELECT_TAGS: Tags that select a tree for export |
7707 | #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export | |
b349f79f CD |
7708 | @end example |
7709 | ||
7710 | @noindent | |
7711 | The OPTIONS line is a compact@footnote{If you want to configure many options | |
7712 | this way, you can use several OPTIONS lines.} form to specify export settings. Here | |
7713 | you can: | |
7714 | @cindex headline levels | |
7715 | @cindex section-numbers | |
7716 | @cindex table of contents | |
7717 | @cindex line-break preservation | |
7718 | @cindex quoted HTML tags | |
7719 | @cindex fixed-width sections | |
7720 | @cindex tables | |
7721 | @cindex @TeX{}-like syntax for sub- and superscripts | |
7722 | @cindex footnotes | |
7723 | @cindex special strings | |
7724 | @cindex emphasized text | |
7725 | @cindex @TeX{} macros | |
7726 | @cindex La@TeX{} fragments | |
7727 | @cindex author info, in export | |
7728 | @cindex time info, in export | |
7729 | @example | |
7730 | H: @r{set the number of headline levels for export} | |
7731 | num: @r{turn on/off section-numbers} | |
7732 | toc: @r{turn on/off table of contents, or set level limit (integer)} | |
7733 | \n: @r{turn on/off line-break-preservation} | |
7734 | @@: @r{turn on/off quoted HTML tags} | |
7735 | :: @r{turn on/off fixed-width sections} | |
7736 | |: @r{turn on/off tables} | |
7737 | ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If} | |
7738 | @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but} | |
7739 | @r{the simple @code{a_b} will be left as it is.} | |
7740 | -: @r{turn on/off conversion of special strings.} | |
7741 | f: @r{turn on/off footnotes like this[1].} | |
96c8522a CD |
7742 | todo: @r{turn on/off inclusion of TODO keywords into exported text} |
7743 | pri: @r{turn on/off priority cookies} | |
7744 | tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}} | |
7745 | <: @r{turn on/off inclusion of any time/date stamps like DEADLINES} | |
b349f79f CD |
7746 | *: @r{turn on/off emphasized text (bold, italic, underlined)} |
7747 | TeX: @r{turn on/off simple @TeX{} macros in plain text} | |
7748 | LaTeX: @r{turn on/off La@TeX{} fragments} | |
7749 | skip: @r{turn on/off skipping the text before the first heading} | |
7750 | author: @r{turn on/off inclusion of author name/email into exported file} | |
dd12e1c6 | 7751 | creator: @r{turn on/off inclusion of creator info into exported file} |
b349f79f CD |
7752 | timestamp: @r{turn on/off inclusion creation time into exported file} |
7753 | d: @r{turn on/off inclusion of drawers} | |
7754 | @end example | |
7755 | ||
7756 | These options take effect in both the HTML and La@TeX{} export, except | |
7757 | for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and | |
7758 | @code{nil} for the La@TeX{} export. | |
7759 | ||
7760 | When exporting only a single subtree by selecting it with @kbd{C-c @@} before | |
7761 | calling an export command, the subtree can overrule some of the file's export | |
7762 | settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE}, | |
7763 | @code{EXPORT_TEXT}, and @code{EXPORT_OPTIONS}. | |
7764 | ||
7765 | @node The export dispatcher, ASCII export, Export options, Exporting | |
7766 | @section The export dispatcher | |
7767 | @cindex dispatcher, for export commands | |
7768 | ||
7769 | All export commands can be reached using the export dispatcher, which is a | |
7770 | prefix key that prompts for an additional key specifying the command. | |
7771 | Normally the entire file is exported, but if there is an active region that | |
7772 | contains one outline tree, the first heading is used as document title and | |
7773 | the subtrees are exported. | |
4009494e GM |
7774 | |
7775 | @table @kbd | |
7776 | @kindex C-c C-e | |
7777 | @item C-c C-e | |
7778 | Dispatcher for export and publishing commands. Displays a help-window | |
7779 | listing the additional key(s) needed to launch an export or publishing | |
64fb801f CD |
7780 | command. The prefix arg is passed through to the exporter. A double prefix |
7781 | @kbd{C-u C-u} causes most commands to be executed in the background, in a | |
7782 | separate emacs process@footnote{To make this behavior the default, customize | |
7783 | the variable @code{org-export-run-in-background}.}. | |
b349f79f CD |
7784 | @kindex C-c C-e v |
7785 | @item C-c C-e v | |
7786 | Like @kbd{C-c C-e}, but only export the text that is currently visible | |
7787 | (i.e. not hidden by outline visibility). | |
a7808fba CD |
7788 | @kindex C-u C-u C-c C-e |
7789 | @item C-u C-u C-c C-e | |
7790 | Call an the exporter, but reverse the setting of | |
7791 | @code{org-export-run-in-background}, i.e. request background processing if | |
7792 | not set, or force processing in the current Emacs process if st. | |
4009494e GM |
7793 | @end table |
7794 | ||
b349f79f | 7795 | @node ASCII export, HTML export, The export dispatcher, Exporting |
4009494e GM |
7796 | @section ASCII export |
7797 | @cindex ASCII export | |
7798 | ||
a7808fba | 7799 | ASCII export produces a simple and very readable version of an Org mode |
4009494e GM |
7800 | file. |
7801 | ||
7802 | @cindex region, active | |
7803 | @cindex active region | |
b6cb4cd5 | 7804 | @cindex transient-mark-mode |
4009494e GM |
7805 | @table @kbd |
7806 | @kindex C-c C-e a | |
7807 | @item C-c C-e a | |
7808 | Export as ASCII file. For an org file @file{myfile.org}, the ASCII file | |
7809 | will be @file{myfile.txt}. The file will be overwritten without | |
b6cb4cd5 CD |
7810 | warning. If there is an active region@footnote{this requires |
7811 | @code{transient-mark-mode} to be turned on}, only the region will be | |
b349f79f CD |
7812 | exported. If the selected region is a single tree@footnote{To select the |
7813 | current subtree, use @kbd{C-c @@}.}, the tree head will | |
4009494e | 7814 | become the document title. If the tree head entry has or inherits an |
b349f79f | 7815 | @code{EXPORT_FILE_NAME} property, that name will be used for the |
28a16a1b | 7816 | export. |
4009494e GM |
7817 | @kindex C-c C-e v a |
7818 | @item C-c C-e v a | |
7819 | Export only the visible part of the document. | |
7820 | @end table | |
7821 | ||
7822 | @cindex headline levels, for exporting | |
7823 | In the exported version, the first 3 outline levels will become | |
7824 | headlines, defining a general document structure. Additional levels | |
7825 | will be exported as itemized lists. If you want that transition to occur | |
7826 | at a different level, specify it with a prefix argument. For example, | |
7827 | ||
7828 | @example | |
7829 | @kbd{C-1 C-c C-e a} | |
7830 | @end example | |
7831 | ||
7832 | @noindent | |
7833 | creates only top level headlines and does the rest as items. When | |
7834 | headlines are converted to items, the indentation of the text following | |
7835 | the headline is changed to fit nicely under the item. This is done with | |
a7808fba | 7836 | the assumption that the first body line indicates the base indentation of |
4009494e GM |
7837 | the body text. Any indentation larger than this is adjusted to preserve |
7838 | the layout relative to the first line. Should there be lines with less | |
7839 | indentation than the first, these are left alone. | |
7840 | ||
71d35b24 | 7841 | @node HTML export, LaTeX and PDF export, ASCII export, Exporting |
4009494e GM |
7842 | @section HTML export |
7843 | @cindex HTML export | |
7844 | ||
a7808fba | 7845 | Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive |
b6cb4cd5 | 7846 | HTML formatting, in ways similar to John Gruber's @emph{markdown} |
4009494e GM |
7847 | language, but with additional support for tables. |
7848 | ||
7849 | @menu | |
b349f79f | 7850 | * HTML Export commands:: How to invoke HTML export |
a7808fba | 7851 | * Quoting HTML tags:: Using direct HTML in Org mode |
4009494e | 7852 | * Links:: Transformation of links for HTML |
55e0839d CD |
7853 | * Images in HTML export:: How to insert figures into HTML output |
7854 | * Text areas in HTML export:: An alternative way to show an example | |
a7808fba CD |
7855 | * CSS support:: Changing the appearance of the output |
7856 | * Javascript support:: Info and Folding in a web browser | |
4009494e GM |
7857 | @end menu |
7858 | ||
7859 | @node HTML Export commands, Quoting HTML tags, HTML export, HTML export | |
7860 | @subsection HTML export commands | |
7861 | ||
7862 | @cindex region, active | |
7863 | @cindex active region | |
b6cb4cd5 | 7864 | @cindex transient-mark-mode |
4009494e GM |
7865 | @table @kbd |
7866 | @kindex C-c C-e h | |
7867 | @item C-c C-e h | |
b349f79f CD |
7868 | Export as HTML file @file{myfile.html}. For an org file @file{myfile.org}, |
7869 | the ASCII file will be @file{myfile.html}. The file will be overwritten | |
b6cb4cd5 CD |
7870 | without warning. If there is an active region@footnote{this requires |
7871 | @code{transient-mark-mode} to be turned on}, only the region will be | |
b349f79f CD |
7872 | exported. If the selected region is a single tree@footnote{To select the |
7873 | current subtree, use @kbd{C-c @@}.}, the tree head will become the document | |
b6cb4cd5 | 7874 | title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME} |
b349f79f | 7875 | property, that name will be used for the export. |
4009494e GM |
7876 | @kindex C-c C-e b |
7877 | @item C-c C-e b | |
7878 | Export as HTML file and immediately open it with a browser. | |
7879 | @kindex C-c C-e H | |
7880 | @item C-c C-e H | |
7881 | Export to a temporary buffer, do not create a file. | |
7882 | @kindex C-c C-e R | |
dbc28aaa | 7883 | @item C-c C-e R |
a7808fba CD |
7884 | Export the active region to a temporary buffer. With a prefix argument, do |
7885 | not produce the file header and footer, but just the plain HTML section for | |
7886 | the region. This is good for cut-and-paste operations. | |
4009494e GM |
7887 | @kindex C-c C-e v h |
7888 | @kindex C-c C-e v b | |
7889 | @kindex C-c C-e v H | |
7890 | @kindex C-c C-e v R | |
7891 | @item C-c C-e v h | |
7892 | @item C-c C-e v b | |
7893 | @item C-c C-e v H | |
7894 | @item C-c C-e v R | |
7895 | Export only the visible part of the document. | |
7896 | @item M-x org-export-region-as-html | |
a7808fba | 7897 | Convert the region to HTML under the assumption that it was Org mode |
4009494e GM |
7898 | syntax before. This is a global command that can be invoked in any |
7899 | buffer. | |
7900 | @item M-x org-replace-region-by-HTML | |
a7808fba | 7901 | Replace the active region (assumed to be in Org mode syntax) by HTML |
4009494e GM |
7902 | code. |
7903 | @end table | |
7904 | ||
7905 | @cindex headline levels, for exporting | |
a7808fba CD |
7906 | In the exported version, the first 3 outline levels will become headlines, |
7907 | defining a general document structure. Additional levels will be exported as | |
7908 | itemized lists. If you want that transition to occur at a different level, | |
7909 | specify it with a numeric prefix argument. For example, | |
4009494e GM |
7910 | |
7911 | @example | |
7912 | @kbd{C-2 C-c C-e b} | |
7913 | @end example | |
7914 | ||
7915 | @noindent | |
7916 | creates two levels of headings and does the rest as items. | |
7917 | ||
7918 | @node Quoting HTML tags, Links, HTML Export commands, HTML export | |
7919 | @subsection Quoting HTML tags | |
7920 | ||
7921 | Plain @samp{<} and @samp{>} are always transformed to @samp{<} and | |
7922 | @samp{>} in HTML export. If you want to include simple HTML tags | |
7923 | which should be interpreted as such, mark them with @samp{@@} as in | |
7924 | @samp{@@<b>bold text@@</b>}. Note that this really works only for | |
7925 | simple tags. For more extensive HTML that should be copied verbatim to | |
7926 | the exported file use either | |
7927 | ||
7928 | @example | |
7929 | #+HTML: Literal HTML code for export | |
7930 | @end example | |
7931 | ||
7932 | @noindent or | |
b349f79f | 7933 | @cindex #+BEGIN_HTML |
4009494e GM |
7934 | |
7935 | @example | |
7936 | #+BEGIN_HTML | |
7937 | All lines between these markers are exported literally | |
7938 | #+END_HTML | |
7939 | @end example | |
7940 | ||
7941 | ||
67df9cfb | 7942 | @node Links, Images in HTML export, Quoting HTML tags, HTML export |
4009494e GM |
7943 | @subsection Links |
7944 | ||
7945 | @cindex links, in HTML export | |
7946 | @cindex internal links, in HTML export | |
7947 | @cindex external links, in HTML export | |
55e0839d CD |
7948 | Internal links (@pxref{Internal links}) will continue to work in HTML. This |
7949 | does include automatic links created by radio targets (@pxref{Radio | |
7950 | targets}). Links to external files will still work if the target file is on | |
7951 | the same @i{relative} path as the published Org file. Links to other | |
7952 | @file{.org} files will be translated into HTML links under the assumption | |
7953 | that an HTML version also exists of the linked file, at the same relative | |
7954 | path. @samp{id:} links can then be used to jump to specific entries across | |
7955 | files. For information related to linking files while publishing them to a | |
7956 | publishing directory see @ref{Publishing links}. | |
4009494e | 7957 | |
44ce9197 | 7958 | If you want to specify attributes for links, you can do so using a special |
a50253cc | 7959 | @code{#+ATTR_HTML} line to define attributes that will be added to the |
67df9cfb CD |
7960 | @code{<a>} or @code{<img>} tags. Here is an example that sets @code{alt} and |
7961 | @code{title} attributes for an inlined image: | |
44ce9197 CD |
7962 | |
7963 | @example | |
67df9cfb CD |
7964 | #+ATTR_HTML: alt="This is image A" title="Image with no action" |
7965 | [[./img/a.jpg]] | |
44ce9197 CD |
7966 | @end example |
7967 | ||
55e0839d | 7968 | @node Images in HTML export, Text areas in HTML export, Links, HTML export |
4009494e GM |
7969 | @subsection Images |
7970 | ||
7971 | @cindex images, inline in HTML | |
7972 | @cindex inlining images in HTML | |
a7808fba | 7973 | HTML export can inline images given as links in the Org file, and |
4009494e GM |
7974 | it can make an image the clickable part of a link. By |
7975 | default@footnote{but see the variable | |
7976 | @code{org-export-html-inline-images}}, images are inlined if a link does | |
7977 | not have a description. So @samp{[[file:myimg.jpg]]} will be inlined, | |
7978 | while @samp{[[file:myimg.jpg][the image]]} will just produce a link | |
7979 | @samp{the image} that points to the image. If the description part | |
7980 | itself is a @code{file:} link or a @code{http:} URL pointing to an | |
7981 | image, this image will be inlined and activated so that clicking on the | |
7982 | image will activate the link. For example, to include a thumbnail that | |
7983 | will link to a high resolution version of the image, you could use: | |
7984 | ||
7985 | @example | |
7986 | [[file:highres.jpg][file:thumb.jpg]] | |
7987 | @end example | |
7988 | ||
7989 | @noindent | |
7990 | and you could use @code{http} addresses just as well. | |
7991 | ||
55e0839d CD |
7992 | @node Text areas in HTML export, CSS support, Images in HTML export, HTML export |
7993 | @subsection Text areas | |
7994 | ||
7995 | @cindex text areas, in HTML | |
7996 | An alternative way to publish literal code examples in HTML is to use text | |
7997 | areas, where the example can even be edited before pasting it into an | |
7998 | application. It is triggered by a @code{-t} switch at an @code{example} or | |
7999 | @code{src} block. Using this switch disables any options for syntax and | |
8000 | label highlighting, and line numbering, which may be present. You may also | |
8001 | use @code{-h} and @code{-w} switches to specify the height and width of the | |
8002 | text area, which default to the number of lines in the example, and 80, | |
8003 | respectively. For example | |
8004 | ||
8005 | @example | |
8006 | #+BEGIN_EXAMPLE -t -w 40 | |
8007 | (defun org-xor (a b) | |
8008 | "Exclusive or." | |
8009 | (if a (not b) b)) | |
8010 | #+END_EXAMPLE | |
8011 | @end example | |
8012 | ||
8013 | ||
8014 | @node CSS support, Javascript support, Text areas in HTML export, HTML export | |
4009494e | 8015 | @subsection CSS support |
a7808fba CD |
8016 | @cindex CSS, for HTML export |
8017 | @cindex HTML export, CSS | |
4009494e | 8018 | |
55e0839d CD |
8019 | You can also give style information for the exported file. The HTML exporter |
8020 | assigns the following special CSS classes to appropriate parts of the | |
8021 | document - your style specifications may change these, in addition to any of | |
8022 | the standard classes like for headlines, tables etc. | |
4009494e | 8023 | @example |
55e0839d CD |
8024 | .todo @r{TODO keywords} |
8025 | .done @r{the DONE keyword} | |
8026 | .timestamp @r{time stamp} | |
8027 | .timestamp-kwd @r{keyword associated with a time stamp, like SCHEDULED} | |
8028 | .tag @r{tag in a headline} | |
8029 | .target @r{target for links} | |
8030 | div.figure @r{how to format an inlined image} | |
8031 | .linenr @r{the line number in a code example} | |
8032 | .code-highlighted @r{for highlighting referenced code lines} | |
4009494e GM |
8033 | @end example |
8034 | ||
44ce9197 | 8035 | Each exported files contains a compact default style that defines these |
e45e3595 CD |
8036 | classes in a basic way@footnote{This style is defined in the constant |
8037 | @code{org-export-html-style-default}, which you should not modify. To turn | |
8038 | inclusion of these defaults off, customize | |
8039 | @code{org-export-html-style-include-default}}. You may overwrite these | |
8040 | settings, or add to them by using the variables @code{org-export-html-style} | |
8041 | (for Org-wide settings) and @code{org-export-html-style-extra} (for more | |
8042 | granular settings, like file-local settings). To set the latter variable | |
8043 | individually for each file, you can use | |
4009494e GM |
8044 | |
8045 | @example | |
864c9740 | 8046 | #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" /> |
4009494e GM |
8047 | @end example |
8048 | ||
864c9740 | 8049 | @noindent |
e45e3595 CD |
8050 | For longer style definitions, you can use several such lines. You could also |
8051 | directly write a @code{<style>} @code{</style>} section in this way, without | |
8052 | referring to an external file. | |
4009494e GM |
8053 | |
8054 | @c FIXME: More about header and footer styles | |
8055 | @c FIXME: Talk about links and targets. | |
8056 | ||
a7808fba CD |
8057 | @node Javascript support, , CSS support, HTML export |
8058 | @subsection Javascript supported display of web pages | |
8059 | ||
8060 | @emph{Sebastian Rose} has written a JavaScript program especially designed to | |
8061 | enhance the web viewing experience of HTML files created with Org. This | |
55e0839d CD |
8062 | program allows you to view large files in two different ways. The first one |
8063 | is an @emph{Info}-like mode where each section is displayed separately and | |
a7808fba CD |
8064 | navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys |
8065 | as well, press @kbd{?} for an overview of the available keys). The second | |
55e0839d CD |
8066 | view type is a @emph{folding} view much like Org provides inside Emacs. The |
8067 | script is available at @url{http://orgmode.org/org-info.js} and you can find | |
8068 | the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}. | |
8069 | We are serving the script from our site, but if you use it a lot, you might | |
8070 | not want to be dependent on @url{orgmode.org} and prefer to install a local | |
8071 | copy on your own web server. | |
a7808fba | 8072 | |
b349f79f | 8073 | To use the script, you need to make sure that the @file{org-jsinfo.el} module |
b6cb4cd5 CD |
8074 | gets loaded. It should be loaded by default, but you can try @kbd{M-x |
8075 | customize-variable @key{RET} org-modules @key{RET}} to convince yourself that | |
8076 | this is indeed the case. All it then takes to make use of the program is | |
8077 | adding a single line to the Org file: | |
a7808fba CD |
8078 | |
8079 | @example | |
b349f79f | 8080 | #+INFOJS_OPT: view:info toc:nil |
a7808fba CD |
8081 | @end example |
8082 | ||
8083 | @noindent | |
8084 | If this line is found, the HTML header will automatically contain the code | |
8085 | needed to invoke the script. Using the line above, you can set the following | |
8086 | viewing options: | |
8087 | ||
8088 | @example | |
8089 | path: @r{The path to the script. The default is to grab the script from} | |
8090 | @r{@url{http://orgmode.org/org-info.js}, but you might want to have} | |
8091 | @r{a local copy and use a path like @samp{../scripts/org-info.js}.} | |
b349f79f | 8092 | view: @r{Initial view when website is first shown. Possible values are:} |
a7808fba CD |
8093 | info @r{Info-like interface with one section per page.} |
8094 | overview @r{Folding interface, initially showing only top-level.} | |
8095 | content @r{Folding interface, starting with all headlines visible.} | |
8096 | showall @r{Folding interface, all headlines and text visible.} | |
8097 | sdepth: @r{Maximum headline level that will still become an independent} | |
8098 | @r{section for info and folding modes. The default is taken from} | |
8099 | @r{@code{org-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).} | |
8100 | @r{If this is smaller than in @code{org-headline-levels}, each} | |
8101 | @r{info/folding section can still contain children headlines.} | |
8102 | toc: @r{Should the table of content @emph{initially} be visible?} | |
8103 | @r{Even when @code{nil}, you can always get to the toc with @kbd{i}.} | |
8104 | tdepth: @r{The depth of the table of contents. The defaults are taken from} | |
8105 | @r{the variables @code{org-headline-levels} and @code{org-export-with-toc}.} | |
b349f79f CD |
8106 | ftoc: @r{Does the css of the page specify a fixed position for the toc?} |
8107 | @r{If yes, the toc will never be displayed as a section.} | |
a7808fba CD |
8108 | ltoc: @r{Should there be short contents (children) in each section?} |
8109 | mouse: @r{Headings are highlighted when the mouse is over them. Should be} | |
8110 | @r{@samp{underline} (default) or a background color like @samp{#cccccc}.} | |
8111 | buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the} | |
8112 | @r{default), only one such button will be present.} | |
8113 | @end example | |
8114 | ||
8115 | You can choose default values for these options by customizing the variable | |
8116 | @code{org-infojs-options}. If you always want to apply the script to your | |
8117 | pages, configure the variable @code{org-export-html-use-infojs}. | |
8118 | ||
71d35b24 CD |
8119 | @node LaTeX and PDF export, XOXO export, HTML export, Exporting |
8120 | @section LaTeX and PDF export | |
4009494e | 8121 | @cindex LaTeX export |
71d35b24 | 8122 | @cindex PDF export |
4009494e | 8123 | |
71d35b24 CD |
8124 | Org mode contains a La@TeX{} exporter written by Bastien Guerry. With |
8125 | further processing, this backend is also used to produce PDF output. Since | |
8126 | the LaTeX output uses @file{hyperref} to implement links and cross | |
8127 | references, the PDF output file will be fully linked. | |
4009494e GM |
8128 | |
8129 | @menu | |
a50253cc | 8130 | * LaTeX/PDF export commands:: Which key invokes which commands |
4009494e | 8131 | * Quoting LaTeX code:: Incorporating literal LaTeX code |
a7808fba | 8132 | * Sectioning structure:: Changing sectioning in LaTeX output |
67df9cfb CD |
8133 | * Tables in LaTeX export:: Options for exporting tables to LaTeX |
8134 | * Images in LaTeX export:: How to insert figures into LaTeX output | |
4009494e GM |
8135 | @end menu |
8136 | ||
71d35b24 | 8137 | @node LaTeX/PDF export commands, Quoting LaTeX code, LaTeX and PDF export, LaTeX and PDF export |
4009494e GM |
8138 | @subsection LaTeX export commands |
8139 | ||
b6cb4cd5 CD |
8140 | @cindex region, active |
8141 | @cindex active region | |
8142 | @cindex transient-mark-mode | |
4009494e GM |
8143 | @table @kbd |
8144 | @kindex C-c C-e l | |
8145 | @item C-c C-e l | |
b349f79f CD |
8146 | Export as La@TeX{} file @file{myfile.tex}. For an org file |
8147 | @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will | |
b6cb4cd5 CD |
8148 | be overwritten without warning. If there is an active region@footnote{this |
8149 | requires @code{transient-mark-mode} to be turned on}, only the region will be | |
8150 | exported. If the selected region is a single tree@footnote{To select the | |
8151 | current subtree, use @kbd{C-c @@}.}, the tree head will become the document | |
8152 | title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME} | |
8153 | property, that name will be used for the export. | |
4009494e GM |
8154 | @kindex C-c C-e L |
8155 | @item C-c C-e L | |
8156 | Export to a temporary buffer, do not create a file. | |
8157 | @kindex C-c C-e v l | |
8158 | @kindex C-c C-e v L | |
8159 | @item C-c C-e v l | |
8160 | @item C-c C-e v L | |
8161 | Export only the visible part of the document. | |
8162 | @item M-x org-export-region-as-latex | |
a7808fba | 8163 | Convert the region to La@TeX{} under the assumption that it was Org mode |
4009494e GM |
8164 | syntax before. This is a global command that can be invoked in any |
8165 | buffer. | |
8166 | @item M-x org-replace-region-by-latex | |
a7808fba | 8167 | Replace the active region (assumed to be in Org mode syntax) by La@TeX{} |
4009494e | 8168 | code. |
71d35b24 CD |
8169 | @kindex C-c C-e p |
8170 | @item C-c C-e p | |
8171 | Export as LaTeX and then process to PDF. | |
8172 | @kindex C-c C-e d | |
8173 | @item C-c C-e d | |
8174 | Export as LaTeX and then process to PDF, then open the resulting PDF file. | |
4009494e GM |
8175 | @end table |
8176 | ||
8177 | @cindex headline levels, for exporting | |
8178 | In the exported version, the first 3 outline levels will become | |
8179 | headlines, defining a general document structure. Additional levels | |
8180 | will be exported as description lists. The exporter can ignore them or | |
8181 | convert them to a custom string depending on | |
8182 | @code{org-latex-low-levels}. | |
8183 | ||
8184 | If you want that transition to occur at a different level, specify it | |
a7808fba | 8185 | with a numeric prefix argument. For example, |
4009494e GM |
8186 | |
8187 | @example | |
8188 | @kbd{C-2 C-c C-e l} | |
8189 | @end example | |
8190 | ||
8191 | @noindent | |
8192 | creates two levels of headings and does the rest as items. | |
8193 | ||
71d35b24 | 8194 | @node Quoting LaTeX code, Sectioning structure, LaTeX/PDF export commands, LaTeX and PDF export |
4009494e GM |
8195 | @subsection Quoting LaTeX code |
8196 | ||
8197 | Embedded La@TeX{} as described in @ref{Embedded LaTeX} will be correctly | |
55e0839d CD |
8198 | inserted into the La@TeX{} file. This includes simple macros like |
8199 | @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore, | |
8200 | you can add special code that should only be present in La@TeX{} export with | |
8201 | the following constructs: | |
4009494e GM |
8202 | |
8203 | @example | |
8204 | #+LaTeX: Literal LaTeX code for export | |
8205 | @end example | |
8206 | ||
8207 | @noindent or | |
b349f79f | 8208 | @cindex #+BEGIN_LaTeX |
4009494e GM |
8209 | |
8210 | @example | |
8211 | #+BEGIN_LaTeX | |
8212 | All lines between these markers are exported literally | |
8213 | #+END_LaTeX | |
8214 | @end example | |
dbc28aaa | 8215 | |
55e0839d | 8216 | @node Sectioning structure, Tables in LaTeX export, Quoting LaTeX code, LaTeX and PDF export |
dbc28aaa CD |
8217 | @subsection Sectioning structure |
8218 | @cindex LaTeX class | |
8219 | @cindex LaTeX sectioning structure | |
8220 | ||
8221 | By default, the La@TeX{} output uses the class @code{article}. | |
8222 | ||
8223 | You can change this globally by setting a different value for | |
71d35b24 | 8224 | @code{org-export-latex-default-class} or locally by adding an option like |
55e0839d CD |
8225 | @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:} |
8226 | property that applies when exporting a region containing only this (sub)tree. | |
8227 | The class should be listed in @code{org-export-latex-classes}, where you can | |
8228 | also define the sectioning structure for each class, as well as defining | |
8229 | additional classes. | |
dbc28aaa | 8230 | |
67df9cfb CD |
8231 | @node Tables in LaTeX export, Images in LaTeX export, Sectioning structure, LaTeX and PDF export |
8232 | @subsection Tables in LaTeX export | |
8233 | @cindex tables, in LaTeX export | |
8234 | ||
8235 | For LaTeX export of a table, you can specify a label and a caption | |
55e0839d | 8236 | (@pxref{Markup rules}). You can also use the @code{ATTR_LaTeX} line to |
67df9cfb CD |
8237 | request a longtable environment for the table, so that it may span several |
8238 | pages: | |
8239 | ||
8240 | @example | |
8241 | #+CAPTION: A long table | |
8242 | #+LABEL: tbl:long | |
8243 | #+ATTR_LaTeX: longtable | |
8244 | | ..... | ..... | | |
8245 | | ..... | ..... | | |
8246 | @end example | |
8247 | ||
8248 | ||
8249 | @node Images in LaTeX export, , Tables in LaTeX export, LaTeX and PDF export | |
8250 | @subsection Images in LaTeX export | |
8251 | @cindex images, inline in LaTeX | |
8252 | @cindex inlining images in LaTeX | |
8253 | ||
8254 | Images that are linked to without a description part in the link, like | |
8255 | @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF | |
8256 | output files resulting from LaTeX output. Org will use an | |
8257 | @code{\includegraphics} macro to insert the image. If you have specified a | |
8258 | caption and/or a label as described in @ref{Markup rules}, the figure will | |
a50253cc | 8259 | be wrapped into a @code{figure} environment and thus become a floating |
67df9cfb CD |
8260 | element. Finally, you can use an @code{#+ATTR_LaTeX:} line to specify the |
8261 | options that can be used in the optional argument of the | |
8262 | @code{\includegraphics} macro. | |
8263 | ||
8264 | @example | |
8265 | #+CAPTION: The black-body emission of the disk around HR 4049 | |
8266 | #+LABEL: fig:SED-HR4049 | |
8267 | #+ATTR_LaTeX: width=5cm,angle=90 | |
8268 | [[./img/sed-hr4049.pdf]] | |
8269 | @end example | |
8270 | ||
55e0839d CD |
8271 | If you need references to a label created in this way, write |
8272 | @samp{\ref@{fig:SED-HR4049@}} just like in LaTeX. The default settings will | |
8273 | recognize files types that can be included as images during processing by | |
8274 | pdflatex (@file{png}, @file{jpg}, and @file{pdf} files). If you process your | |
8275 | files in a different way, you may need to customize the variable | |
8276 | @code{org-export-latex-inline-image-extensions}. | |
67df9cfb | 8277 | |
71d35b24 | 8278 | @node XOXO export, iCalendar export, LaTeX and PDF export, Exporting |
4009494e GM |
8279 | @section XOXO export |
8280 | @cindex XOXO export | |
8281 | ||
a7808fba | 8282 | Org mode contains an exporter that produces XOXO-style output. |
4009494e | 8283 | Currently, this exporter only handles the general outline structure and |
a7808fba | 8284 | does not interpret any additional Org mode features. |
4009494e GM |
8285 | |
8286 | @table @kbd | |
8287 | @kindex C-c C-e x | |
8288 | @item C-c C-e x | |
8289 | Export as XOXO file @file{myfile.html}. | |
8290 | @kindex C-c C-e v | |
8291 | @item C-c C-e v x | |
8292 | Export only the visible part of the document. | |
8293 | @end table | |
8294 | ||
b349f79f | 8295 | @node iCalendar export, , XOXO export, Exporting |
4009494e GM |
8296 | @section iCalendar export |
8297 | @cindex iCalendar export | |
8298 | ||
44ce9197 CD |
8299 | Some people like to use Org mode for keeping track of projects, but still |
8300 | prefer a standard calendar application for anniversaries and appointments. | |
8301 | In this case it can be useful to have deadlines and other time-stamped items | |
8302 | in Org files show up in the calendar application. Org mode can export | |
8303 | calendar information in the standard iCalendar format. If you also want to | |
8304 | have TODO entries included in the export, configure the variable | |
8305 | @code{org-icalendar-include-todo}. iCalendar export will export plain time | |
8306 | stamps as VEVENT, and TODO items as VTODO. It will also create events from | |
8307 | deadlines that are in non-TODO items. Deadlines and scheduling dates in TODO | |
8308 | items will be used to set the start and due dates for the todo | |
8309 | entry@footnote{See the variables @code{org-icalendar-use-deadline} and | |
864c9740 CD |
8310 | @code{org-icalendar-use-scheduled}.}. As categories, it will use the tags |
8311 | locally defined in the heading, and the file/tree category@footnote{To add | |
8312 | inherited tags or the TODO state, configure the variable | |
96c8522a | 8313 | @code{org-icalendar-categories}.}. |
4009494e | 8314 | |
b349f79f CD |
8315 | The iCalendar standard requires each entry to have a globally unique |
8316 | identifier (UID). Org creates these identifiers during export. If you set | |
8317 | the variable @code{org-icalendar-store-UID}, the UID will be stored in the | |
8318 | @code{:ID:} property of the entry and re-used next time you report this | |
8319 | entry. Since a single entry can give rise to multiple iCalendar entries (as | |
8320 | a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds | |
8321 | prefixes to the UID, depending on what triggered the inclusion of the entry. | |
8322 | In this way the UID remains unique, but a synchronization program can still | |
8323 | figure out from which entry all the different instances originate. | |
8324 | ||
4009494e GM |
8325 | @table @kbd |
8326 | @kindex C-c C-e i | |
8327 | @item C-c C-e i | |
8328 | Create iCalendar entries for the current file and store them in the same | |
8329 | directory, using a file extension @file{.ics}. | |
8330 | @kindex C-c C-e I | |
8331 | @item C-c C-e I | |
8332 | Like @kbd{C-c C-e i}, but do this for all files in | |
8333 | @code{org-agenda-files}. For each of these files, a separate iCalendar | |
8334 | file will be written. | |
8335 | @kindex C-c C-e c | |
8336 | @item C-c C-e c | |
8337 | Create a single large iCalendar file from all files in | |
8338 | @code{org-agenda-files} and write it to the file given by | |
8339 | @code{org-combined-agenda-icalendar-file}. | |
8340 | @end table | |
8341 | ||
96c8522a CD |
8342 | The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION |
8343 | property can be inherited from higher in the hierarchy if you configure | |
8344 | @code{org-use-property-inheritance} accordingly.} properties if the selected | |
8345 | entries have them. If not, the summary will be derived from the headline, | |
8346 | and the description from the body (limited to | |
28a16a1b | 8347 | @code{org-icalendar-include-body} characters). |
dbc28aaa | 8348 | |
44ce9197 | 8349 | How this calendar is best read and updated, that depends on the application |
4009494e GM |
8350 | you are using. The FAQ covers this issue. |
8351 | ||
4009494e GM |
8352 | @node Publishing, Miscellaneous, Exporting, Top |
8353 | @chapter Publishing | |
8354 | @cindex publishing | |
8355 | ||
a7808fba | 8356 | Org includes@footnote{@file{org-publish.el} is not distributed with |
4009494e GM |
8357 | Emacs 21, if you are still using Emacs 21, you need you need to download |
8358 | this file separately.} a publishing management system that allows you to | |
8359 | configure automatic HTML conversion of @emph{projects} composed of | |
8360 | interlinked org files. This system is called @emph{org-publish}. You can | |
8361 | also configure org-publish to automatically upload your exported HTML | |
8362 | pages and related attachments, such as images and source code files, to | |
a7808fba | 8363 | a web server. Org-publish turns Org into a web-site authoring tool. |
4009494e GM |
8364 | |
8365 | You can also use Org-publish to convert files into La@TeX{}, or even | |
8366 | combine HTML and La@TeX{} conversion so that files are available in both | |
8367 | formats on the server@footnote{Since La@TeX{} files on a server are not | |
8368 | that helpful, you surely want to perform further conversion on them -- | |
8369 | e.g. convert them to @code{PDF} format.}. | |
8370 | ||
a7808fba | 8371 | Org-publish has been contributed to Org by David O'Toole. |
4009494e GM |
8372 | |
8373 | @menu | |
8374 | * Configuration:: Defining projects | |
8375 | * Sample configuration:: Example projects | |
8376 | * Triggering publication:: Publication commands | |
8377 | @end menu | |
8378 | ||
8379 | @node Configuration, Sample configuration, Publishing, Publishing | |
8380 | @section Configuration | |
8381 | ||
8382 | Publishing needs significant configuration to specify files, destination | |
8383 | and many other properties of a project. | |
8384 | ||
8385 | @menu | |
8386 | * Project alist:: The central configuration variable | |
8387 | * Sources and destinations:: From here to there | |
8388 | * Selecting files:: What files are part of the project? | |
8389 | * Publishing action:: Setting the function doing the publishing | |
8390 | * Publishing options:: Tweaking HTML export | |
8391 | * Publishing links:: Which links keep working after publishing? | |
8392 | * Project page index:: Publishing a list of project files | |
8393 | @end menu | |
8394 | ||
8395 | @node Project alist, Sources and destinations, Configuration, Configuration | |
8396 | @subsection The variable @code{org-publish-project-alist} | |
8397 | @cindex org-publish-project-alist | |
8398 | @cindex projects, for publishing | |
8399 | ||
8400 | Org-publish is configured almost entirely through setting the value of | |
8401 | one variable, called @code{org-publish-project-alist}. | |
8402 | Each element of the list configures one project, and may be in one of | |
8403 | the two following forms: | |
8404 | ||
8405 | @lisp | |
dbc28aaa | 8406 | ("project-name" :property value :property value ...) |
4009494e | 8407 | |
28a16a1b CD |
8408 | @r{or} |
8409 | ||
dbc28aaa | 8410 | ("project-name" :components ("project-name" "project-name" ...)) |
4009494e GM |
8411 | |
8412 | @end lisp | |
8413 | ||
8414 | In both cases, projects are configured by specifying property values. | |
8415 | A project defines the set of files that will be published, as well as | |
8416 | the publishing configuration to use when publishing those files. When | |
8417 | a project takes the second form listed above, the individual members | |
8418 | of the ``components'' property are taken to be components of the | |
8419 | project, which group together files requiring different publishing | |
8420 | options. When you publish such a ``meta-project'' all the components | |
96c8522a CD |
8421 | will also publish. The @code{:components} are published in the sequence |
8422 | provided. | |
4009494e GM |
8423 | |
8424 | @node Sources and destinations, Selecting files, Project alist, Configuration | |
8425 | @subsection Sources and destinations for files | |
8426 | @cindex directories, for publishing | |
8427 | ||
8428 | Most properties are optional, but some should always be set. In | |
8429 | particular, org-publish needs to know where to look for source files, | |
8430 | and where to put published files. | |
8431 | ||
8432 | @multitable @columnfractions 0.3 0.7 | |
8433 | @item @code{:base-directory} | |
8434 | @tab Directory containing publishing source files | |
8435 | @item @code{:publishing-directory} | |
8436 | @tab Directory (possibly remote) where output files will be published. | |
8437 | @item @code{:preparation-function} | |
b349f79f | 8438 | @tab Function called before starting the publishing process, for example to |
4009494e | 8439 | run @code{make} for updating files to be published. |
b349f79f CD |
8440 | @item @code{:completion-function} |
8441 | @tab Function called after finishing the publishing process, for example to | |
8442 | change permissions of the resulting files. | |
4009494e GM |
8443 | @end multitable |
8444 | @noindent | |
8445 | ||
8446 | @node Selecting files, Publishing action, Sources and destinations, Configuration | |
8447 | @subsection Selecting files | |
8448 | @cindex files, selecting for publishing | |
8449 | ||
8450 | By default, all files with extension @file{.org} in the base directory | |
8451 | are considered part of the project. This can be modified by setting the | |
28a16a1b | 8452 | properties |
4009494e GM |
8453 | @multitable @columnfractions 0.25 0.75 |
8454 | @item @code{:base-extension} | |
8455 | @tab Extension (without the dot!) of source files. This actually is a | |
8456 | regular expression. | |
8457 | ||
28a16a1b | 8458 | @item @code{:exclude} |
4009494e GM |
8459 | @tab Regular expression to match file names that should not be |
8460 | published, even though they have been selected on the basis of their | |
8461 | extension. | |
8462 | ||
8463 | @item @code{:include} | |
8464 | @tab List of files to be included regardless of @code{:base-extension} | |
8465 | and @code{:exclude}. | |
8466 | @end multitable | |
8467 | ||
8468 | @node Publishing action, Publishing options, Selecting files, Configuration | |
a7808fba | 8469 | @subsection Publishing action |
4009494e GM |
8470 | @cindex action, for publishing |
8471 | ||
8472 | Publishing means that a file is copied to the destination directory and | |
71d35b24 CD |
8473 | possibly transformed in the process. The default transformation is to export |
8474 | Org files as HTML files, and this is done by the function | |
8475 | @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML | |
8476 | export}). But you also can publish your files in La@TeX{} by using the | |
8477 | function @code{org-publish-org-to-latex} instead, or as PDF files using | |
8478 | @code{org-publish-org-to-pdf}. Other files like images only need to be | |
8479 | copied to the publishing destination. For non-Org files, you need to provide | |
8480 | your own publishing function: | |
4009494e GM |
8481 | |
8482 | @multitable @columnfractions 0.3 0.7 | |
8483 | @item @code{:publishing-function} | |
8484 | @tab Function executing the publication of a file. This may also be a | |
8485 | list of functions, which will all be called in turn. | |
8486 | @end multitable | |
8487 | ||
8488 | The function must accept two arguments: a property list containing at | |
8489 | least a @code{:publishing-directory} property, and the name of the file | |
8490 | to be published. It should take the specified file, make the necessary | |
8491 | transformation (if any) and place the result into the destination folder. | |
8492 | You can write your own publishing function, but @code{org-publish} | |
8493 | provides one for attachments (files that only need to be copied): | |
8494 | @code{org-publish-attachment}. | |
8495 | ||
8496 | @node Publishing options, Publishing links, Publishing action, Configuration | |
8497 | @subsection Options for the HTML/LaTeX exporters | |
8498 | @cindex options, for publishing | |
8499 | ||
8500 | The property list can be used to set many export options for the HTML | |
8501 | and La@TeX{} exporters. In most cases, these properties correspond to user | |
a7808fba | 8502 | variables in Org. The table below lists these properties along |
4009494e GM |
8503 | with the variable they belong to. See the documentation string for the |
8504 | respective variable for details. | |
8505 | ||
96c8522a CD |
8506 | @multitable @columnfractions 0.32 0.68 |
8507 | @item @code{:link-up} @tab @code{org-export-html-link-up} | |
8508 | @item @code{:link-home} @tab @code{org-export-html-link-home} | |
4009494e | 8509 | @item @code{:language} @tab @code{org-export-default-language} |
96c8522a | 8510 | @item @code{:customtime} @tab @code{org-display-custom-times} |
4009494e GM |
8511 | @item @code{:headline-levels} @tab @code{org-export-headline-levels} |
8512 | @item @code{:section-numbers} @tab @code{org-export-with-section-numbers} | |
96c8522a | 8513 | @item @code{:section-number-format} @tab @code{org-export-section-number-format} |
4009494e | 8514 | @item @code{:table-of-contents} @tab @code{org-export-with-toc} |
96c8522a | 8515 | @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks} |
4009494e GM |
8516 | @item @code{:archived-trees} @tab @code{org-export-with-archived-trees} |
8517 | @item @code{:emphasize} @tab @code{org-export-with-emphasize} | |
8518 | @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts} | |
dbc28aaa | 8519 | @item @code{:special-strings} @tab @code{org-export-with-special-strings} |
96c8522a CD |
8520 | @item @code{:footnotes} @tab @code{org-export-with-footnotes} |
8521 | @item @code{:drawers} @tab @code{org-export-with-drawers} | |
8522 | @item @code{:tags} @tab @code{org-export-with-tags} | |
8523 | @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords} | |
8524 | @item @code{:priority} @tab @code{org-export-with-priority} | |
4009494e GM |
8525 | @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros} |
8526 | @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments} | |
96c8522a | 8527 | @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading} |
4009494e | 8528 | @item @code{:fixed-width} @tab @code{org-export-with-fixed-width} |
44ce9197 CD |
8529 | @item @code{:timestamps} @tab @code{org-export-with-timestamps} |
8530 | @item @code{:author-info} @tab @code{org-export-author-info} | |
8531 | @item @code{:creator-info} @tab @code{org-export-creator-info} | |
4009494e GM |
8532 | @item @code{:tables} @tab @code{org-export-with-tables} |
8533 | @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line} | |
e45e3595 | 8534 | @item @code{:style-include-default} @tab @code{org-export-html-style-include-default} |
4009494e | 8535 | @item @code{:style} @tab @code{org-export-html-style} |
44ce9197 | 8536 | @item @code{:style-extra} @tab @code{org-export-html-style-extra} |
4009494e GM |
8537 | @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html} |
8538 | @item @code{:inline-images} @tab @code{org-export-html-inline-images} | |
96c8522a CD |
8539 | @item @code{:html-extension} @tab @code{org-export-html-extension} |
8540 | @item @code{:html-table-tag} @tab @code{org-export-html-table-tag} | |
4009494e GM |
8541 | @item @code{:expand-quoted-html} @tab @code{org-export-html-expand} |
8542 | @item @code{:timestamp} @tab @code{org-export-html-with-timestamp} | |
8543 | @item @code{:publishing-directory} @tab @code{org-export-publishing-directory} | |
8544 | @item @code{:preamble} @tab @code{org-export-html-preamble} | |
8545 | @item @code{:postamble} @tab @code{org-export-html-postamble} | |
8546 | @item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble} | |
8547 | @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble} | |
8548 | @item @code{:author} @tab @code{user-full-name} | |
8549 | @item @code{:email} @tab @code{user-mail-address} | |
864c9740 CD |
8550 | @item @code{:select-tags} @tab @code{org-export-select-tags} |
8551 | @item @code{:exclude-tags} @tab @code{org-export-exclude-tags} | |
4009494e GM |
8552 | @end multitable |
8553 | ||
dbc28aaa CD |
8554 | If you use several email addresses, separate them by a semi-column. |
8555 | ||
4009494e GM |
8556 | Most of the @code{org-export-with-*} variables have the same effect in |
8557 | both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and | |
8558 | @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the | |
8559 | La@TeX{} export. | |
8560 | ||
dbc28aaa CD |
8561 | When a property is given a value in @code{org-publish-project-alist}, |
8562 | its setting overrides the value of the corresponding user variable (if | |
8563 | any) during publishing. Options set within a file (@pxref{Export | |
4009494e GM |
8564 | options}), however, override everything. |
8565 | ||
8566 | @node Publishing links, Project page index, Publishing options, Configuration | |
8567 | @subsection Links between published files | |
8568 | @cindex links, publishing | |
8569 | ||
a7808fba | 8570 | To create a link from one Org file to another, you would use |
4009494e GM |
8571 | something like @samp{[[file:foo.org][The foo]]} or simply |
8572 | @samp{file:foo.org.} (@pxref{Hyperlinks}). Upon publishing this link | |
8573 | becomes a link to @file{foo.html}. In this way, you can interlink the | |
8574 | pages of your "org web" project and the links will work as expected when | |
8575 | you publish them to HTML. | |
8576 | ||
8577 | You may also link to related files, such as images. Provided you are | |
8578 | careful with relative pathnames, and provided you have also configured | |
dbc28aaa | 8579 | @code{org-publish} to upload the related files, these links will work |
b6cb4cd5 | 8580 | too. See @ref{Complex example} for an example of this usage. |
4009494e | 8581 | |
a7808fba | 8582 | Sometime an Org file to be published may contain links that are |
4009494e | 8583 | only valid in your production environment, but not in the publishing |
28a16a1b | 8584 | location. In this case, use the property |
4009494e GM |
8585 | |
8586 | @multitable @columnfractions 0.4 0.6 | |
8587 | @item @code{:link-validation-function} | |
8588 | @tab Function to validate links | |
8589 | @end multitable | |
8590 | ||
8591 | @noindent | |
8592 | to define a function for checking link validity. This function must | |
8593 | accept two arguments, the file name and a directory relative to which | |
8594 | the file name is interpreted in the production environment. If this | |
8595 | function returns @code{nil}, then the HTML generator will only insert a | |
8596 | description into the HTML file, but no link. One option for this | |
8597 | function is @code{org-publish-validate-link} which checks if the given | |
8598 | file is part of any project in @code{org-publish-project-alist}. | |
8599 | ||
8600 | @node Project page index, , Publishing links, Configuration | |
8601 | @subsection Project page index | |
8602 | @cindex index, of published pages | |
8603 | ||
8604 | The following properties may be used to control publishing of an | |
8605 | index of files or summary page for a given project. | |
8606 | ||
8607 | @multitable @columnfractions 0.25 0.75 | |
8608 | @item @code{:auto-index} | |
8609 | @tab When non-nil, publish an index during org-publish-current-project or | |
8610 | org-publish-all. | |
8611 | ||
8612 | @item @code{:index-filename} | |
8613 | @tab Filename for output of index. Defaults to @file{index.org} (which | |
8614 | becomes @file{index.html}). | |
8615 | ||
8616 | @item @code{:index-title} | |
8617 | @tab Title of index page. Defaults to name of file. | |
8618 | ||
8619 | @item @code{:index-function} | |
a7808fba | 8620 | @tab Plug-in function to use for generation of index. |
4009494e GM |
8621 | Defaults to @code{org-publish-org-index}, which generates a plain list |
8622 | of links to all files in the project. | |
8623 | @end multitable | |
8624 | ||
8625 | @node Sample configuration, Triggering publication, Configuration, Publishing | |
8626 | @section Sample configuration | |
8627 | ||
8628 | Below we provide two example configurations. The first one is a simple | |
a7808fba | 8629 | project publishing only a set of Org files. The second example is |
4009494e GM |
8630 | more complex, with a multi-component project. |
8631 | ||
8632 | @menu | |
8633 | * Simple example:: One-component publishing | |
8634 | * Complex example:: A multi-component publishing example | |
8635 | @end menu | |
8636 | ||
8637 | @node Simple example, Complex example, Sample configuration, Sample configuration | |
8638 | @subsection Example: simple publishing configuration | |
8639 | ||
a7808fba | 8640 | This example publishes a set of Org files to the @file{public_html} |
4009494e GM |
8641 | directory on the local machine. |
8642 | ||
8643 | @lisp | |
8644 | (setq org-publish-project-alist | |
28a16a1b | 8645 | '(("org" |
4009494e GM |
8646 | :base-directory "~/org/" |
8647 | :publishing-directory "~/public_html" | |
8648 | :section-numbers nil | |
8649 | :table-of-contents nil | |
e45e3595 | 8650 | :style "<link rel=\"stylesheet\" |
4009494e GM |
8651 | href=\"../other/mystyle.css\" |
8652 | type=\"text/css\">"))) | |
8653 | @end lisp | |
8654 | ||
8655 | @node Complex example, , Simple example, Sample configuration | |
8656 | @subsection Example: complex publishing configuration | |
8657 | ||
8658 | This more complicated example publishes an entire website, including | |
8659 | org files converted to HTML, image files, emacs lisp source code, and | |
a7808fba | 8660 | style sheets. The publishing-directory is remote and private files are |
4009494e GM |
8661 | excluded. |
8662 | ||
8663 | To ensure that links are preserved, care should be taken to replicate | |
8664 | your directory structure on the web server, and to use relative file | |
8665 | paths. For example, if your org files are kept in @file{~/org} and your | |
8666 | publishable images in @file{~/images}, you'd link to an image with | |
8667 | @c | |
8668 | @example | |
8669 | file:../images/myimage.png | |
8670 | @end example | |
8671 | @c | |
8672 | On the web server, the relative path to the image should be the | |
8673 | same. You can accomplish this by setting up an "images" folder in the | |
a7808fba | 8674 | right place on the web server, and publishing images to it. |
4009494e GM |
8675 | |
8676 | @lisp | |
8677 | (setq org-publish-project-alist | |
8678 | '(("orgfiles" | |
8679 | :base-directory "~/org/" | |
8680 | :base-extension "org" | |
8681 | :publishing-directory "/ssh:user@@host:~/html/notebook/" | |
8682 | :publishing-function org-publish-org-to-html | |
8683 | :exclude "PrivatePage.org" ;; regexp | |
8684 | :headline-levels 3 | |
8685 | :section-numbers nil | |
8686 | :table-of-contents nil | |
e45e3595 | 8687 | :style "<link rel=\"stylesheet\" |
4009494e GM |
8688 | href=\"../other/mystyle.css\" type=\"text/css\">" |
8689 | :auto-preamble t | |
8690 | :auto-postamble nil) | |
28a16a1b | 8691 | |
4009494e GM |
8692 | ("images" |
8693 | :base-directory "~/images/" | |
8694 | :base-extension "jpg\\|gif\\|png" | |
8695 | :publishing-directory "/ssh:user@@host:~/html/images/" | |
8696 | :publishing-function org-publish-attachment) | |
28a16a1b | 8697 | |
4009494e GM |
8698 | ("other" |
8699 | :base-directory "~/other/" | |
8700 | :base-extension "css\\|el" | |
8701 | :publishing-directory "/ssh:user@@host:~/html/other/" | |
8702 | :publishing-function org-publish-attachment) | |
8703 | ("website" :components ("orgfiles" "images" "other")))) | |
8704 | @end lisp | |
8705 | ||
8706 | @node Triggering publication, , Sample configuration, Publishing | |
8707 | @section Triggering publication | |
8708 | ||
8709 | Once org-publish is properly configured, you can publish with the | |
28a16a1b | 8710 | following functions: |
4009494e GM |
8711 | |
8712 | @table @kbd | |
8713 | @item C-c C-e C | |
8714 | Prompt for a specific project and publish all files that belong to it. | |
8715 | @item C-c C-e P | |
8716 | Publish the project containing the current file. | |
8717 | @item C-c C-e F | |
8718 | Publish only the current file. | |
8719 | @item C-c C-e A | |
8720 | Publish all projects. | |
8721 | @end table | |
8722 | ||
8723 | Org uses timestamps to track when a file has changed. The above | |
8724 | functions normally only publish changed files. You can override this and | |
8725 | force publishing of all files by giving a prefix argument. | |
8726 | ||
b349f79f | 8727 | @node Miscellaneous, Extensions, Publishing, Top |
4009494e GM |
8728 | @chapter Miscellaneous |
8729 | ||
8730 | @menu | |
8731 | * Completion:: M-TAB knows what you need | |
a7808fba | 8732 | * Customization:: Adapting Org to your taste |
4009494e GM |
8733 | * In-buffer settings:: Overview of the #+KEYWORDS |
8734 | * The very busy C-c C-c key:: When in doubt, press C-c C-c | |
8735 | * Clean view:: Getting rid of leading stars in the outline | |
a7808fba | 8736 | * TTY keys:: Using Org on a tty |
4009494e GM |
8737 | * Interaction:: Other Emacs packages |
8738 | * Bugs:: Things which do not work perfectly | |
8739 | @end menu | |
8740 | ||
8741 | @node Completion, Customization, Miscellaneous, Miscellaneous | |
8742 | @section Completion | |
8743 | @cindex completion, of @TeX{} symbols | |
8744 | @cindex completion, of TODO keywords | |
8745 | @cindex completion, of dictionary words | |
8746 | @cindex completion, of option keywords | |
8747 | @cindex completion, of tags | |
8748 | @cindex completion, of property keys | |
8749 | @cindex completion, of link abbreviations | |
8750 | @cindex @TeX{} symbol completion | |
8751 | @cindex TODO keywords completion | |
8752 | @cindex dictionary word completion | |
8753 | @cindex option keyword completion | |
8754 | @cindex tag completion | |
8755 | @cindex link abbreviations, completion of | |
8756 | ||
a7808fba | 8757 | Org supports in-buffer completion. This type of completion does |
4009494e GM |
8758 | not make use of the minibuffer. You simply type a few letters into |
8759 | the buffer and use the key to complete text right there. | |
8760 | ||
8761 | @table @kbd | |
8762 | @kindex M-@key{TAB} | |
8763 | @item M-@key{TAB} | |
8764 | Complete word at point | |
8765 | @itemize @bullet | |
8766 | @item | |
8767 | At the beginning of a headline, complete TODO keywords. | |
8768 | @item | |
8769 | After @samp{\}, complete @TeX{} symbols supported by the exporter. | |
8770 | @item | |
8771 | After @samp{*}, complete headlines in the current buffer so that they | |
8772 | can be used in search links like @samp{[[*find this headline]]}. | |
8773 | @item | |
8774 | After @samp{:} in a headline, complete tags. The list of tags is taken | |
8775 | from the variable @code{org-tag-alist} (possibly set through the | |
8776 | @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created | |
8777 | dynamically from all tags used in the current buffer. | |
8778 | @item | |
8779 | After @samp{:} and not in a headline, complete property keys. The list | |
8780 | of keys is constructed dynamically from all keys used in the current | |
8781 | buffer. | |
8782 | @item | |
8783 | After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}). | |
8784 | @item | |
8785 | After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or | |
a7808fba | 8786 | @samp{OPTIONS} which set file-specific options for Org mode. When the |
4009494e GM |
8787 | option keyword is already complete, pressing @kbd{M-@key{TAB}} again |
8788 | will insert example settings for this keyword. | |
8789 | @item | |
8790 | In the line after @samp{#+STARTUP: }, complete startup keywords, | |
8791 | i.e. valid keys for this line. | |
8792 | @item | |
a7808fba | 8793 | Elsewhere, complete dictionary words using Ispell. |
4009494e GM |
8794 | @end itemize |
8795 | @end table | |
8796 | ||
8797 | @node Customization, In-buffer settings, Completion, Miscellaneous | |
8798 | @section Customization | |
8799 | @cindex customization | |
8800 | @cindex options, for customization | |
8801 | @cindex variables, for customization | |
8802 | ||
8803 | There are more than 180 variables that can be used to customize | |
a7808fba | 8804 | Org. For the sake of compactness of the manual, I am not |
4009494e GM |
8805 | describing the variables here. A structured overview of customization |
8806 | variables is available with @kbd{M-x org-customize}. Or select | |
8807 | @code{Browse Org Group} from the @code{Org->Customization} menu. Many | |
8808 | settings can also be activated on a per-file basis, by putting special | |
8809 | lines into the buffer (@pxref{In-buffer settings}). | |
8810 | ||
8811 | @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous | |
8812 | @section Summary of in-buffer settings | |
8813 | @cindex in-buffer settings | |
8814 | @cindex special keywords | |
8815 | ||
a7808fba | 8816 | Org mode uses special lines in the buffer to define settings on a |
4009494e GM |
8817 | per-file basis. These lines start with a @samp{#+} followed by a |
8818 | keyword, a colon, and then individual words defining a setting. Several | |
8819 | setting words can be in the same line, but you can also have multiple | |
8820 | lines for the keyword. While these settings are described throughout | |
8821 | the manual, here is a summary. After changing any of those lines in the | |
8822 | buffer, press @kbd{C-c C-c} with the cursor still in the line to | |
8823 | activate the changes immediately. Otherwise they become effective only | |
8824 | when the file is visited again in a new Emacs session. | |
8825 | ||
8826 | @table @kbd | |
8827 | @item #+ARCHIVE: %s_done:: | |
8828 | This line sets the archive location for the agenda file. It applies for | |
8829 | all subsequent lines until the next @samp{#+ARCHIVE} line, or the end | |
8830 | of the file. The first such line also applies to any entries before it. | |
8831 | The corresponding variable is @code{org-archive-location}. | |
8832 | @item #+CATEGORY: | |
8833 | This line sets the category for the agenda file. The category applies | |
8834 | for all subsequent lines until the next @samp{#+CATEGORY} line, or the | |
8835 | end of the file. The first such line also applies to any entries before it. | |
8836 | @item #+COLUMNS: %25ITEM ..... | |
8837 | Set the default format for columns view. This format applies when | |
dbc28aaa CD |
8838 | columns view is invoked in location where no @code{COLUMNS} property |
8839 | applies. | |
4009494e GM |
8840 | @item #+CONSTANTS: name1=value1 ... |
8841 | Set file-local values for constants to be used in table formulas. This | |
8842 | line set the local variable @code{org-table-formula-constants-local}. | |
dbc28aaa | 8843 | The global version of this variable is |
4009494e | 8844 | @code{org-table-formula-constants}. |
b349f79f CD |
8845 | @item #+FILETAGS: :tag1:tag2:tag3: |
8846 | Set tags that can be inherited by any entry in the file, including the | |
8847 | top-level entries. | |
dbc28aaa CD |
8848 | @item #+DRAWERS: NAME1 ..... |
8849 | Set the file-local set of drawers. The corresponding global variable is | |
8850 | @code{org-drawers}. | |
4009494e GM |
8851 | @item #+LINK: linkword replace |
8852 | These lines (several are allowed) specify link abbreviations. | |
8853 | @xref{Link abbreviations}. The corresponding variable is | |
8854 | @code{org-link-abbrev-alist}. | |
8855 | @item #+PRIORITIES: highest lowest default | |
8856 | This line sets the limits and the default for the priorities. All three | |
8857 | must be either letters A-Z or numbers 0-9. The highest priority must | |
8858 | have a lower ASCII number that the lowest priority. | |
8859 | @item #+PROPERTY: Property_Name Value | |
8860 | This line sets a default inheritance value for entries in the current | |
8861 | buffer, most useful for specifying the allowed values of a property. | |
b349f79f CD |
8862 | @item #+SETUPFILE: file |
8863 | This line defines a file that holds more in-buffer setup. Normally this is | |
8864 | entirely ignored. Only when the buffer is parsed for option-setting lines | |
8865 | (i.e. when starting Org mode for a file, when pressing @kbd{C-c C-c} in a | |
8866 | settings line, or when exporting), then the contents of this file are parsed | |
a50253cc | 8867 | as if they had been included in the buffer. In particular, the file can be |
b349f79f CD |
8868 | any other Org mode file with internal setup. You can visit the file the |
8869 | cursor is in the line with @kbd{C-c '}. | |
4009494e | 8870 | @item #+STARTUP: |
a7808fba CD |
8871 | This line sets options to be used at startup of Org mode, when an |
8872 | Org file is being visited. The first set of options deals with the | |
4009494e GM |
8873 | initial visibility of the outline tree. The corresponding variable for |
8874 | global default settings is @code{org-startup-folded}, with a default | |
8875 | value @code{t}, which means @code{overview}. | |
8876 | @cindex @code{overview}, STARTUP keyword | |
8877 | @cindex @code{content}, STARTUP keyword | |
8878 | @cindex @code{showall}, STARTUP keyword | |
8879 | @example | |
8880 | overview @r{top-level headlines only} | |
8881 | content @r{all headlines} | |
8882 | showall @r{no folding at all, show everything} | |
8883 | @end example | |
8884 | Then there are options for aligning tables upon visiting a file. This | |
8885 | is useful in files containing narrowed table columns. The corresponding | |
8886 | variable is @code{org-startup-align-all-tables}, with a default value | |
28a16a1b | 8887 | @code{nil}. |
4009494e GM |
8888 | @cindex @code{align}, STARTUP keyword |
8889 | @cindex @code{noalign}, STARTUP keyword | |
8890 | @example | |
8891 | align @r{align all tables} | |
8892 | noalign @r{don't align tables on startup} | |
8893 | @end example | |
28a16a1b CD |
8894 | Logging closing and reinstating TODO items, and clock intervals |
8895 | (variables @code{org-log-done}, @code{org-log-note-clock-out}, and | |
8896 | @code{org-log-repeat}) can be configured using these options. | |
4009494e | 8897 | @cindex @code{logdone}, STARTUP keyword |
4009494e | 8898 | @cindex @code{lognotedone}, STARTUP keyword |
28a16a1b | 8899 | @cindex @code{nologdone}, STARTUP keyword |
4009494e | 8900 | @cindex @code{lognoteclock-out}, STARTUP keyword |
28a16a1b | 8901 | @cindex @code{nolognoteclock-out}, STARTUP keyword |
4009494e | 8902 | @cindex @code{logrepeat}, STARTUP keyword |
28a16a1b | 8903 | @cindex @code{lognoterepeat}, STARTUP keyword |
4009494e GM |
8904 | @cindex @code{nologrepeat}, STARTUP keyword |
8905 | @example | |
28a16a1b CD |
8906 | logdone @r{record a timestamp when an item is marked DONE} |
8907 | lognotedone @r{record timestamp and a note when DONE} | |
8908 | nologdone @r{don't record when items are marked DONE} | |
8909 | logrepeat @r{record a time when reinstating a repeating item} | |
8910 | lognoterepeat @r{record a note when reinstating a repeating item} | |
8911 | nologrepeat @r{do not record when reinstating repeating item} | |
8912 | lognoteclock-out @r{record a note when clocking out} | |
8913 | nolognoteclock-out @r{don't record a note when clocking out} | |
4009494e | 8914 | @end example |
b349f79f CD |
8915 | Here are the options for hiding leading stars in outline headings, and for |
8916 | indenting outlines. The corresponding variables are | |
8917 | @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a | |
8918 | default setting @code{nil} (meaning @code{showstars} and @code{oddeven}). | |
4009494e GM |
8919 | @cindex @code{hidestars}, STARTUP keyword |
8920 | @cindex @code{showstars}, STARTUP keyword | |
8921 | @cindex @code{odd}, STARTUP keyword | |
8922 | @cindex @code{even}, STARTUP keyword | |
8923 | @example | |
8924 | hidestars @r{make all but one of the stars starting a headline invisible.} | |
8925 | showstars @r{show all stars starting a headline} | |
b349f79f CD |
8926 | indent @r{virtual indentation according to outline level} |
8927 | noindent @r{no virtual indentation according to outline level} | |
4009494e GM |
8928 | odd @r{allow only odd outline levels (1,3,...)} |
8929 | oddeven @r{allow all outline levels} | |
8930 | @end example | |
8931 | To turn on custom format overlays over time stamps (variables | |
8932 | @code{org-put-time-stamp-overlays} and | |
8933 | @code{org-time-stamp-overlay-formats}), use | |
8934 | @cindex @code{customtime}, STARTUP keyword | |
8935 | @example | |
8936 | customtime @r{overlay custom time format} | |
8937 | @end example | |
8938 | The following options influence the table spreadsheet (variable | |
8939 | @code{constants-unit-system}). | |
8940 | @cindex @code{constcgs}, STARTUP keyword | |
8941 | @cindex @code{constSI}, STARTUP keyword | |
8942 | @example | |
8943 | constcgs @r{@file{constants.el} should use the c-g-s unit system} | |
8944 | constSI @r{@file{constants.el} should use the SI unit system} | |
8945 | @end example | |
55e0839d CD |
8946 | To influence footnote settings, use the following keywords. The |
8947 | corresponding variables are @code{org-footnote-define-inline} and | |
8948 | @code{org-footnote-auto-label}. | |
8949 | @cindex @code{fninline}, STARTUP keyword | |
8950 | @cindex @code{fnnoinline}, STARTUP keyword | |
8951 | @cindex @code{fnlocal}, STARTUP keyword | |
8952 | @cindex @code{fnprompt}, STARTUP keyword | |
8953 | @cindex @code{fnauto}, STARTUP keyword | |
8954 | @cindex @code{fnconfirm}, STARTUP keyword | |
8955 | @cindex @code{fnplain}, STARTUP keyword | |
8956 | @example | |
8957 | fninline @r{define footnotes inline} | |
8958 | fnnoinline @r{define footnotes in separate section} | |
8959 | fnlocal @r{define footnotes near first reference, but not inline} | |
8960 | fnprompt @r{prompt for footnote labels} | |
8961 | fnauto @r{create [fn:1]-like labels automatically (default)} | |
8962 | fnconfirm @r{offer automatic label for editing or confirmation} | |
8963 | fnplain @r{create [1]-like labels automatically} | |
8964 | @end example | |
4009494e | 8965 | @item #+TAGS: TAG1(c1) TAG2(c2) |
cad1d376 | 8966 | These lines (several such lines are allowed) specify the valid tags in |
4009494e GM |
8967 | this file, and (potentially) the corresponding @emph{fast tag selection} |
8968 | keys. The corresponding variable is @code{org-tag-alist}. | |
8969 | @item #+TBLFM: | |
8970 | This line contains the formulas for the table directly above the line. | |
dbc28aaa | 8971 | @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS, #+DATE: |
4009494e GM |
8972 | These lines provide settings for exporting files. For more details see |
8973 | @ref{Export options}. | |
8974 | @item #+SEQ_TODO: #+TYP_TODO: | |
8975 | These lines set the TODO keywords and their interpretation in the | |
8976 | current file. The corresponding variables are @code{org-todo-keywords} | |
8977 | and @code{org-todo-interpretation}. | |
8978 | @end table | |
8979 | ||
8980 | @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous | |
8981 | @section The very busy C-c C-c key | |
8982 | @kindex C-c C-c | |
8983 | @cindex C-c C-c, overview | |
8984 | ||
a7808fba | 8985 | The key @kbd{C-c C-c} has many purposes in Org, which are all |
4009494e GM |
8986 | mentioned scattered throughout this manual. One specific function of |
8987 | this key is to add @emph{tags} to a headline (@pxref{Tags}). In many | |
a7808fba | 8988 | other circumstances it means something like @emph{Hey Org, look |
4009494e GM |
8989 | here and update according to what you see here}. Here is a summary of |
8990 | what this means in different contexts. | |
8991 | ||
8992 | @itemize @minus | |
8993 | @item | |
8994 | If there are highlights in the buffer from the creation of a sparse | |
8995 | tree, or from clock display, remove these highlights. | |
8996 | @item | |
8997 | If the cursor is in one of the special @code{#+KEYWORD} lines, this | |
8998 | triggers scanning the buffer for these lines and updating the | |
28a16a1b | 8999 | information. |
4009494e GM |
9000 | @item |
9001 | If the cursor is inside a table, realign the table. This command | |
9002 | works even if the automatic table editor has been turned off. | |
9003 | @item | |
9004 | If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to | |
9005 | the entire table. | |
9006 | @item | |
9007 | If the cursor is inside a table created by the @file{table.el} package, | |
9008 | activate that table. | |
9009 | @item | |
9010 | If the current buffer is a remember buffer, close the note and file it. | |
9011 | With a prefix argument, file it, without further interaction, to the | |
9012 | default location. | |
9013 | @item | |
9014 | If the cursor is on a @code{<<<target>>>}, update radio targets and | |
9015 | corresponding links in this buffer. | |
9016 | @item | |
9017 | If the cursor is in a property line or at the start or end of a property | |
9018 | drawer, offer property commands. | |
9019 | @item | |
55e0839d CD |
9020 | If the cursor is at a footnote reference, go to the corresponding |
9021 | definition, and vice versa. | |
9022 | @item | |
4009494e GM |
9023 | If the cursor is in a plain list item with a checkbox, toggle the status |
9024 | of the checkbox. | |
9025 | @item | |
9026 | If the cursor is on a numbered item in a plain list, renumber the | |
9027 | ordered list. | |
dbc28aaa CD |
9028 | @item |
9029 | If the cursor is on the @code{#+BEGIN} line of a dynamical block, the | |
9030 | block is updated. | |
4009494e GM |
9031 | @end itemize |
9032 | ||
9033 | @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous | |
9034 | @section A cleaner outline view | |
9035 | @cindex hiding leading stars | |
b349f79f CD |
9036 | @cindex dynamic indentation |
9037 | @cindex odd-levels-only outlines | |
4009494e GM |
9038 | @cindex clean outline view |
9039 | ||
b349f79f CD |
9040 | Some people find it noisy and distracting that the Org headlines are starting |
9041 | with a potentially large number of stars, and that text below the headlines | |
9042 | is not indented. This is not really a problem when you are writing a book | |
9043 | where the outline headings are really section headlines. However, in a more | |
9044 | list-oriented outline, it is clear that an indented structure is a lot | |
9045 | cleaner, as can be seen by comparing the two columns in the following | |
96c8522a | 9046 | example: |
4009494e GM |
9047 | |
9048 | @example | |
b349f79f CD |
9049 | @group |
9050 | * Top level headline | * Top level headline | |
9051 | ** Second level | * Second level | |
9052 | *** 3rd level | * 3rd level | |
9053 | some text | some text | |
9054 | *** 3rd level | * 3rd level | |
9055 | more text | more text | |
9056 | * Another top level headline | * Another top level headline | |
9057 | @end group | |
4009494e GM |
9058 | @end example |
9059 | ||
9060 | @noindent | |
b349f79f CD |
9061 | It is non-trivial to make such a look work in Emacs, but Org contains three |
9062 | separate features that, combined, achieve just that. | |
4009494e | 9063 | |
b349f79f | 9064 | @enumerate |
96c8522a | 9065 | @item |
b349f79f CD |
9066 | @emph{Indentation of text below headlines}@* |
9067 | You may indent text below each headline to make the left boundary line up | |
9068 | with the headline, like | |
4009494e | 9069 | |
b349f79f CD |
9070 | @example |
9071 | *** 3rd level | |
9072 | more text, now indented | |
9073 | @end example | |
9074 | ||
9075 | A good way to get this indentation is by hand, and Org supports this with | |
9076 | paragraph filling, line wrapping, and structure editing@footnote{See also the | |
9077 | variable @code{org-adapt-indentation}.} preserving or adapting the | |
9078 | indentation appropriate. A different approach would be to have a way to | |
9079 | automatically indent lines according to outline structure by adding overlays | |
9080 | or text properties. But I have not yet found a robust and efficient way to | |
9081 | do this in large files. | |
9082 | ||
9083 | @item | |
9084 | @emph{Hiding leading stars}@* You can modify the display in such a way that | |
9085 | all leading stars become invisible. To do this in a global way, configure | |
9086 | the variable @code{org-hide-leading-stars} or change this on a per-file basis | |
9087 | with | |
4009494e GM |
9088 | |
9089 | @example | |
4009494e GM |
9090 | #+STARTUP: hidestars |
9091 | @end example | |
9092 | ||
864c9740 CD |
9093 | @noindent |
9094 | Note that the opposite behavior is selected with @code{showstars}. | |
9095 | ||
b349f79f | 9096 | With hidden stars, the tree becomes: |
4009494e GM |
9097 | |
9098 | @example | |
b349f79f | 9099 | @group |
4009494e GM |
9100 | * Top level headline |
9101 | * Second level | |
9102 | * 3rd level | |
b349f79f CD |
9103 | ... |
9104 | @end group | |
4009494e GM |
9105 | @end example |
9106 | ||
9107 | @noindent | |
9108 | Note that the leading stars are not truly replaced by whitespace, they | |
9109 | are only fontified with the face @code{org-hide} that uses the | |
9110 | background color as font color. If you are not using either white or | |
9111 | black background, you may have to customize this face to get the wanted | |
9112 | effect. Another possibility is to set this font such that the extra | |
9113 | stars are @i{almost} invisible, for example using the color | |
9114 | @code{grey90} on a white background. | |
9115 | ||
b349f79f CD |
9116 | @item |
9117 | Things become cleaner still if you skip all the even levels and use only odd | |
9118 | levels 1, 3, 5..., effectively adding two stars to go from one outline level | |
9119 | to the next. In this way we get the outline view shown at the beginning of | |
9120 | this section. In order to make the structure editing and export commands | |
9121 | handle this convention correctly, configure the variable | |
9122 | @code{org-odd-levels-only}, or set this on a per-file basis with one of the | |
9123 | following lines: | |
4009494e GM |
9124 | |
9125 | @example | |
9126 | #+STARTUP: odd | |
9127 | #+STARTUP: oddeven | |
9128 | @end example | |
9129 | ||
a7808fba | 9130 | You can convert an Org file from single-star-per-level to the |
4009494e GM |
9131 | double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels |
9132 | RET} in that file. The reverse operation is @kbd{M-x | |
9133 | org-convert-to-oddeven-levels}. | |
b349f79f | 9134 | @end enumerate |
4009494e GM |
9135 | |
9136 | @node TTY keys, Interaction, Clean view, Miscellaneous | |
a7808fba CD |
9137 | @section Using Org on a tty |
9138 | @cindex tty key bindings | |
4009494e | 9139 | |
a7808fba CD |
9140 | Because Org contains a large number of commands, by default much of |
9141 | Org's core commands are bound to keys that are generally not | |
dbc28aaa CD |
9142 | accessible on a tty, such as the cursor keys (@key{left}, @key{right}, |
9143 | @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used | |
9144 | together with modifiers like @key{Meta} and/or @key{Shift}. To access | |
9145 | these commands on a tty when special keys are unavailable, the following | |
9146 | alternative bindings can be used. The tty bindings below will likely be | |
9147 | more cumbersome; you may find for some of the bindings below that a | |
9148 | customized work-around suits you better. For example, changing a time | |
9149 | stamp is really only fun with @kbd{S-@key{cursor}} keys, whereas on a | |
9150 | tty you would rather use @kbd{C-c .} to re-insert the timestamp. | |
4009494e GM |
9151 | |
9152 | @multitable @columnfractions 0.15 0.2 0.2 | |
9153 | @item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2} | |
9154 | @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab | |
9155 | @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{@key{Esc} @key{left}} | |
9156 | @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab | |
71d35b24 | 9157 | @item @kbd{M-@key{right}} @tab @kbd{C-c C-x i} @tab @kbd{@key{Esc} @key{right}} |
4009494e GM |
9158 | @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab |
9159 | @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{@key{Esc} @key{up}} | |
9160 | @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab | |
9161 | @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{@key{Esc} @key{down}} | |
9162 | @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab | |
9163 | @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab | |
9164 | @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{@key{Esc} @key{RET}} | |
9165 | @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab | |
9166 | @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab | |
9167 | @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab | |
9168 | @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab | |
9169 | @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab | |
9170 | @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab | |
9171 | @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab | |
9172 | @end multitable | |
9173 | ||
9174 | @node Interaction, Bugs, TTY keys, Miscellaneous | |
9175 | @section Interaction with other packages | |
9176 | @cindex packages, interaction with other | |
a7808fba | 9177 | Org lives in the world of GNU Emacs and interacts in various ways |
4009494e GM |
9178 | with other code out there. |
9179 | ||
9180 | @menu | |
a7808fba | 9181 | * Cooperation:: Packages Org cooperates with |
4009494e GM |
9182 | * Conflicts:: Packages that lead to conflicts |
9183 | @end menu | |
9184 | ||
9185 | @node Cooperation, Conflicts, Interaction, Interaction | |
a7808fba | 9186 | @subsection Packages that Org cooperates with |
4009494e GM |
9187 | |
9188 | @table @asis | |
9189 | @cindex @file{calc.el} | |
9190 | @item @file{calc.el} by Dave Gillespie | |
a7808fba CD |
9191 | Org uses the Calc package for implementing spreadsheet |
9192 | functionality in its tables (@pxref{The spreadsheet}). Org | |
9193 | checks for the availability of Calc by looking for the function | |
9194 | @code{calc-eval} which should be autoloaded in your setup if Calc has | |
9195 | been installed properly. As of Emacs 22, Calc is part of the Emacs | |
4009494e | 9196 | distribution. Another possibility for interaction between the two |
a7808fba CD |
9197 | packages is using Calc for embedded calculations. @xref{Embedded Mode, |
9198 | , Embedded Mode, Calc, GNU Emacs Calc Manual}. | |
4009494e GM |
9199 | @cindex @file{constants.el} |
9200 | @item @file{constants.el} by Carsten Dominik | |
9201 | In a table formula (@pxref{The spreadsheet}), it is possible to use | |
9202 | names for natural constants or units. Instead of defining your own | |
9203 | constants in the variable @code{org-table-formula-constants}, install | |
9204 | the @file{constants} package which defines a large number of constants | |
9205 | and units, and lets you use unit prefixes like @samp{M} for | |
9206 | @samp{Mega} etc. You will need version 2.0 of this package, available | |
a7808fba | 9207 | at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for |
4009494e GM |
9208 | the function @code{constants-get}, which has to be autoloaded in your |
9209 | setup. See the installation instructions in the file | |
9210 | @file{constants.el}. | |
9211 | @item @file{cdlatex.el} by Carsten Dominik | |
9212 | @cindex @file{cdlatex.el} | |
a7808fba CD |
9213 | Org mode can make use of the CDLaTeX package to efficiently enter |
9214 | La@TeX{} fragments into Org files. See @ref{CDLaTeX mode}. | |
dbc28aaa CD |
9215 | @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg |
9216 | @cindex @file{imenu.el} | |
a7808fba CD |
9217 | Imenu allows menu access to an index of items in a file. Org mode |
9218 | supports Imenu - all you need to do to get the index is the following: | |
dbc28aaa | 9219 | @lisp |
28a16a1b | 9220 | (add-hook 'org-mode-hook |
a7808fba | 9221 | (lambda () (imenu-add-to-menubar "Imenu"))) |
dbc28aaa CD |
9222 | @end lisp |
9223 | By default the index is two levels deep - you can modify the depth using | |
9224 | the option @code{org-imenu-depth}. | |
4009494e GM |
9225 | @item @file{remember.el} by John Wiegley |
9226 | @cindex @file{remember.el} | |
a7808fba | 9227 | Org cooperates with remember, see @ref{Remember}. |
4009494e | 9228 | @file{Remember.el} is not part of Emacs, find it on the web. |
dbc28aaa CD |
9229 | @item @file{speedbar.el} by Eric M. Ludlam |
9230 | @cindex @file{speedbar.el} | |
9231 | Speedbar is a package that creates a special frame displaying files and | |
a7808fba CD |
9232 | index items in files. Org mode supports Speedbar and allows you to |
9233 | drill into Org files directly from the Speedbar. It also allows to | |
dbc28aaa | 9234 | restrict the scope of agenda commands to a file or a subtree by using |
a7808fba | 9235 | the command @kbd{<} in the Speedbar frame. |
4009494e GM |
9236 | @cindex @file{table.el} |
9237 | @item @file{table.el} by Takaaki Ota | |
9238 | @kindex C-c C-c | |
9239 | @cindex table editor, @file{table.el} | |
9240 | @cindex @file{table.el} | |
9241 | ||
9242 | Complex ASCII tables with automatic line wrapping, column- and | |
9243 | row-spanning, and alignment can be created using the Emacs table | |
9244 | package by Takaaki Ota (@uref{http://sourceforge.net/projects/table}, | |
9245 | and also part of Emacs 22). | |
a7808fba | 9246 | When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org mode |
4009494e | 9247 | will call @command{table-recognize-table} and move the cursor into the |
a7808fba CD |
9248 | table. Inside a table, the keymap of Org mode is inactive. In order |
9249 | to execute Org mode-related commands, leave the table. | |
4009494e GM |
9250 | |
9251 | @table @kbd | |
9252 | @kindex C-c C-c | |
9253 | @item C-c C-c | |
9254 | Recognize @file{table.el} table. Works when the cursor is in a | |
9255 | table.el table. | |
9256 | @c | |
9257 | @kindex C-c ~ | |
9258 | @item C-c ~ | |
9259 | Insert a table.el table. If there is already a table at point, this | |
a7808fba | 9260 | command converts it between the table.el format and the Org mode |
4009494e GM |
9261 | format. See the documentation string of the command |
9262 | @code{org-convert-table} for the restrictions under which this is | |
9263 | possible. | |
9264 | @end table | |
9265 | @file{table.el} is part of Emacs 22. | |
9266 | @cindex @file{footnote.el} | |
9267 | @item @file{footnote.el} by Steven L. Baur | |
55e0839d CD |
9268 | Org mode recognizes numerical footnotes as provided by this package. |
9269 | However, Org-mode also has its own footnote support (@pxref{Footnotes}), | |
9270 | which makes using @file{footnote.el} unnecessary. | |
4009494e GM |
9271 | @end table |
9272 | ||
9273 | @node Conflicts, , Cooperation, Interaction | |
a7808fba | 9274 | @subsection Packages that lead to conflicts with Org mode |
4009494e GM |
9275 | |
9276 | @table @asis | |
9277 | ||
9278 | @cindex @file{allout.el} | |
9279 | @item @file{allout.el} by Ken Manheimer | |
a7808fba | 9280 | Startup of Org may fail with the error message |
4009494e GM |
9281 | @code{(wrong-type-argument keymapp nil)} when there is an outdated |
9282 | version @file{allout.el} on the load path, for example the version | |
9283 | distributed with Emacs 21.x. Upgrade to Emacs 22 and this problem will | |
9284 | disappear. If for some reason you cannot do this, make sure that org.el | |
9285 | is loaded @emph{before} @file{allout.el}, for example by putting | |
9286 | @code{(require 'org)} early enough into your @file{.emacs} file. | |
9287 | ||
9288 | @cindex @file{CUA.el} | |
9289 | @item @file{CUA.el} by Kim. F. Storm | |
a7808fba CD |
9290 | Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by |
9291 | CUA mode (as well as pc-select-mode and s-region-mode) to select and | |
dbc28aaa | 9292 | extend the region. If you want to use one of these packages along with |
a7808fba CD |
9293 | Org, configure the variable @code{org-replace-disputed-keys}. When |
9294 | set, Org will move the following key bindings in Org files, and | |
dbc28aaa | 9295 | in the agenda buffer (but not during date selection). |
4009494e GM |
9296 | |
9297 | @example | |
9298 | S-UP -> M-p S-DOWN -> M-n | |
9299 | S-LEFT -> M-- S-RIGHT -> M-+ | |
9300 | @end example | |
9301 | ||
9302 | Yes, these are unfortunately more difficult to remember. If you want | |
9303 | to have other replacement keys, look at the variable | |
9304 | @code{org-disputed-keys}. | |
9305 | @item @file{windmove.el} by Hovav Shacham | |
9306 | @cindex @file{windmove.el} | |
9307 | Also this package uses the @kbd{S-<cursor>} keys, so everything written | |
9308 | in the paragraph above about CUA mode also applies here. | |
9309 | ||
4009494e GM |
9310 | @end table |
9311 | ||
9312 | ||
9313 | @node Bugs, , Interaction, Miscellaneous | |
9314 | @section Bugs | |
9315 | @cindex bugs | |
9316 | ||
9317 | Here is a list of things that should work differently, but which I | |
9318 | have found too hard to fix. | |
9319 | ||
9320 | @itemize @bullet | |
9321 | @item | |
9322 | If a table field starts with a link, and if the corresponding table | |
9323 | column is narrowed (@pxref{Narrow columns}) to a width too small to | |
9324 | display the link, the field would look entirely empty even though it is | |
a7808fba | 9325 | not. To prevent this, Org throws an error. The work-around is to |
4009494e GM |
9326 | make the column wide enough to fit the link, or to add some text (at |
9327 | least 2 characters) before the link in the same field. | |
9328 | @item | |
9329 | Narrowing table columns does not work on XEmacs, because the | |
9330 | @code{format} function does not transport text properties. | |
9331 | @item | |
9332 | Text in an entry protected with the @samp{QUOTE} keyword should not | |
9333 | autowrap. | |
9334 | @item | |
9335 | When the application called by @kbd{C-c C-o} to open a file link fails | |
9336 | (for example because the application does not exist or refuses to open | |
9337 | the file), it does so silently. No error message is displayed. | |
9338 | @item | |
9339 | Recalculating a table line applies the formulas from left to right. | |
9340 | If a formula uses @emph{calculated} fields further down the row, | |
9341 | multiple recalculation may be needed to get all fields consistent. You | |
9342 | may use the command @code{org-table-iterate} (@kbd{C-u C-c *}) to | |
9343 | recalculate until convergence. | |
9344 | @item | |
4009494e GM |
9345 | The exporters work well, but could be made more efficient. |
9346 | @end itemize | |
9347 | ||
9348 | ||
b349f79f CD |
9349 | @node Extensions, Hacking, Miscellaneous, Top |
9350 | @appendix Extensions | |
9351 | ||
9352 | This appendix lists the extension modules that have been written for Org. | |
9353 | Many of these extensions live in the @file{contrib} directory of the Org | |
9354 | distribution, others are available somewhere on the web. | |
4009494e | 9355 | |
b349f79f CD |
9356 | @menu |
9357 | * Extensions in the contrib directory:: These come with the Org distro | |
9358 | * Other extensions:: These you have to find on the web. | |
9359 | @end menu | |
9360 | ||
9361 | @node Extensions in the contrib directory, Other extensions, Extensions, Extensions | |
9362 | @section Extensions in the @file{contrib} directory | |
9363 | ||
64fb801f CD |
9364 | A number of extension are distributed with Org when you download it from its |
9365 | homepage. Please note that these extensions are @emph{not} distributed as | |
9366 | part of Emacs, so if you use Org as delivered with Emacs, you still need to | |
9367 | go to @url{http://orgmode.org} to get access to these modules. | |
9368 | ||
b349f79f CD |
9369 | @table @asis |
9370 | @item @file{org-annotate-file.el} by @i{Philip Jackson} | |
55e0839d CD |
9371 | Annotate a file with org syntax, in a separate file, with links back to the |
9372 | annotated file. | |
9373 | ||
96c8522a | 9374 | @item @file{org-annotation-helper.el} by @i{Bastien Guerry and Daniel E. German} |
55e0839d CD |
9375 | Call @i{remember} directly from Firefox/Opera, or from Adobe Reader. When |
9376 | activating a special link or bookmark, Emacs receives a trigger to create a | |
9377 | note with a link back to the website. Requires some setup, a detailed | |
9378 | description is in @file{contrib/packages/org-annotation-helper}. | |
9379 | ||
b349f79f | 9380 | @item @file{org-bookmark.el} by @i{Tokuya Kameshima} |
55e0839d CD |
9381 | Support for links to Emacs bookmarks. |
9382 | ||
b349f79f | 9383 | @item @file{org-depend.el} by @i{Carsten Dominik} |
55e0839d CD |
9384 | TODO dependencies for Org-mode. Make TODO state changes in one entry trigger |
9385 | changes in another, or be blocked by the state of another entry. Also, | |
9386 | easily create chains of TODO items with exactly one active item at any time. | |
9387 | ||
b349f79f | 9388 | @item @file{org-elisp-symbol.el} by @i{Bastien Guerry} |
55e0839d CD |
9389 | Org links to emacs-lisp symbols. This can create annotated links that |
9390 | exactly point to the definition location of a variable of function. | |
9391 | ||
b349f79f | 9392 | @item @file{org-eval.el} by @i{Carsten Dominik} |
55e0839d CD |
9393 | The @code{<lisp>} tag, adapted from Emacs Wiki and Emacs Muse, allows text to |
9394 | be included in a document that is the result of evaluating some code. Other | |
9395 | scripting languages like @code{perl} can be supported with this package as | |
9396 | well. | |
9397 | ||
64fb801f | 9398 | @item @file{org-eval-light.el} by @i{Eric Schulte} |
55e0839d CD |
9399 | User-controlled evaluation of code in an Org buffer. |
9400 | ||
64fb801f | 9401 | @item @file{org-exp-blocks.el} by @i{Eric Schulte} |
55e0839d CD |
9402 | Preprocess user-defined blocks for export. |
9403 | ||
b349f79f | 9404 | @item @file{org-expiry.el} by @i{Bastien Guerry} |
55e0839d CD |
9405 | Expiry mechanism for Org entries. |
9406 | ||
b349f79f | 9407 | @item @file{org-indent.el} by @i{Carsten Dominik} |
55e0839d CD |
9408 | Dynamic indentation of Org outlines. The plan is to indent an outline |
9409 | according to level, but so far this is too hard for a proper and stable | |
9410 | implementation. Still, it works somewhat. | |
9411 | ||
b349f79f | 9412 | @item @file{org-interactive-query.el} by @i{Christopher League} |
55e0839d | 9413 | Interactive modification of tags queries. After running a general query in |
2096a1b6 | 9414 | Org, this package allows you to narrow down the results by adding more tags or |
55e0839d CD |
9415 | keywords. |
9416 | ||
b349f79f | 9417 | @item @file{org-mairix.el} by @i{Georg C. F. Greve} |
55e0839d CD |
9418 | Hook mairix search into Org for different MUAs. |
9419 | ||
b349f79f | 9420 | @item @file{org-man.el} by @i{Carsten Dominik} |
55e0839d CD |
9421 | Support for links to manpages in Org-mode. |
9422 | ||
b349f79f | 9423 | @item @file{org-mtags.el} by @i{Carsten Dominik} |
55e0839d CD |
9424 | Support for some Muse-like tags in Org-mode. This package allows you to |
9425 | write @code{<example>} and @code{<src>} and other syntax copied from Emacs | |
9426 | Muse, right inside an Org file. The goal here is to make it easy to publish | |
9427 | the same file using either org-publish or Muse. | |
9428 | ||
a50253cc | 9429 | @item @file{org-panel.el} by @i{Lennart Borgman} |
55e0839d CD |
9430 | Simplified and display-aided access to some Org commands. |
9431 | ||
b349f79f | 9432 | @item @file{org-registry.el} by @i{Bastien Guerry} |
55e0839d CD |
9433 | A registry for Org links, to find out from where links point to a given file |
9434 | or location. | |
9435 | ||
b349f79f | 9436 | @item @file{org2rem.el} by @i{Bastien Guerry} |
55e0839d CD |
9437 | Convert org appointments into reminders for the @file{remind} program. |
9438 | ||
b349f79f | 9439 | @item @file{org-screen.el} by @i{Andrew Hyatt} |
55e0839d CD |
9440 | Visit screen sessions through Org-mode links. |
9441 | ||
b349f79f | 9442 | @item @file{org-toc.el} by @i{Bastien Guerry} |
55e0839d CD |
9443 | Table of contents in a separate buffer, with fast access to sections and easy |
9444 | visibility cycling. | |
9445 | ||
b349f79f | 9446 | @item @file{orgtbl-sqlinsert.el} by @i{Jason Riedy} |
55e0839d CD |
9447 | Convert Org-mode tables to SQL insertions. Documentation for this can be |
9448 | found on the Worg pages. | |
9449 | ||
b349f79f CD |
9450 | @end table |
9451 | ||
b349f79f CD |
9452 | @node Other extensions, , Extensions in the contrib directory, Extensions |
9453 | @section Other extensions | |
9454 | ||
9455 | @i{TO BE DONE} | |
9456 | ||
9457 | @node Hacking, History and Acknowledgments, Extensions, Top | |
9458 | @appendix Hacking | |
9459 | ||
9460 | This appendix covers some aspects where users can extend the functionality of | |
a7808fba | 9461 | Org. |
4009494e GM |
9462 | |
9463 | @menu | |
4009494e GM |
9464 | * Adding hyperlink types:: New custom link types |
9465 | * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs | |
9466 | * Dynamic blocks:: Automatically filled blocks | |
9467 | * Special agenda views:: Customized views | |
9468 | * Using the property API:: Writing programs that use entry properties | |
b349f79f | 9469 | * Using the mapping API:: Mapping over all or selected entries |
4009494e GM |
9470 | @end menu |
9471 | ||
b349f79f | 9472 | @node Adding hyperlink types, Tables in arbitrary syntax, Hacking, Hacking |
4009494e GM |
9473 | @section Adding hyperlink types |
9474 | @cindex hyperlinks, adding new types | |
9475 | ||
a7808fba | 9476 | Org has a large number of hyperlink types built-in |
4009494e | 9477 | (@pxref{Hyperlinks}). If you would like to add new link types, it |
864c9740 | 9478 | provides an interface for doing so. Let's look at an example file |
4009494e | 9479 | @file{org-man.el} that will add support for creating links like |
a7808fba | 9480 | @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside |
4009494e GM |
9481 | emacs: |
9482 | ||
9483 | @lisp | |
a7808fba | 9484 | ;;; org-man.el - Support for links to manpages in Org |
4009494e GM |
9485 | |
9486 | (require 'org) | |
9487 | ||
9488 | (org-add-link-type "man" 'org-man-open) | |
9489 | (add-hook 'org-store-link-functions 'org-man-store-link) | |
9490 | ||
9491 | (defcustom org-man-command 'man | |
9492 | "The Emacs command to be used to display a man page." | |
9493 | :group 'org-link | |
9494 | :type '(choice (const man) (const woman))) | |
9495 | ||
9496 | (defun org-man-open (path) | |
9497 | "Visit the manpage on PATH. | |
9498 | PATH should be a topic that can be thrown at the man command." | |
9499 | (funcall org-man-command path)) | |
9500 | ||
9501 | (defun org-man-store-link () | |
9502 | "Store a link to a manpage." | |
9503 | (when (memq major-mode '(Man-mode woman-mode)) | |
9504 | ;; This is a man page, we do make this link | |
9505 | (let* ((page (org-man-get-page-name)) | |
9506 | (link (concat "man:" page)) | |
9507 | (description (format "Manpage for %s" page))) | |
9508 | (org-store-link-props | |
9509 | :type "man" | |
9510 | :link link | |
9511 | :description description)))) | |
9512 | ||
9513 | (defun org-man-get-page-name () | |
9514 | "Extract the page name from the buffer name." | |
9515 | ;; This works for both `Man-mode' and `woman-mode'. | |
9516 | (if (string-match " \\(\\S-+\\)\\*" (buffer-name)) | |
9517 | (match-string 1 (buffer-name)) | |
9518 | (error "Cannot create link to this man page"))) | |
9519 | ||
9520 | (provide 'org-man) | |
9521 | ||
9522 | ;;; org-man.el ends here | |
9523 | @end lisp | |
9524 | ||
9525 | @noindent | |
9526 | You would activate this new link type in @file{.emacs} with | |
9527 | ||
9528 | @lisp | |
9529 | (require 'org-man) | |
9530 | @end lisp | |
9531 | ||
9532 | @noindent | |
864c9740 | 9533 | Let's go through the file and see what it does. |
4009494e | 9534 | @enumerate |
28a16a1b | 9535 | @item |
4009494e GM |
9536 | It does @code{(require 'org)} to make sure that @file{org.el} has been |
9537 | loaded. | |
9538 | @item | |
9539 | The next line calls @code{org-add-link-type} to define a new link type | |
9540 | with prefix @samp{man}. The call also contains the name of a function | |
9541 | that will be called to follow such a link. | |
9542 | @item | |
9543 | The next line adds a function to @code{org-store-link-functions}, in | |
9544 | order to allow the command @kbd{C-c l} to record a useful link in a | |
9545 | buffer displaying a man page. | |
9546 | @end enumerate | |
9547 | ||
9548 | The rest of the file defines the necessary variables and functions. | |
9549 | First there is a customization variable that determines which emacs | |
a7808fba | 9550 | command should be used to display man pages. There are two options, |
4009494e GM |
9551 | @code{man} and @code{woman}. Then the function to follow a link is |
9552 | defined. It gets the link path as an argument - in this case the link | |
9553 | path is just a topic for the manual command. The function calls the | |
9554 | value of @code{org-man-command} to display the man page. | |
9555 | ||
9556 | Finally the function @code{org-man-store-link} is defined. When you try | |
9557 | to store a link with @kbd{C-c l}, also this function will be called to | |
9558 | try to make a link. The function must first decide if it is supposed to | |
9559 | create the link for this buffer type, we do this by checking the value | |
9560 | of the variable @code{major-mode}. If not, the function must exit and | |
a7808fba CD |
9561 | return the value @code{nil}. If yes, the link is created by getting the |
9562 | manual topic from the buffer name and prefixing it with the string | |
4009494e GM |
9563 | @samp{man:}. Then it must call the command @code{org-store-link-props} |
9564 | and set the @code{:type} and @code{:link} properties. Optionally you | |
9565 | can also set the @code{:description} property to provide a default for | |
a7808fba | 9566 | the link description when the link is later inserted into an Org |
4009494e GM |
9567 | buffer with @kbd{C-c C-l}. |
9568 | ||
b349f79f | 9569 | @node Tables in arbitrary syntax, Dynamic blocks, Adding hyperlink types, Hacking |
a7808fba | 9570 | @section Tables and lists in arbitrary syntax |
4009494e | 9571 | @cindex tables, in other modes |
dbc28aaa | 9572 | @cindex lists, in other modes |
a7808fba | 9573 | @cindex Orgtbl mode |
4009494e | 9574 | |
a7808fba | 9575 | Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a |
4009494e | 9576 | frequent feature request has been to make it work with native tables in |
dbc28aaa CD |
9577 | specific languages, for example La@TeX{}. However, this is extremely |
9578 | hard to do in a general way, would lead to a customization nightmare, | |
a7808fba | 9579 | and would take away much of the simplicity of the Orgtbl mode table |
dbc28aaa CD |
9580 | editor. |
9581 | ||
4009494e | 9582 | |
a7808fba | 9583 | This appendix describes a different approach. We keep the Orgtbl mode |
4009494e GM |
9584 | table in its native format (the @i{source table}), and use a custom |
9585 | function to @i{translate} the table to the correct syntax, and to | |
9586 | @i{install} it in the right location (the @i{target table}). This puts | |
9587 | the burden of writing conversion functions on the user, but it allows | |
9588 | for a very flexible system. | |
9589 | ||
dbc28aaa CD |
9590 | Bastien added the ability to do the same with lists. You can use Org's |
9591 | facilities to edit and structure lists by turning @code{orgstruct-mode} | |
9592 | on, then locally exporting such lists in another format (HTML, La@TeX{} | |
a7808fba | 9593 | or Texinfo.) |
dbc28aaa CD |
9594 | |
9595 | ||
4009494e GM |
9596 | @menu |
9597 | * Radio tables:: Sending and receiving | |
9598 | * A LaTeX example:: Step by step, almost a tutorial | |
9599 | * Translator functions:: Copy and modify | |
a7808fba | 9600 | * Radio lists:: Doing the same for lists |
4009494e GM |
9601 | @end menu |
9602 | ||
9603 | @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax | |
9604 | @subsection Radio tables | |
9605 | @cindex radio tables | |
9606 | ||
9607 | To define the location of the target table, you first need to create two | |
9608 | lines that are comments in the current mode, but contain magic words for | |
a7808fba | 9609 | Orgtbl mode to find. Orgtbl mode will insert the translated table |
4009494e GM |
9610 | between these lines, replacing whatever was there before. For example: |
9611 | ||
9612 | @example | |
9613 | /* BEGIN RECEIVE ORGTBL table_name */ | |
9614 | /* END RECEIVE ORGTBL table_name */ | |
9615 | @end example | |
9616 | ||
9617 | @noindent | |
9618 | Just above the source table, we put a special line that tells | |
a7808fba | 9619 | Orgtbl mode how to translate this table and where to install it. For |
4009494e GM |
9620 | example: |
9621 | @example | |
9622 | #+ORGTBL: SEND table_name translation_function arguments.... | |
9623 | @end example | |
9624 | ||
9625 | @noindent | |
9626 | @code{table_name} is the reference name for the table that is also used | |
9627 | in the receiver lines. @code{translation_function} is the Lisp function | |
9628 | that does the translation. Furthermore, the line can contain a list of | |
9629 | arguments (alternating key and value) at the end. The arguments will be | |
9630 | passed as a property list to the translation function for | |
9631 | interpretation. A few standard parameters are already recognized and | |
9632 | acted upon before the translation function is called: | |
9633 | ||
9634 | @table @code | |
9635 | @item :skip N | |
b349f79f CD |
9636 | Skip the first N lines of the table. Hlines do count as separate lines for |
9637 | this parameter! | |
9638 | ||
4009494e GM |
9639 | @item :skipcols (n1 n2 ...) |
9640 | List of columns that should be skipped. If the table has a column with | |
9641 | calculation marks, that column is automatically discarded as well. | |
9642 | Please note that the translator function sees the table @emph{after} the | |
9643 | removal of these columns, the function never knows that there have been | |
9644 | additional columns. | |
9645 | @end table | |
9646 | ||
9647 | @noindent | |
9648 | The one problem remaining is how to keep the source table in the buffer | |
9649 | without disturbing the normal workings of the file, for example during | |
9650 | compilation of a C file or processing of a La@TeX{} file. There are a | |
9651 | number of different solutions: | |
9652 | ||
9653 | @itemize @bullet | |
9654 | @item | |
9655 | The table could be placed in a block comment if that is supported by the | |
a7808fba | 9656 | language. For example, in C mode you could wrap the table between |
4009494e | 9657 | @samp{/*} and @samp{*/} lines. |
28a16a1b | 9658 | @item |
4009494e GM |
9659 | Sometimes it is possible to put the table after some kind of @i{END} |
9660 | statement, for example @samp{\bye} in TeX and @samp{\end@{document@}} | |
9661 | in La@TeX{}. | |
9662 | @item | |
9663 | You can just comment the table line by line whenever you want to process | |
9664 | the file, and uncomment it whenever you need to edit the table. This | |
9665 | only sounds tedious - the command @kbd{M-x orgtbl-toggle-comment} does | |
9666 | make this comment-toggling very easy, in particular if you bind it to a | |
9667 | key. | |
9668 | @end itemize | |
9669 | ||
9670 | @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax | |
dbc28aaa | 9671 | @subsection A LaTeX example of radio tables |
a7808fba | 9672 | @cindex LaTeX, and Orgtbl mode |
4009494e GM |
9673 | |
9674 | The best way to wrap the source table in La@TeX{} is to use the | |
9675 | @code{comment} environment provided by @file{comment.sty}. It has to be | |
9676 | activated by placing @code{\usepackage@{comment@}} into the document | |
a7808fba CD |
9677 | header. Orgtbl mode can insert a radio table skeleton@footnote{By |
9678 | default this works only for La@TeX{}, HTML, and Texinfo. Configure the | |
4009494e GM |
9679 | variable @code{orgtbl-radio-tables} to install templates for other |
9680 | modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will | |
55e0839d | 9681 | be prompted for a table name, let's say we use @samp{salesfigures}. You |
4009494e GM |
9682 | will then get the following template: |
9683 | ||
b349f79f | 9684 | @cindex #+ORGTBL: SEND |
4009494e GM |
9685 | @example |
9686 | % BEGIN RECEIVE ORGTBL salesfigures | |
9687 | % END RECEIVE ORGTBL salesfigures | |
9688 | \begin@{comment@} | |
9689 | #+ORGTBL: SEND salesfigures orgtbl-to-latex | |
9690 | | | | | |
9691 | \end@{comment@} | |
9692 | @end example | |
9693 | ||
9694 | @noindent | |
a7808fba | 9695 | The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function |
4009494e GM |
9696 | @code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it |
9697 | into the receiver location with name @code{salesfigures}. You may now | |
9698 | fill in the table, feel free to use the spreadsheet features@footnote{If | |
9699 | the @samp{#+TBLFM} line contains an odd number of dollar characters, | |
a7808fba | 9700 | this may cause problems with font-lock in LaTeX mode. As shown in the |
4009494e GM |
9701 | example you can fix this by adding an extra line inside the |
9702 | @code{comment} environment that is used to balance the dollar | |
9703 | expressions. If you are using AUCTeX with the font-latex library, a | |
9704 | much better solution is to add the @code{comment} environment to the | |
9705 | variable @code{LaTeX-verbatim-environments}.}: | |
9706 | ||
9707 | @example | |
9708 | % BEGIN RECEIVE ORGTBL salesfigures | |
9709 | % END RECEIVE ORGTBL salesfigures | |
9710 | \begin@{comment@} | |
9711 | #+ORGTBL: SEND salesfigures orgtbl-to-latex | |
9712 | | Month | Days | Nr sold | per day | | |
9713 | |-------+------+---------+---------| | |
9714 | | Jan | 23 | 55 | 2.4 | | |
9715 | | Feb | 21 | 16 | 0.8 | | |
9716 | | March | 22 | 278 | 12.6 | | |
9717 | #+TBLFM: $4=$3/$2;%.1f | |
9718 | % $ (optional extra dollar to keep font-lock happy, see footnote) | |
9719 | \end@{comment@} | |
9720 | @end example | |
9721 | ||
9722 | @noindent | |
9723 | When you are done, press @kbd{C-c C-c} in the table to get the converted | |
9724 | table inserted between the two marker lines. | |
9725 | ||
55e0839d | 9726 | Now let's assume you want to make the table header by hand, because you |
4009494e GM |
9727 | want to control how columns are aligned etc. In this case we make sure |
9728 | that the table translator does skip the first 2 lines of the source | |
9729 | table, and tell the command to work as a @i{splice}, i.e. to not produce | |
9730 | header and footer commands of the target table: | |
9731 | ||
9732 | @example | |
9733 | \begin@{tabular@}@{lrrr@} | |
9734 | Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\ | |
9735 | % BEGIN RECEIVE ORGTBL salesfigures | |
9736 | % END RECEIVE ORGTBL salesfigures | |
9737 | \end@{tabular@} | |
9738 | % | |
9739 | \begin@{comment@} | |
9740 | #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2 | |
9741 | | Month | Days | Nr sold | per day | | |
9742 | |-------+------+---------+---------| | |
9743 | | Jan | 23 | 55 | 2.4 | | |
9744 | | Feb | 21 | 16 | 0.8 | | |
9745 | | March | 22 | 278 | 12.6 | | |
9746 | #+TBLFM: $4=$3/$2;%.1f | |
9747 | \end@{comment@} | |
9748 | @end example | |
9749 | ||
9750 | The La@TeX{} translator function @code{orgtbl-to-latex} is already part of | |
a7808fba | 9751 | Orgtbl mode. It uses a @code{tabular} environment to typeset the table |
4009494e | 9752 | and marks horizontal lines with @code{\hline}. Furthermore, it |
b349f79f | 9753 | interprets the following parameters (see also @ref{Translator functions}): |
4009494e GM |
9754 | |
9755 | @table @code | |
9756 | @item :splice nil/t | |
9757 | When set to t, return only table body lines, don't wrap them into a | |
9758 | tabular environment. Default is nil. | |
9759 | ||
9760 | @item :fmt fmt | |
9761 | A format to be used to wrap each field, should contain @code{%s} for the | |
9762 | original field value. For example, to wrap each field value in dollars, | |
9763 | you could use @code{:fmt "$%s$"}. This may also be a property list with | |
9764 | column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}. | |
a7808fba CD |
9765 | A function of one argument can be used in place of the strings; the |
9766 | function must return a formatted string. | |
4009494e GM |
9767 | |
9768 | @item :efmt efmt | |
9769 | Use this format to print numbers with exponentials. The format should | |
9770 | have @code{%s} twice for inserting mantissa and exponent, for example | |
9771 | @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This | |
9772 | may also be a property list with column numbers and formats, for example | |
9773 | @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After | |
9774 | @code{efmt} has been applied to a value, @code{fmt} will also be | |
a7808fba CD |
9775 | applied. Similar to @code{fmt}, functions of two arguments can be |
9776 | supplied instead of strings. | |
4009494e GM |
9777 | @end table |
9778 | ||
dbc28aaa | 9779 | @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax |
4009494e | 9780 | @subsection Translator functions |
a7808fba | 9781 | @cindex HTML, and Orgtbl mode |
4009494e GM |
9782 | @cindex translator function |
9783 | ||
b349f79f CD |
9784 | Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv} |
9785 | (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values) | |
9786 | @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}. | |
9787 | Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same | |
9788 | code that produces tables during HTML export.}, these all use a generic | |
9789 | translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex} | |
9790 | itself is a very short function that computes the column definitions for the | |
9791 | @code{tabular} environment, defines a few field and line separators and then | |
9792 | hands over to the generic translator. Here is the entire code: | |
4009494e GM |
9793 | |
9794 | @lisp | |
9795 | @group | |
9796 | (defun orgtbl-to-latex (table params) | |
a7808fba | 9797 | "Convert the Orgtbl mode TABLE to LaTeX." |
4009494e GM |
9798 | (let* ((alignment (mapconcat (lambda (x) (if x "r" "l")) |
9799 | org-table-last-alignment "")) | |
9800 | (params2 | |
9801 | (list | |
9802 | :tstart (concat "\\begin@{tabular@}@{" alignment "@}") | |
9803 | :tend "\\end@{tabular@}" | |
9804 | :lstart "" :lend " \\\\" :sep " & " | |
9805 | :efmt "%s\\,(%s)" :hline "\\hline"))) | |
9806 | (orgtbl-to-generic table (org-combine-plists params2 params)))) | |
9807 | @end group | |
9808 | @end lisp | |
9809 | ||
9810 | As you can see, the properties passed into the function (variable | |
9811 | @var{PARAMS}) are combined with the ones newly defined in the function | |
9812 | (variable @var{PARAMS2}). The ones passed into the function (i.e. the | |
9813 | ones set by the @samp{ORGTBL SEND} line) take precedence. So if you | |
9814 | would like to use the La@TeX{} translator, but wanted the line endings to | |
9815 | be @samp{\\[2mm]} instead of the default @samp{\\}, you could just | |
9816 | overrule the default with | |
9817 | ||
9818 | @example | |
9819 | #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]" | |
9820 | @end example | |
9821 | ||
9822 | For a new language, you can either write your own converter function in | |
9823 | analogy with the La@TeX{} translator, or you can use the generic function | |
9824 | directly. For example, if you have a language where a table is started | |
9825 | with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are | |
9826 | started with @samp{!BL!}, ended with @samp{!EL!} and where the field | |
9827 | separator is a TAB, you could call the generic translator like this (on | |
9828 | a single line!): | |
9829 | ||
9830 | @example | |
9831 | #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!" | |
9832 | :lstart "!BL! " :lend " !EL!" :sep "\t" | |
9833 | @end example | |
9834 | ||
9835 | @noindent | |
9836 | Please check the documentation string of the function | |
9837 | @code{orgtbl-to-generic} for a full list of parameters understood by | |
9838 | that function and remember that you can pass each of them into | |
9839 | @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function | |
9840 | using the generic function. | |
9841 | ||
9842 | Of course you can also write a completely new function doing complicated | |
9843 | things the generic translator cannot do. A translator function takes | |
9844 | two arguments. The first argument is the table, a list of lines, each | |
9845 | line either the symbol @code{hline} or a list of fields. The second | |
9846 | argument is the property list containing all parameters specified in the | |
9847 | @samp{#+ORGTBL: SEND} line. The function must return a single string | |
9848 | containing the formatted table. If you write a generally useful | |
9849 | translator, please post it on @code{emacs-orgmode@@gnu.org} so that | |
9850 | others can benefit from your work. | |
9851 | ||
dbc28aaa CD |
9852 | @node Radio lists, , Translator functions, Tables in arbitrary syntax |
9853 | @subsection Radio lists | |
9854 | @cindex radio lists | |
9855 | @cindex org-list-insert-radio-list | |
9856 | ||
9857 | Sending and receiving radio lists works exactly the same way than | |
9858 | sending and receiving radio tables (@pxref{Radio tables}) @footnote{You | |
9859 | need to load the @code{org-export-latex.el} package to use radio lists | |
9860 | since the relevant code is there for now.}. As for radio tables, you | |
a7808fba | 9861 | can insert radio lists templates in HTML, La@TeX{} and Texinfo modes by |
dbc28aaa CD |
9862 | calling @code{org-list-insert-radio-list}. |
9863 | ||
9864 | Here are the differences with radio tables: | |
9865 | ||
9866 | @itemize @minus | |
9867 | @item | |
9868 | Use @code{ORGLST} instead of @code{ORGTBL}. | |
9869 | @item | |
9870 | The available translation functions for radio lists don't take | |
9871 | parameters. | |
28a16a1b | 9872 | @item |
dbc28aaa CD |
9873 | `C-c C-c' will work when pressed on the first item of the list. |
9874 | @end itemize | |
9875 | ||
9876 | Here is a La@TeX{} example. Let's say that you have this in your | |
9877 | La@TeX{} file: | |
9878 | ||
9879 | @example | |
9880 | % BEGIN RECEIVE ORGLST to-buy | |
9881 | % END RECEIVE ORGLST to-buy | |
9882 | \begin@{comment@} | |
9883 | #+ORGLIST: SEND to-buy orgtbl-to-latex | |
9884 | - a new house | |
9885 | - a new computer | |
9886 | + a new keyboard | |
9887 | + a new mouse | |
9888 | - a new life | |
9889 | \end@{comment@} | |
9890 | @end example | |
9891 | ||
9892 | Pressing `C-c C-c' on @code{a new house} and will insert the converted | |
9893 | La@TeX{} list between the two marker lines. | |
9894 | ||
b349f79f | 9895 | @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking |
4009494e GM |
9896 | @section Dynamic blocks |
9897 | @cindex dynamic blocks | |
9898 | ||
a7808fba | 9899 | Org documents can contain @emph{dynamic blocks}. These are |
4009494e GM |
9900 | specially marked regions that are updated by some user-written function. |
9901 | A good example for such a block is the clock table inserted by the | |
9902 | command @kbd{C-c C-x C-r} (@pxref{Clocking work time}). | |
9903 | ||
9904 | Dynamic block are enclosed by a BEGIN-END structure that assigns a name | |
9905 | to the block and can also specify parameters for the function producing | |
9906 | the content of the block. | |
9907 | ||
b349f79f | 9908 | #+BEGIN:dynamic block |
4009494e GM |
9909 | @example |
9910 | #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ... | |
9911 | ||
9912 | #+END: | |
9913 | @end example | |
9914 | ||
9915 | Dynamic blocks are updated with the following commands | |
9916 | ||
9917 | @table @kbd | |
9918 | @kindex C-c C-x C-u | |
9919 | @item C-c C-x C-u | |
9920 | Update dynamic block at point. | |
9921 | @kindex C-u C-c C-x C-u | |
9922 | @item C-u C-c C-x C-u | |
9923 | Update all dynamic blocks in the current file. | |
9924 | @end table | |
9925 | ||
9926 | Updating a dynamic block means to remove all the text between BEGIN and | |
9927 | END, parse the BEGIN line for parameters and then call the specific | |
28a16a1b CD |
9928 | writer function for this block to insert the new content. If you want |
9929 | to use the original content in the writer function, you can use the | |
9930 | extra parameter @code{:content}. | |
9931 | ||
9932 | For a block with name @code{myblock}, the writer function is | |
4009494e GM |
9933 | @code{org-dblock-write:myblock} with as only parameter a property list |
9934 | with the parameters given in the begin line. Here is a trivial example | |
9935 | of a block that keeps track of when the block update function was last | |
9936 | run: | |
9937 | ||
9938 | @example | |
9939 | #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M" | |
9940 | ||
9941 | #+END: | |
9942 | @end example | |
9943 | ||
9944 | @noindent | |
9945 | The corresponding block writer function could look like this: | |
9946 | ||
9947 | @lisp | |
9948 | (defun org-dblock-write:block-update-time (params) | |
9949 | (let ((fmt (or (plist-get params :format) "%d. %m. %Y"))) | |
9950 | (insert "Last block update at: " | |
9951 | (format-time-string fmt (current-time))))) | |
9952 | @end lisp | |
9953 | ||
9954 | If you want to make sure that all dynamic blocks are always up-to-date, | |
9955 | you could add the function @code{org-update-all-dblocks} to a hook, for | |
9956 | example @code{before-save-hook}. @code{org-update-all-dblocks} is | |
a7808fba CD |
9957 | written in a way that is does nothing in buffers that are not in |
9958 | @code{org-mode}. | |
4009494e | 9959 | |
b349f79f | 9960 | @node Special agenda views, Using the property API, Dynamic blocks, Hacking |
a7808fba | 9961 | @section Special agenda views |
4009494e GM |
9962 | @cindex agenda views, user-defined |
9963 | ||
a7808fba | 9964 | Org provides a special hook that can be used to narrow down the |
4009494e GM |
9965 | selection made by any of the agenda views. You may specify a function |
9966 | that is used at each match to verify if the match should indeed be part | |
9967 | of the agenda view, and if not, how much should be skipped. | |
9968 | ||
9969 | Let's say you want to produce a list of projects that contain a WAITING | |
9970 | tag anywhere in the project tree. Let's further assume that you have | |
a7808fba CD |
9971 | marked all tree headings that define a project with the TODO keyword |
9972 | PROJECT. In this case you would run a TODO search for the keyword | |
4009494e GM |
9973 | PROJECT, but skip the match unless there is a WAITING tag anywhere in |
9974 | the subtree belonging to the project line. | |
9975 | ||
9976 | To achieve this, you must write a function that searches the subtree for | |
9977 | the tag. If the tag is found, the function must return @code{nil} to | |
9978 | indicate that this match should not be skipped. If there is no such | |
9979 | tag, return the location of the end of the subtree, to indicate that | |
9980 | search should continue from there. | |
9981 | ||
9982 | @lisp | |
9983 | (defun my-skip-unless-waiting () | |
9984 | "Skip trees that are not waiting" | |
9985 | (let ((subtree-end (save-excursion (org-end-of-subtree t)))) | |
dbc28aaa | 9986 | (if (re-search-forward ":waiting:" subtree-end t) |
4009494e GM |
9987 | nil ; tag found, do not skip |
9988 | subtree-end))) ; tag not found, continue after end of subtree | |
9989 | @end lisp | |
9990 | ||
9991 | Now you may use this function in an agenda custom command, for example | |
9992 | like this: | |
9993 | ||
9994 | @lisp | |
9995 | (org-add-agenda-custom-command | |
9996 | '("b" todo "PROJECT" | |
e45e3595 | 9997 | ((org-agenda-skip-function 'my-skip-unless-waiting) |
4009494e GM |
9998 | (org-agenda-overriding-header "Projects waiting for something: ")))) |
9999 | @end lisp | |
10000 | ||
10001 | Note that this also binds @code{org-agenda-overriding-header} to get a | |
10002 | meaningful header in the agenda view. | |
10003 | ||
a7808fba CD |
10004 | A general way to create custom searches is to base them on a search for |
10005 | entries with a certain level limit. If you want to study all entries with | |
10006 | your custom search function, simply do a search for @samp{LEVEL>0}, and then | |
10007 | use @code{org-agenda-skip-function} to select the entries you really want to | |
10008 | have. | |
10009 | ||
4009494e GM |
10010 | You may also put a Lisp form into @code{org-agenda-skip-function}. In |
10011 | particular, you may use the functions @code{org-agenda-skip-entry-if} | |
10012 | and @code{org-agenda-skip-subtree-if} in this form, for example: | |
10013 | ||
10014 | @table @code | |
10015 | @item '(org-agenda-skip-entry-if 'scheduled) | |
10016 | Skip current entry if it has been scheduled. | |
10017 | @item '(org-agenda-skip-entry-if 'notscheduled) | |
10018 | Skip current entry if it has not been scheduled. | |
10019 | @item '(org-agenda-skip-entry-if 'deadline) | |
10020 | Skip current entry if it has a deadline. | |
10021 | @item '(org-agenda-skip-entry-if 'scheduled 'deadline) | |
10022 | Skip current entry if it has a deadline, or if it is scheduled. | |
10023 | @item '(org-agenda-skip-entry 'regexp "regular expression") | |
dbc28aaa CD |
10024 | Skip current entry if the regular expression matches in the entry. |
10025 | @item '(org-agenda-skip-entry 'notregexp "regular expression") | |
10026 | Skip current entry unless the regular expression matches. | |
4009494e GM |
10027 | @item '(org-agenda-skip-subtree-if 'regexp "regular expression") |
10028 | Same as above, but check and skip the entire subtree. | |
10029 | @end table | |
10030 | ||
10031 | Therefore we could also have written the search for WAITING projects | |
10032 | like this, even without defining a special function: | |
10033 | ||
10034 | @lisp | |
10035 | (org-add-agenda-custom-command | |
10036 | '("b" todo "PROJECT" | |
10037 | ((org-agenda-skip-function '(org-agenda-skip-subtree-if | |
dbc28aaa | 10038 | 'regexp ":waiting:")) |
4009494e GM |
10039 | (org-agenda-overriding-header "Projects waiting for something: ")))) |
10040 | @end lisp | |
10041 | ||
b349f79f | 10042 | @node Using the property API, Using the mapping API, Special agenda views, Hacking |
4009494e GM |
10043 | @section Using the property API |
10044 | @cindex API, for properties | |
10045 | @cindex properties, API | |
10046 | ||
10047 | Here is a description of the functions that can be used to work with | |
10048 | properties. | |
10049 | ||
10050 | @defun org-entry-properties &optional pom which | |
10051 | Get all properties of the entry at point-or-marker POM. | |
10052 | This includes the TODO keyword, the tags, time strings for deadline, | |
10053 | scheduled, and clocking, and any additional properties defined in the | |
10054 | entry. The return value is an alist, keys may occur multiple times | |
10055 | if the property key was used several times. | |
10056 | POM may also be nil, in which case the current entry is used. | |
10057 | If WHICH is nil or `all', get all properties. If WHICH is | |
10058 | `special' or `standard', only get that subclass. | |
10059 | @end defun | |
10060 | @defun org-entry-get pom property &optional inherit | |
a7808fba CD |
10061 | Get value of PROPERTY for entry at point-or-marker POM. By default, |
10062 | this only looks at properties defined locally in the entry. If INHERIT | |
10063 | is non-nil and the entry does not have the property, then also check | |
10064 | higher levels of the hierarchy. If INHERIT is the symbol | |
10065 | @code{selective}, use inheritance if and only if the setting of | |
10066 | @code{org-use-property-inheritance} selects PROPERTY for inheritance. | |
4009494e GM |
10067 | @end defun |
10068 | ||
10069 | @defun org-entry-delete pom property | |
10070 | Delete the property PROPERTY from entry at point-or-marker POM. | |
10071 | @end defun | |
10072 | ||
10073 | @defun org-entry-put pom property value | |
10074 | Set PROPERTY to VALUE for entry at point-or-marker POM. | |
10075 | @end defun | |
10076 | ||
10077 | @defun org-buffer-property-keys &optional include-specials | |
10078 | Get all property keys in the current buffer. | |
10079 | @end defun | |
10080 | ||
10081 | @defun org-insert-property-drawer | |
10082 | Insert a property drawer at point. | |
10083 | @end defun | |
10084 | ||
864c9740 CD |
10085 | @defun org-entry-put-multivalued-property pom property &rest values |
10086 | Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of | |
10087 | strings. They will be concatenated, with spaces as separators. | |
10088 | @end defun | |
10089 | ||
10090 | @defun org-entry-get-multivalued-property pom property | |
10091 | Treat the value of the property PROPERTY as a whitespace-separated list of | |
10092 | values and return the values as a list of strings. | |
10093 | @end defun | |
10094 | ||
a7808fba CD |
10095 | @defun org-entry-add-to-multivalued-property pom property value |
10096 | Treat the value of the property PROPERTY as a whitespace-separated list of | |
10097 | values and make sure that VALUE is in this list. | |
10098 | @end defun | |
10099 | ||
10100 | @defun org-entry-remove-from-multivalued-property pom property value | |
10101 | Treat the value of the property PROPERTY as a whitespace-separated list of | |
10102 | values and make sure that VALUE is @emph{not} in this list. | |
10103 | @end defun | |
10104 | ||
10105 | @defun org-entry-member-in-multivalued-property pom property value | |
10106 | Treat the value of the property PROPERTY as a whitespace-separated list of | |
10107 | values and check if VALUE is in this list. | |
10108 | @end defun | |
10109 | ||
b349f79f CD |
10110 | @node Using the mapping API, , Using the property API, Hacking |
10111 | @section Using the mapping API | |
10112 | @cindex API, for mapping | |
10113 | @cindex mapping entries, API | |
10114 | ||
10115 | Org has sophisticated mapping capabilities to find all entries satisfying | |
10116 | certain criteria. Internally, this functionality is used to produce agenda | |
10117 | views, but there is also an API that can be used to execute arbitrary | |
10118 | functions for each or selected entries. The main entry point for this API | |
96c8522a | 10119 | is: |
b349f79f CD |
10120 | |
10121 | @defun org-map-entries func &optional match scope &rest skip | |
10122 | Call FUNC at each headline selected by MATCH in SCOPE. | |
10123 | ||
10124 | FUNC is a function or a lisp form. The function will be called without | |
10125 | arguments, with the cursor positioned at the beginning of the headline. | |
10126 | The return values of all calls to the function will be collected and | |
10127 | returned as a list. | |
10128 | ||
864c9740 | 10129 | MATCH is a tags/property/todo match as it is used in the agenda match view. |
b349f79f CD |
10130 | Only headlines that are matched by this query will be considered during |
10131 | the iteration. When MATCH is nil or t, all headlines will be | |
10132 | visited by the iteration. | |
10133 | ||
10134 | SCOPE determines the scope of this command. It can be any of: | |
10135 | ||
10136 | @example | |
10137 | nil @r{the current buffer, respecting the restriction if any} | |
10138 | tree @r{the subtree started with the entry at point} | |
10139 | file @r{the current buffer, without restriction} | |
10140 | file-with-archives | |
10141 | @r{the current buffer, and any archives associated with it} | |
10142 | agenda @r{all agenda files} | |
10143 | agenda-with-archives | |
10144 | @r{all agenda files with any archive files associated with them} | |
10145 | (file1 file2 ...) | |
10146 | @r{if this is a list, all files in the list will be scanned} | |
10147 | @end example | |
10148 | ||
10149 | The remaining args are treated as settings for the skipping facilities of | |
10150 | the scanner. The following items can be given here: | |
10151 | ||
10152 | @example | |
10153 | archive @r{skip trees with the archive tag} | |
10154 | comment @r{skip trees with the COMMENT keyword} | |
10155 | function or Lisp form | |
10156 | @r{will be used as value for @code{org-agenda-skip-function},} | |
10157 | @r{so whenever the the function returns t, FUNC} | |
10158 | @r{will not be called for that entry and search will} | |
10159 | @r{continue from the point where the function leaves it} | |
10160 | @end example | |
10161 | @end defun | |
10162 | ||
10163 | The function given to that mapping routine can really do anything you like. | |
a50253cc GM |
10164 | It can use the property API (@pxref{Using the property API}) to gather more |
10165 | information about the entry, or in order to change metadata in the entry. | |
b349f79f | 10166 | Here are a couple of functions that might be handy: |
96c8522a | 10167 | |
b349f79f CD |
10168 | @defun org-todo &optional arg |
10169 | Change the TODO state of the entry, see the docstring of the functions for | |
10170 | the many possible values for the argument ARG. | |
10171 | @end defun | |
10172 | ||
10173 | @defun org-priority &optional action | |
10174 | Change the priority of the entry, see the docstring of this function for the | |
10175 | possible values for ACTION. | |
10176 | @end defun | |
10177 | ||
10178 | @defun org-toggle-tag tag &optional onoff | |
10179 | Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on} | |
10180 | or @code{off} will not toggle tag, but ensure that it is either on or off. | |
10181 | @end defun | |
10182 | ||
10183 | @defun org-promote | |
10184 | Promote the current entry. | |
10185 | @end defun | |
10186 | ||
10187 | @defun org-demote | |
10188 | Demote the current entry. | |
10189 | @end defun | |
10190 | ||
10191 | Here is a simple example that will turn all entries in the current file with | |
10192 | a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}. | |
10193 | Entries in comment trees and in archive trees will be ignored. | |
10194 | ||
10195 | @lisp | |
10196 | (org-map-entries | |
10197 | '(org-todo "UPCOMING") | |
10198 | "+TOMORROW" 'file 'archive 'comment) | |
10199 | @end lisp | |
10200 | ||
10201 | The following example counts the number of entries with TODO keyword | |
10202 | @code{WAITING}, in all agenda files. | |
10203 | ||
10204 | @lisp | |
96c8522a | 10205 | (length (org-map-entries t "/+WAITING" 'agenda)) |
b349f79f CD |
10206 | @end lisp |
10207 | ||
10208 | @node History and Acknowledgments, Main Index, Hacking, Top | |
4009494e GM |
10209 | @appendix History and Acknowledgments |
10210 | @cindex acknowledgments | |
10211 | @cindex history | |
10212 | @cindex thanks | |
10213 | ||
a7808fba CD |
10214 | Org was borne in 2003, out of frustration over the user interface |
10215 | of the Emacs Outline mode. I was trying to organize my notes and | |
4009494e GM |
10216 | projects, and using Emacs seemed to be the natural way to go. However, |
10217 | having to remember eleven different commands with two or three keys per | |
a7808fba | 10218 | command, only to hide and show parts of the outline tree, that seemed |
4009494e GM |
10219 | entirely unacceptable to me. Also, when using outlines to take notes, I |
10220 | constantly want to restructure the tree, organizing it parallel to my | |
10221 | thoughts and plans. @emph{Visibility cycling} and @emph{structure | |
10222 | editing} were originally implemented in the package | |
10223 | @file{outline-magic.el}, but quickly moved to the more general | |
10224 | @file{org.el}. As this environment became comfortable for project | |
10225 | planning, the next step was adding @emph{TODO entries}, basic @emph{time | |
10226 | stamps}, and @emph{table support}. These areas highlight the two main | |
a7808fba | 10227 | goals that Org still has today: To create a new, outline-based, |
4009494e GM |
10228 | plain text mode with innovative and intuitive editing features, and to |
10229 | incorporate project planning functionality directly into a notes file. | |
10230 | ||
a50253cc | 10231 | A special thanks goes to @i{Bastien Guerry} who has not only written a large |
a7808fba CD |
10232 | number of extensions to Org (most of them integrated into the core by now), |
10233 | but has also helped the development and maintenance of Org so much that he | |
10234 | should be considered co-author of this package. | |
10235 | ||
4009494e GM |
10236 | Since the first release, literally thousands of emails to me or on |
10237 | @code{emacs-orgmode@@gnu.org} have provided a constant stream of bug | |
10238 | reports, feedback, new ideas, and sometimes patches and add-on code. | |
10239 | Many thanks to everyone who has helped to improve this package. I am | |
10240 | trying to keep here a list of the people who had significant influence | |
a7808fba | 10241 | in shaping one or more aspects of Org. The list may not be |
4009494e GM |
10242 | complete, if I have forgotten someone, please accept my apologies and |
10243 | let me know. | |
10244 | ||
10245 | @itemize @bullet | |
10246 | ||
10247 | @item | |
10248 | @i{Russel Adams} came up with the idea for drawers. | |
10249 | @item | |
a7808fba | 10250 | @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}. |
4009494e | 10251 | @item |
b349f79f CD |
10252 | @i{Christophe Bataillon} created the great unicorn logo that we use on the |
10253 | Org-mode website. | |
10254 | @item | |
4009494e GM |
10255 | @i{Alex Bochannek} provided a patch for rounding time stamps. |
10256 | @item | |
10257 | @i{Charles Cave}'s suggestion sparked the implementation of templates | |
10258 | for Remember. | |
10259 | @item | |
10260 | @i{Pavel Chalmoviansky} influenced the agenda treatment of items with | |
10261 | specified time. | |
10262 | @item | |
10263 | @i{Gregory Chernov} patched support for lisp forms into table | |
10264 | calculations and improved XEmacs compatibility, in particular by porting | |
10265 | @file{nouline.el} to XEmacs. | |
10266 | @item | |
10267 | @i{Sacha Chua} suggested to copy some linking code from Planner. | |
10268 | @item | |
5fbc0f11 | 10269 | @i{Eddward DeVilla} proposed and tested checkbox statistics. He also |
4009494e GM |
10270 | came up with the idea of properties, and that there should be an API for |
10271 | them. | |
10272 | @item | |
10273 | @i{Kees Dullemond} used to edit projects lists directly in HTML and so | |
10274 | inspired some of the early development, including HTML export. He also | |
10275 | asked for a way to narrow wide table columns. | |
10276 | @item | |
a7808fba | 10277 | @i{Christian Egli} converted the documentation into Texinfo format, |
4009494e GM |
10278 | patched CSS formatting into the HTML exporter, and inspired the agenda. |
10279 | @item | |
10280 | @i{David Emery} provided a patch for custom CSS support in exported | |
10281 | HTML agendas. | |
10282 | @item | |
10283 | @i{Nic Ferrier} contributed mailcap and XOXO support. | |
10284 | @item | |
28a16a1b CD |
10285 | @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes. |
10286 | @item | |
4009494e GM |
10287 | @i{John Foerch} figured out how to make incremental search show context |
10288 | around a match in a hidden outline tree. | |
10289 | @item | |
dbc28aaa | 10290 | @i{Niels Giesen} had the idea to automatically archive DONE trees. |
4009494e | 10291 | @item |
a7808fba CD |
10292 | @i{Bastien Guerry} wrote the La@TeX{} exporter and @file{org-bibtex.el}, and |
10293 | has been prolific with patches, ideas, and bug reports. | |
4009494e GM |
10294 | @item |
10295 | @i{Kai Grossjohann} pointed out key-binding conflicts with other packages. | |
10296 | @item | |
a7808fba CD |
10297 | @i{Bernt Hansen} has driven much of the support for auto-repeating tasks, |
10298 | task state change logging, and the clocktable. His clear explanations have | |
10299 | been critical when we started to adopt the GIT version control system. | |
10300 | @item | |
864c9740 CD |
10301 | @i{Manuel Hermenegildo} has contributed various ideas, small fixed and |
10302 | patches. | |
10303 | @item | |
a7808fba CD |
10304 | @i{Phil Jackson} wrote @file{org-irc.el}. |
10305 | @item | |
4009494e GM |
10306 | @i{Scott Jaderholm} proposed footnotes, control over whitespace between |
10307 | folded entries, and column view for properties. | |
10308 | @item | |
a7808fba CD |
10309 | @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}. |
10310 | @item | |
4009494e GM |
10311 | @i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also |
10312 | provided frequent feedback and some patches. | |
10313 | @item | |
55e0839d CD |
10314 | @i{Matt Lundin} has proposed last-row references for table formulas and named |
10315 | invisible anchors. He has also worked a lot on the FAQ. | |
10316 | @item | |
4009494e GM |
10317 | @i{Jason F. McBrayer} suggested agenda export to CSV format. |
10318 | @item | |
dbc28aaa CD |
10319 | @i{Max Mikhanosha} came up with the idea of refiling. |
10320 | @item | |
4009494e GM |
10321 | @i{Dmitri Minaev} sent a patch to set priority limits on a per-file |
10322 | basis. | |
10323 | @item | |
10324 | @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler | |
10325 | happy. | |
10326 | @item | |
dbc28aaa CD |
10327 | @i{Rick Moynihan} proposed to allow multiple TODO sequences in a file |
10328 | and to be able to quickly restrict the agenda to a subtree. | |
4009494e GM |
10329 | @item |
10330 | @i{Todd Neal} provided patches for links to Info files and elisp forms. | |
10331 | @item | |
10332 | @i{Tim O'Callaghan} suggested in-file links, search options for general | |
10333 | file links, and TAGS. | |
10334 | @item | |
10335 | @i{Takeshi Okano} translated the manual and David O'Toole's tutorial | |
10336 | into Japanese. | |
10337 | @item | |
10338 | @i{Oliver Oppitz} suggested multi-state TODO items. | |
10339 | @item | |
10340 | @i{Scott Otterson} sparked the introduction of descriptive text for | |
10341 | links, among other things. | |
10342 | @item | |
10343 | @i{Pete Phillips} helped during the development of the TAGS feature, and | |
10344 | provided frequent feedback. | |
10345 | @item | |
10346 | @i{T.V. Raman} reported bugs and suggested improvements. | |
10347 | @item | |
10348 | @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality | |
10349 | control. | |
10350 | @item | |
55e0839d CD |
10351 | @i{Paul Rivier} provided the basic implementation of named footnotes. |
10352 | @item | |
4009494e GM |
10353 | @i{Kevin Rogers} contributed code to access VM files on remote hosts. |
10354 | @item | |
a7808fba CD |
10355 | @i{Sebastian Rose} wrote @file{org-info.js}, a Java script for displaying |
10356 | webpages derived from Org using an Info-like, or a folding interface with | |
10357 | single key navigation. | |
10358 | @item | |
4009494e GM |
10359 | @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a |
10360 | conflict with @file{allout.el}. | |
10361 | @item | |
b349f79f CD |
10362 | @i{Jason Riedy} generalized the send-receive mechanism for orgtbl tables with |
10363 | extensive patches. | |
4009494e | 10364 | @item |
b349f79f CD |
10365 | @i{Philip Rooke} created the Org reference card, provided lots |
10366 | of feedback, developed and applied standards to the Org documentation. | |
4009494e GM |
10367 | @item |
10368 | @i{Christian Schlauer} proposed angular brackets around links, among | |
10369 | other things. | |
10370 | @item | |
864c9740 CD |
10371 | @i{Eric Schulte} wrote @file{org-plot.el}. |
10372 | @item | |
b349f79f | 10373 | Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s |
4009494e GM |
10374 | @file{organizer-mode.el}. |
10375 | @item | |
55e0839d CD |
10376 | @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal |
10377 | examples, and remote highlighting for referenced code lines. | |
a7808fba | 10378 | @item |
64fb801f CD |
10379 | @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is |
10380 | now packaged into Org's @file{contrib} directory. | |
10381 | @item | |
4009494e GM |
10382 | @i{Daniel Sinder} came up with the idea of internal archiving by locking |
10383 | subtrees. | |
10384 | @item | |
10385 | @i{Dale Smith} proposed link abbreviations. | |
10386 | @item | |
864c9740 CD |
10387 | @i{James TD Smith} has contributed a large number of patches for useful |
10388 | tweaks and features. | |
10389 | @item | |
b349f79f CD |
10390 | @i{Adam Spiers} asked for global linking commands, inspired the link |
10391 | extension system, added support for mairix, and proposed the mapping API. | |
4009494e | 10392 | @item |
96c8522a CD |
10393 | @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content |
10394 | with links transformation to Org syntax. | |
10395 | @item | |
4009494e GM |
10396 | @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual |
10397 | chapter about publishing. | |
10398 | @item | |
10399 | @i{J@"urgen Vollmer} contributed code generating the table of contents | |
10400 | in HTML output. | |
10401 | @item | |
10402 | @i{Chris Wallace} provided a patch implementing the @samp{QUOTE} | |
10403 | keyword. | |
10404 | @item | |
10405 | @i{David Wainberg} suggested archiving, and improvements to the linking | |
10406 | system. | |
10407 | @item | |
b349f79f CD |
10408 | @i{John Wiegley} wrote @file{emacs-wiki.el}, @file{planner.el}, and |
10409 | @file{muse.el}, which have similar goals as Org. Initially the | |
10410 | development of Org was fully independent because I was not aware of the | |
a50253cc | 10411 | existence of these packages. But with time I have occasionally looked |
b349f79f | 10412 | at John's code and learned a lot from it. John has also contributed a |
864c9740 CD |
10413 | number of great ideas and patches directly to Org, including the attachment |
10414 | system (@file{org-attach.el}) and integration with Apple Mail | |
10415 | (@file{org-mac-message.el}). | |
4009494e GM |
10416 | @item |
10417 | @i{Carsten Wimmer} suggested some changes and helped fix a bug in | |
a7808fba | 10418 | linking to Gnus. |
4009494e | 10419 | @item |
a7808fba | 10420 | @i{Roland Winkler} requested additional key bindings to make Org |
4009494e GM |
10421 | work on a tty. |
10422 | @item | |
10423 | @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks | |
10424 | and contributed various ideas and code snippets. | |
10425 | @end itemize | |
10426 | ||
10427 | ||
dbc28aaa CD |
10428 | @node Main Index, Key Index, History and Acknowledgments, Top |
10429 | @unnumbered The Main Index | |
4009494e GM |
10430 | |
10431 | @printindex cp | |
10432 | ||
dbc28aaa | 10433 | @node Key Index, , Main Index, Top |
4009494e GM |
10434 | @unnumbered Key Index |
10435 | ||
10436 | @printindex ky | |
10437 | ||
10438 | @bye | |
10439 | ||
10440 | @ignore | |
a7808fba | 10441 | arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac |
4009494e | 10442 | @end ignore |
a7808fba CD |
10443 | |
10444 | @c Local variables: | |
10445 | @c ispell-local-dictionary: "en_US-w_accents" | |
10446 | @c ispell-local-pdict: "./.aspell.org.pws" | |
10447 | @c fill-column: 77 | |
10448 | @c End: | |
44ce9197 | 10449 |