Mercurial > emacs
annotate doc/misc/org.texi @ 94461:04e8db9393aa
(Sexp Diary Entries): Clarify diary-float.
author | Glenn Morris <rgm@gnu.org> |
---|---|
date | Tue, 29 Apr 2008 03:40:29 +0000 |
parents | e0901c47caf2 |
children | 48d7a33a951c |
rev | line source |
---|---|
84308 | 1 \input texinfo |
2 @c %**start of header | |
84329
3d431f1997d8
(setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents:
84308
diff
changeset
|
3 @setfilename ../../info/org |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4 @settitle The Org Manual |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6 @set VERSION 6.02b |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7 @set DATE April 2008 |
84308 | 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 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
15 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage} |
84308 | 16 @set AUTHOR Carsten Dominik |
17 @set MAINTAINER Carsten Dominik | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
18 @set MAINTAINEREMAIL @email{carsten at orgmode dot org} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
19 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer} |
84308 | 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 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
36 This manual is for Org (version @value{VERSION}). |
84308 | 37 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
38 Copyright @copyright{} 2004, 2005, 2006, 2007, 2008 Free Software Foundation |
84308 | 39 |
40 @quotation | |
41 Permission is granted to copy, distribute and/or modify this document | |
42 under the terms of the GNU Free Documentation License, Version 1.1 or | |
43 any later version published by the Free Software Foundation; with no | |
44 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' | |
45 and with the Back-Cover Texts as in (a) below. A copy of the | |
46 license is included in the section entitled ``GNU Free Documentation | |
47 License.'' | |
48 | |
49 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify | |
50 this GNU Manual, like GNU software. Copies published by the Free | |
51 Software Foundation raise funds for GNU development.'' | |
52 @end quotation | |
53 @end copying | |
54 | |
55 @titlepage | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
56 @title The Org Manual |
84308 | 57 |
58 @subtitle Release @value{VERSION} | |
59 @author by Carsten Dominik | |
60 | |
61 @c The following two commands start the copyright page. | |
62 @page | |
63 @vskip 0pt plus 1filll | |
64 @insertcopying | |
65 @end titlepage | |
66 | |
67 @c Output the table of contents at the beginning. | |
68 @contents | |
69 | |
70 @ifnottex | |
71 @node Top, Introduction, (dir), (dir) | |
72 @top Org Mode Manual | |
73 | |
74 @insertcopying | |
75 @end ifnottex | |
76 | |
77 @menu | |
78 * Introduction:: Getting started | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
79 * Document Structure:: A tree works like your brain |
84308 | 80 * Tables:: Pure magic for quick formatting |
81 * Hyperlinks:: Notes in context | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
82 * TODO Items:: Every tree branch can be a TODO item |
84308 | 83 * Tags:: Tagging headlines and matching sets of tags |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
84 * Properties and Columns:: Storing information about an entry |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
85 * Dates and Times:: Making items useful for planning |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
86 * Remember:: Quickly adding nodes to the outline tree |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
87 * Agenda Views:: Collecting information into views |
84308 | 88 * Embedded LaTeX:: LaTeX fragments and formulas |
89 * Exporting:: Sharing and publishing of notes | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
90 * Publishing:: Create a web site of linked Org files |
84308 | 91 * Miscellaneous:: All the rest which did not fit elsewhere |
92 * Extensions and Hacking:: It is possible to write add-on code | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
93 * History and Acknowledgments:: How Org came into being |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
94 * Main Index:: An index of Org's concepts and features |
84308 | 95 * Key Index:: Key bindings and where they are described |
96 | |
97 @detailmenu | |
98 --- The Detailed Node Listing --- | |
99 | |
100 Introduction | |
101 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
102 * Summary:: Brief summary of what Org does |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
103 * Installation:: How to install a downloaded version of Org |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
104 * Activation:: How to activate Org for certain buffers |
84308 | 105 * Feedback:: Bug reports, ideas, patches etc. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
106 * Conventions:: Type-setting conventions in the manual |
84308 | 107 |
108 Document Structure | |
109 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
110 * Outlines:: Org is based on Outline mode |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
111 * Headlines:: How to typeset Org tree headlines |
84308 | 112 * Visibility cycling:: Show and hide, much simplified |
113 * Motion:: Jumping to other headlines | |
114 * Structure editing:: Changing sequence and level of headlines | |
115 * Archiving:: Move done task trees to a different place | |
116 * Sparse trees:: Matches embedded in context | |
117 * Plain lists:: Additional structure within an entry | |
118 * Drawers:: Tucking stuff away | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
119 * Orgstruct mode:: Structure editing outside Org |
84308 | 120 |
121 Archiving | |
122 | |
123 * ARCHIVE tag:: Marking a tree as inactive | |
124 * Moving subtrees:: Moving a tree to an archive file | |
125 | |
126 Tables | |
127 | |
128 * Built-in table editor:: Simple tables | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
129 * Narrow columns:: Stop wasting space in tables |
84308 | 130 * Column groups:: Grouping to trigger vertical lines |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
131 * Orgtbl mode:: The table editor as minor mode |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
132 * The spreadsheet:: The table editor has spreadsheet capabilities |
84308 | 133 |
134 The spreadsheet | |
135 | |
136 * References:: How to refer to another field or range | |
137 * Formula syntax for Calc:: Using Calc to compute stuff | |
138 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp | |
139 * Field formulas:: Formulas valid for a single field | |
140 * Column formulas:: Formulas valid for an entire column | |
141 * Editing and debugging formulas:: Fixing formulas | |
142 * Updating the table:: Recomputing all dependent fields | |
143 * Advanced features:: Field names, parameters and automatic recalc | |
144 | |
145 Hyperlinks | |
146 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
147 * Link format:: How links in Org are formatted |
84308 | 148 * Internal links:: Links to other places in the current file |
149 * External links:: URL-like links to the world | |
150 * Handling links:: Creating, inserting and following | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
151 * Using links outside Org:: Linking from my C source code? |
84308 | 152 * Link abbreviations:: Shortcuts for writing complex links |
153 * Search options:: Linking to a specific location | |
154 * Custom searches:: When the default search is not enough | |
155 | |
156 Internal links | |
157 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
158 * Radio targets:: Make targets trigger links in plain text |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
159 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
160 TODO Items |
84308 | 161 |
162 * TODO basics:: Marking and displaying TODO entries | |
163 * TODO extensions:: Workflow and assignments | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
164 * Progress logging:: Dates and notes for progress |
84308 | 165 * Priorities:: Some things are more important than others |
166 * Breaking down tasks:: Splitting a task into manageable pieces | |
167 * Checkboxes:: Tick-off lists | |
168 | |
169 Extended use of TODO keywords | |
170 | |
171 * Workflow states:: From TODO to DONE in steps | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
172 * TODO types:: I do this, Fred does the rest |
84308 | 173 * Multiple sets in one file:: Mixing it all, and still finding your way |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
174 * Fast access to TODO states:: Single letter selection of a state |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
175 * Per-file keywords:: Different files, different requirements |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
176 * Faces for TODO keywords:: Highlighting states |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
177 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
178 Progress logging |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
179 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
180 * Closing items:: When was this entry marked DONE? |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
181 * Tracking TODO state changes:: When did the status change? |
84308 | 182 |
183 Tags | |
184 | |
185 * Tag inheritance:: Tags use the tree structure of the outline | |
186 * Setting tags:: How to assign tags to a headline | |
187 * Tag searches:: Searching for combinations of tags | |
188 | |
189 Properties and Columns | |
190 | |
191 * Property syntax:: How properties are spelled out | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
192 * Special properties:: Access to other Org mode features |
84308 | 193 * Property searches:: Matching property values |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
194 * Property inheritance:: Passing values down the tree |
84308 | 195 * Column view:: Tabular viewing and editing |
196 * Property API:: Properties for Lisp programmers | |
197 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
198 Column view |
84308 | 199 |
200 * Defining columns:: The COLUMNS format property | |
201 * Using column view:: How to create and use column view | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
202 * Capturing column view:: A dynamic block for column view |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
203 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
204 Defining columns |
84308 | 205 |
206 * Scope of column definitions:: Where defined, where valid? | |
207 * Column attributes:: Appearance and content of a column | |
208 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
209 Dates and Times |
84308 | 210 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
211 * Timestamps:: Assigning a time to a tree entry |
84308 | 212 * Creating timestamps:: Commands which insert timestamps |
213 * Deadlines and scheduling:: Planning your work | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
214 * Clocking work time:: Tracking how long you spend on a task |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
215 * Effort estimates:: Planning work effort in advance |
84308 | 216 |
217 Creating timestamps | |
218 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
219 * The date/time prompt:: How Org mode helps you entering date and time |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
220 * Custom time format:: Making dates look different |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
221 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
222 Deadlines and scheduling |
84308 | 223 |
224 * Inserting deadline/schedule:: Planning items | |
225 * Repeated tasks:: Items that show up again and again | |
226 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
227 Remember |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
228 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
229 * Setting up Remember:: Some code for .emacs to get things going |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
230 * Remember templates:: Define the outline of different note types |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
231 * Storing notes:: Directly get the note to where it belongs |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
232 * Refiling notes:: Moving a note or task to a project |
84308 | 233 |
234 Agenda Views | |
235 | |
236 * Agenda files:: Files being searched for agenda information | |
237 * Agenda dispatcher:: Keyboard access to agenda views | |
238 * Built-in agenda views:: What is available out of the box? | |
239 * Presentation and sorting:: How agenda items are prepared for display | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
240 * Agenda commands:: Remote editing of Org trees |
84308 | 241 * Custom agenda views:: Defining special searches and views |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
242 * Agenda column view:: Using column view for collected entries |
84308 | 243 |
244 The built-in agenda views | |
245 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
246 * Weekly/daily agenda:: The calendar page with current tasks |
84308 | 247 * Global TODO list:: All unfinished action items |
248 * Matching tags and properties:: Structured information with fine-tuned search | |
249 * Timeline:: Time-sorted view for single file | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
250 * Keyword search:: Finding entries by keyword |
84308 | 251 * Stuck projects:: Find projects you need to review |
252 | |
253 Presentation and sorting | |
254 | |
255 * Categories:: Not all tasks are equal | |
256 * Time-of-day specifications:: How the agenda knows the time | |
257 * Sorting of agenda items:: The order of things | |
258 | |
259 Custom agenda views | |
260 | |
261 * Storing searches:: Type once, use often | |
262 * Block agenda:: All the stuff you need in a single buffer | |
263 * Setting Options:: Changing the rules | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
264 * Exporting Agenda Views:: Writing agendas to files |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
265 * Using the agenda elsewhere:: Using agenda information in other programs |
84308 | 266 |
267 Embedded LaTeX | |
268 | |
269 * Math symbols:: TeX macros for symbols and Greek letters | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
270 * Subscripts and superscripts:: Simple syntax for raising/lowering text |
84308 | 271 * LaTeX fragments:: Complex formulas made easy |
272 * Processing LaTeX fragments:: Previewing LaTeX processing | |
273 * CDLaTeX mode:: Speed up entering of formulas | |
274 | |
275 Exporting | |
276 | |
277 * ASCII export:: Exporting to plain ASCII | |
278 * HTML export:: Exporting to HTML | |
279 * LaTeX export:: Exporting to LaTeX | |
280 * XOXO export:: Exporting to XOXO | |
281 * iCalendar export:: Exporting in iCalendar format | |
282 * Text interpretation:: How the exporter looks at the file | |
283 | |
284 HTML export | |
285 | |
286 * HTML Export commands:: How to invoke LaTeX export | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
287 * Quoting HTML tags:: Using direct HTML in Org mode |
84308 | 288 * Links:: Transformation of links for HTML |
289 * Images:: How to include images | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
290 * CSS support:: Changing the appearance of the output |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
291 * Javascript support:: Info and Folding in a web browser |
84308 | 292 |
293 LaTeX export | |
294 | |
295 * LaTeX export commands:: How to invoke LaTeX export | |
296 * Quoting LaTeX code:: Incorporating literal LaTeX code | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
297 * Sectioning structure:: Changing sectioning in LaTeX output |
84308 | 298 |
299 Text interpretation by the exporter | |
300 | |
301 * Comment lines:: Some lines will not be exported | |
302 * Initial text:: Text before the first headline | |
303 * Footnotes:: Numbers like [1] | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
304 * Quoted examples:: Inserting quoted chunks of text |
84308 | 305 * Enhancing text:: Subscripts, symbols and more |
306 * Export options:: How to influence the export settings | |
307 | |
308 Publishing | |
309 | |
310 * Configuration:: Defining projects | |
311 * Sample configuration:: Example projects | |
312 * Triggering publication:: Publication commands | |
313 | |
314 Configuration | |
315 | |
316 * Project alist:: The central configuration variable | |
317 * Sources and destinations:: From here to there | |
318 * Selecting files:: What files are part of the project? | |
319 * Publishing action:: Setting the function doing the publishing | |
320 * Publishing options:: Tweaking HTML export | |
321 * Publishing links:: Which links keep working after publishing? | |
322 * Project page index:: Publishing a list of project files | |
323 | |
324 Sample configuration | |
325 | |
326 * Simple example:: One-component publishing | |
327 * Complex example:: A multi-component publishing example | |
328 | |
329 Miscellaneous | |
330 | |
331 * Completion:: M-TAB knows what you need | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
332 * Customization:: Adapting Org to your taste |
84308 | 333 * In-buffer settings:: Overview of the #+KEYWORDS |
334 * The very busy C-c C-c key:: When in doubt, press C-c C-c | |
335 * Clean view:: Getting rid of leading stars in the outline | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
336 * TTY keys:: Using Org on a tty |
84308 | 337 * Interaction:: Other Emacs packages |
338 * Bugs:: Things which do not work perfectly | |
339 | |
340 Interaction with other packages | |
341 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
342 * Cooperation:: Packages Org cooperates with |
84308 | 343 * Conflicts:: Packages that lead to conflicts |
344 | |
345 Extensions, Hooks and Hacking | |
346 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
347 * Extensions:: Existing 3rd-party extensions |
84308 | 348 * Adding hyperlink types:: New custom link types |
349 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs | |
350 * Dynamic blocks:: Automatically filled blocks | |
351 * Special agenda views:: Customized views | |
352 * Using the property API:: Writing programs that use entry properties | |
353 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
354 Tables and lists in arbitrary syntax |
84308 | 355 |
356 * Radio tables:: Sending and receiving | |
357 * A LaTeX example:: Step by step, almost a tutorial | |
358 * Translator functions:: Copy and modify | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
359 * Radio lists:: Doing the same for lists |
84308 | 360 |
361 @end detailmenu | |
362 @end menu | |
363 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
364 @node Introduction, Document Structure, Top, Top |
84308 | 365 @chapter Introduction |
366 @cindex introduction | |
367 | |
368 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
369 * Summary:: Brief summary of what Org does |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
370 * Installation:: How to install a downloaded version of Org |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
371 * Activation:: How to activate Org for certain buffers |
84308 | 372 * Feedback:: Bug reports, ideas, patches etc. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
373 * Conventions:: Type-setting conventions in the manual |
84308 | 374 @end menu |
375 | |
376 @node Summary, Installation, Introduction, Introduction | |
377 @section Summary | |
378 @cindex summary | |
379 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
380 Org is a mode for keeping notes, maintaining TODO lists, and doing |
84308 | 381 project planning with a fast and effective plain-text system. |
382 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
383 Org develops organizational tasks around NOTES files that contain |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
384 lists or information about projects as plain text. Org is |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
385 implemented on top of Outline mode, which makes it possible to keep the |
84308 | 386 content of large files well structured. Visibility cycling and |
387 structure editing help to work with the tree. Tables are easily created | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
388 with a built-in table editor. Org supports TODO items, deadlines, |
84308 | 389 time stamps, and scheduling. It dynamically compiles entries into an |
390 agenda that utilizes and smoothly integrates much of the Emacs calendar | |
391 and diary. Plain text URL-like links connect to websites, emails, | |
392 Usenet messages, BBDB entries, and any files related to the projects. | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
393 For printing and sharing of notes, an Org file can be exported as a |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
394 structured ASCII file, as HTML, or (TODO and agenda items only) as an |
84308 | 395 iCalendar file. It can also serve as a publishing tool for a set of |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
396 linked web pages. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
397 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
398 An important design aspect that distinguishes Org from for example |
84308 | 399 Planner/Muse is that it encourages to store every piece of information |
400 only once. In Planner, you have project pages, day pages and possibly | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
401 other files, duplicating some information such as tasks. In Org, |
84308 | 402 you only have notes files. In your notes you mark entries as tasks, |
403 label them with tags and timestamps. All necessary lists like a | |
404 schedule for the day, the agenda for a meeting, tasks lists selected by | |
405 tags etc are created dynamically when you need them. | |
406 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
407 Org keeps simple things simple. When first fired up, it should |
84308 | 408 feel like a straightforward, easy to use outliner. Complexity is not |
409 imposed, but a large amount of functionality is available when you need | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
410 it. Org is a toolbox and can be used in different ways, for |
84308 | 411 example as: |
412 | |
413 @example | |
414 @r{@bullet{} outline extension with visibility cycling and structure editing} | |
415 @r{@bullet{} ASCII system and table editor for taking structured notes} | |
416 @r{@bullet{} ASCII table editor with spreadsheet-like capabilities} | |
417 @r{@bullet{} TODO list editor} | |
418 @r{@bullet{} full agenda and planner with deadlines and work scheduling} | |
419 @r{@bullet{} environment to implement David Allen's GTD system} | |
420 @r{@bullet{} a basic database application} | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
421 @r{@bullet{} simple hypertext system, with HTML and LaTeX export} |
84308 | 422 @r{@bullet{} publishing tool to create a set of interlinked webpages} |
423 @end example | |
424 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
425 Org's automatic, context sensitive table editor with spreadsheet |
84308 | 426 capabilities can be integrated into any major mode by activating the |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
427 minor Orgtbl mode. Using a translation step, it can be used to maintain |
84308 | 428 tables in arbitrary file types, for example in La@TeX{}. The structure |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
429 editing and list creation capabilities can be used outside Org with |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
430 the minor Orgstruct mode. |
84308 | 431 |
432 @cindex FAQ | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
433 There is a website for Org which provides links to the newest |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
434 version of Org, as well as additional information, frequently asked |
84308 | 435 questions (FAQ), links to tutorials etc. This page is located at |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
436 @uref{http://orgmode.org}. |
84308 | 437 |
438 @page | |
439 | |
440 | |
441 @node Installation, Activation, Summary, Introduction | |
442 @section Installation | |
443 @cindex installation | |
444 @cindex XEmacs | |
445 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
446 @b{Important:} @i{If Org is part of the Emacs distribution or an |
84308 | 447 XEmacs package, please skip this section and go directly to |
448 @ref{Activation}.} | |
449 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
450 If you have downloaded Org from the Web, either as a distribution @file{.zip} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
451 or @file{.tar} file, or as a GIT archive, you must take the following steps |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
452 to install it: Go into the unpacked Org distribution directory and edit the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
453 top section of the file @file{Makefile}. You must set the name of the Emacs |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
454 binary (likely either @file{emacs} or @file{xemacs}), and the paths to the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
455 directories where local Lisp and Info files are kept. If you don't have |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
456 access to the system-wide directories, you can simply run Org directly from |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
457 the distribution directory by adding the @file{lisp} subdirectory to the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
458 Emacs load path. To do this, add the following line to @file{.emacs}: |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
459 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
460 @example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
461 (setq load-path (cons "~/path/to/orgdir/lisp" load-path)) |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
462 @end example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
463 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
464 @noindent |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
465 If you plan to use code from the @file{contrib} subdirectory, do a similar |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
466 step for this directory: |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
467 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
468 @example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
469 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path)) |
84308 | 470 @end example |
471 | |
472 @b{XEmacs users now need to install the file @file{noutline.el} from | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
473 the @file{xemacs} sub-directory of the Org distribution. Use the |
84308 | 474 command:} |
475 | |
476 @example | |
477 @b{make install-noutline} | |
478 @end example | |
479 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
480 @noindent Now byte-compile the Lisp files with the shell command: |
84308 | 481 |
482 @example | |
483 make | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
484 @end example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
485 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
486 @noindent If you are running Org from the distribution directory, this is |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
487 all. If you want to install into the system directories, use |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
488 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
489 @example |
84308 | 490 make install |
491 make install-info | |
492 @end example | |
493 | |
494 @noindent Then add to @file{.emacs}: | |
495 | |
496 @lisp | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
497 ;; This line only if Org is not part of the X/Emacs distribution. |
84308 | 498 (require 'org-install) |
499 @end lisp | |
500 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
501 |
84308 | 502 @node Activation, Feedback, Installation, Introduction |
503 @section Activation | |
504 @cindex activation | |
505 @cindex autoload | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
506 @cindex global key bindings |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
507 @cindex key bindings, global |
84308 | 508 |
509 @iftex | |
510 @b{Important:} @i{If you use copy-and-paste to copy lisp code from the | |
511 PDF documentation as viewed by Acrobat reader to your .emacs file, the | |
512 single quote character comes out incorrectly and the code will not work. | |
513 You need to fix the single quotes by hand, or copy from Info | |
514 documentation.} | |
515 @end iftex | |
516 | |
517 Add the following lines to your @file{.emacs} file. The last two lines | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
518 define @emph{global} keys for the commands @command{org-store-link}, |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
519 @command{org-agenda}, and @command{org-iswitchb} - please choose suitable |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
520 keys yourself. |
84308 | 521 |
522 @lisp | |
523 ;; The following lines are always needed. Choose your own keys. | |
524 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode)) | |
525 (global-set-key "\C-cl" 'org-store-link) | |
526 (global-set-key "\C-ca" 'org-agenda) | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
527 (global-set-key "\C-cb" 'org-iswitchb) |
84308 | 528 @end lisp |
529 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
530 Furthermore, you must activate @code{font-lock-mode} in Org |
84308 | 531 buffers, because significant functionality depends on font-locking being |
532 active. You can do this with either one of the following two lines | |
533 (XEmacs user must use the second option): | |
534 @lisp | |
535 (global-font-lock-mode 1) ; for all buffers | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
536 (add-hook 'org-mode-hook 'turn-on-font-lock) ; Org buffers only |
84308 | 537 @end lisp |
538 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
539 @cindex Org mode, turning on |
84308 | 540 With this setup, all files with extension @samp{.org} will be put |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
541 into Org mode. As an alternative, make the first line of a file look |
84308 | 542 like this: |
543 | |
544 @example | |
545 MY PROJECTS -*- mode: org; -*- | |
546 @end example | |
547 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
548 @noindent which will select Org mode for this buffer no matter what |
84308 | 549 the file's name is. See also the variable |
550 @code{org-insert-mode-line-in-empty-file}. | |
551 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
552 @node Feedback, Conventions, Activation, Introduction |
84308 | 553 @section Feedback |
554 @cindex feedback | |
555 @cindex bug reports | |
556 @cindex maintainer | |
557 @cindex author | |
558 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
559 If you find problems with Org, or if you have questions, remarks, |
84308 | 560 or ideas about it, please contact the maintainer @value{MAINTAINER} at |
561 @value{MAINTAINEREMAIL}. | |
562 | |
563 For bug reports, please provide as much information as possible, | |
564 including the version information of Emacs (@kbd{C-h v emacs-version | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
565 @key{RET}}) and Org (@kbd{C-h v org-version @key{RET}}), as well as |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
566 the Org related setup in @file{.emacs}. If an error occurs, a |
84308 | 567 backtrace can be very useful (see below on how to create one). Often a |
568 small example file helps, along with clear information about: | |
569 | |
570 @enumerate | |
571 @item What exactly did you do? | |
572 @item What did you expect to happen? | |
573 @item What happened instead? | |
574 @end enumerate | |
575 @noindent Thank you for helping to improve this mode. | |
576 | |
577 @subsubheading How to create a useful backtrace | |
578 | |
579 @cindex backtrace of an error | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
580 If working with Org produces an error with a message you don't |
84308 | 581 understand, you may have hit a bug. The best way to report this is by |
582 providing, in addition to what was mentioned above, a @emph{Backtrace}. | |
583 This is information from the built-in debugger about where and how the | |
584 error occurred. Here is how to produce a useful backtrace: | |
585 | |
586 @enumerate | |
587 @item | |
588 Start a fresh Emacs or XEmacs, and make sure that it will load the | |
589 original Lisp code in @file{org.el} instead of the compiled version in | |
590 @file{org.elc}. The backtrace contains much more information if it is | |
591 produced with uncompiled code. To do this, either rename @file{org.elc} | |
592 to something else before starting Emacs, or ask Emacs explicitly to load | |
593 @file{org.el} by using the command line | |
594 @example | |
595 emacs -l /path/to/org.el | |
596 @end example | |
597 @item | |
598 Go to the @code{Options} menu and select @code{Enter Debugger on Error} | |
599 (XEmacs has this option in the @code{Troubleshooting} sub-menu). | |
600 @item | |
601 Do whatever you have to do to hit the error. Don't forget to | |
602 document the steps you take. | |
603 @item | |
604 When you hit the error, a @file{*Backtrace*} buffer will appear on the | |
605 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and | |
606 attach it to your bug report. | |
607 @end enumerate | |
608 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
609 @node Conventions, , Feedback, Introduction |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
610 @section Typesetting conventions used in this manual |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
611 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
612 Org uses three types of keywords: TODO keywords, tags, and property |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
613 names. In this manual we use the following conventions: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
614 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
615 @table @code |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
616 @item TODO |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
617 @itemx WAITING |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
618 TODO keywords are written with all capitals, even if they are |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
619 user-defined. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
620 @item boss |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
621 @itemx ARCHIVE |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
622 User-defined tags are written in lowercase; built-in tags with special |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
623 meaning are written with all capitals. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
624 @item Release |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
625 @itemx PRIORITY |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
626 User-defined properties are capitalized; built-in properties with |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
627 special meaning are written with all capitals. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
628 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
629 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
630 @node Document Structure, Tables, Introduction, Top |
84308 | 631 @chapter Document Structure |
632 @cindex document structure | |
633 @cindex structure of document | |
634 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
635 Org is based on outline mode and provides flexible commands to |
84308 | 636 edit the structure of the document. |
637 | |
638 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
639 * Outlines:: Org is based on Outline mode |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
640 * Headlines:: How to typeset Org tree headlines |
84308 | 641 * Visibility cycling:: Show and hide, much simplified |
642 * Motion:: Jumping to other headlines | |
643 * Structure editing:: Changing sequence and level of headlines | |
644 * Archiving:: Move done task trees to a different place | |
645 * Sparse trees:: Matches embedded in context | |
646 * Plain lists:: Additional structure within an entry | |
647 * Drawers:: Tucking stuff away | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
648 * Orgstruct mode:: Structure editing outside Org |
84308 | 649 @end menu |
650 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
651 @node Outlines, Headlines, Document Structure, Document Structure |
84308 | 652 @section Outlines |
653 @cindex outlines | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
654 @cindex Outline mode |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
655 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
656 Org is implemented on top of Outline mode. Outlines allow a |
84308 | 657 document to be organized in a hierarchical structure, which (at least |
658 for me) is the best representation of notes and thoughts. An overview | |
659 of this structure is achieved by folding (hiding) large parts of the | |
660 document to show only the general document structure and the parts | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
661 currently being worked on. Org greatly simplifies the use of |
84308 | 662 outlines by compressing the entire show/hide functionality into a single |
663 command @command{org-cycle}, which is bound to the @key{TAB} key. | |
664 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
665 @node Headlines, Visibility cycling, Outlines, Document Structure |
84308 | 666 @section Headlines |
667 @cindex headlines | |
668 @cindex outline tree | |
669 | |
670 Headlines define the structure of an outline tree. The headlines in | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
671 Org start with one or more stars, on the left margin@footnote{See |
84308 | 672 the variable @code{org-special-ctrl-a/e} to configure special behavior |
673 of @kbd{C-a} and @kbd{C-e} in headlines.}. For example: | |
674 | |
675 @example | |
676 * Top level headline | |
677 ** Second level | |
678 *** 3rd level | |
679 some text | |
680 *** 3rd level | |
681 more text | |
682 | |
683 * Another top level headline | |
684 @end example | |
685 | |
686 @noindent Some people find the many stars too noisy and would prefer an | |
687 outline that has whitespace followed by a single star as headline | |
688 starters. @ref{Clean view} describes a setup to realize this. | |
689 | |
690 An empty line after the end of a subtree is considered part of it and | |
691 will be hidden when the subtree is folded. However, if you leave at | |
692 least two empty lines, one empty line will remain visible after folding | |
693 the subtree, in order to structure the collapsed view. See the | |
694 variable @code{org-cycle-separator-lines} to modify this behavior. | |
695 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
696 @node Visibility cycling, Motion, Headlines, Document Structure |
84308 | 697 @section Visibility cycling |
698 @cindex cycling, visibility | |
699 @cindex visibility cycling | |
700 @cindex trees, visibility | |
701 @cindex show hidden text | |
702 @cindex hide text | |
703 | |
704 Outlines make it possible to hide parts of the text in the buffer. | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
705 Org uses just two commands, bound to @key{TAB} and |
84308 | 706 @kbd{S-@key{TAB}} to change the visibility in the buffer. |
707 | |
708 @cindex subtree visibility states | |
709 @cindex subtree cycling | |
710 @cindex folded, subtree visibility state | |
711 @cindex children, subtree visibility state | |
712 @cindex subtree, subtree visibility state | |
713 @table @kbd | |
714 @kindex @key{TAB} | |
715 @item @key{TAB} | |
716 @emph{Subtree cycling}: Rotate current subtree among the states | |
717 | |
718 @example | |
719 ,-> FOLDED -> CHILDREN -> SUBTREE --. | |
720 '-----------------------------------' | |
721 @end example | |
722 | |
723 The cursor must be on a headline for this to work@footnote{see, however, | |
724 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the | |
725 beginning of the buffer and the first line is not a headline, then | |
726 @key{TAB} actually runs global cycling (see below)@footnote{see the | |
727 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix | |
728 argument (@kbd{C-u @key{TAB}}), global cycling is invoked. | |
729 | |
730 @cindex global visibility states | |
731 @cindex global cycling | |
732 @cindex overview, global visibility state | |
733 @cindex contents, global visibility state | |
734 @cindex show all, global visibility state | |
735 @kindex S-@key{TAB} | |
736 @item S-@key{TAB} | |
737 @itemx C-u @key{TAB} | |
738 @emph{Global cycling}: Rotate the entire buffer among the states | |
739 | |
740 @example | |
741 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --. | |
742 '--------------------------------------' | |
743 @end example | |
744 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
745 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
746 CONTENTS view up to headlines of level N will be shown. Note that inside |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
747 tables, @kbd{S-@key{TAB}} jumps to the previous field. |
84308 | 748 |
749 @cindex show all, command | |
750 @kindex C-c C-a | |
751 @item C-c C-a | |
752 Show all. | |
753 @kindex C-c C-r | |
754 @item C-c C-r | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
755 Reveal context around point, showing the current entry, the following heading |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
756 and the hierarchy above. Useful for working near a location that has been |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
757 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
758 (@pxref{Agenda commands}). With a prefix argument show, on each |
84308 | 759 level, all sibling headings. |
760 @kindex C-c C-x b | |
761 @item C-c C-x b | |
762 Show the current subtree in an indirect buffer@footnote{The indirect | |
763 buffer | |
764 @ifinfo | |
765 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual}) | |
766 @end ifinfo | |
767 @ifnotinfo | |
768 (see the Emacs manual for more information about indirect buffers) | |
769 @end ifnotinfo | |
770 will contain the entire buffer, but will be narrowed to the current | |
771 tree. Editing the indirect buffer will also change the original buffer, | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
772 but without affecting visibility in that buffer.}. With a numeric |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
773 prefix argument N, go up to level N and then take that tree. If N is |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
774 negative then go up that many levels. With a @kbd{C-u} prefix, do not remove |
84308 | 775 the previously used indirect buffer. |
776 @end table | |
777 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
778 When Emacs first visits an Org file, the global state is set to |
84308 | 779 OVERVIEW, i.e. only the top level headlines are visible. This can be |
780 configured through the variable @code{org-startup-folded}, or on a | |
781 per-file basis by adding one of the following lines anywhere in the | |
782 buffer: | |
783 | |
784 @example | |
785 #+STARTUP: overview | |
786 #+STARTUP: content | |
787 #+STARTUP: showall | |
788 @end example | |
789 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
790 @node Motion, Structure editing, Visibility cycling, Document Structure |
84308 | 791 @section Motion |
792 @cindex motion, between headlines | |
793 @cindex jumping, to headlines | |
794 @cindex headline navigation | |
795 The following commands jump to other headlines in the buffer. | |
796 | |
797 @table @kbd | |
798 @kindex C-c C-n | |
799 @item C-c C-n | |
800 Next heading. | |
801 @kindex C-c C-p | |
802 @item C-c C-p | |
803 Previous heading. | |
804 @kindex C-c C-f | |
805 @item C-c C-f | |
806 Next heading same level. | |
807 @kindex C-c C-b | |
808 @item C-c C-b | |
809 Previous heading same level. | |
810 @kindex C-c C-u | |
811 @item C-c C-u | |
812 Backward to higher level heading. | |
813 @kindex C-c C-j | |
814 @item C-c C-j | |
815 Jump to a different place without changing the current outline | |
816 visibility. Shows the document structure in a temporary buffer, where | |
817 you can use the following keys to find your destination: | |
818 @example | |
819 @key{TAB} @r{Cycle visibility.} | |
820 @key{down} / @key{up} @r{Next/previous visible headline.} | |
821 n / p @r{Next/previous visible headline.} | |
822 f / b @r{Next/previous headline same level.} | |
823 u @r{One level up.} | |
824 0-9 @r{Digit argument.} | |
825 @key{RET} @r{Select this location.} | |
826 @end example | |
827 @end table | |
828 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
829 @node Structure editing, Archiving, Motion, Document Structure |
84308 | 830 @section Structure editing |
831 @cindex structure editing | |
832 @cindex headline, promotion and demotion | |
833 @cindex promotion, of subtrees | |
834 @cindex demotion, of subtrees | |
835 @cindex subtree, cut and paste | |
836 @cindex pasting, of subtrees | |
837 @cindex cutting, of subtrees | |
838 @cindex copying, of subtrees | |
839 @cindex subtrees, cut and paste | |
840 | |
841 @table @kbd | |
842 @kindex M-@key{RET} | |
843 @item M-@key{RET} | |
844 Insert new heading with same level as current. If the cursor is in a | |
845 plain list item, a new item is created (@pxref{Plain lists}). To force | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
846 creation of a new headline, use a prefix argument, or first press @key{RET} |
84308 | 847 to get to the beginning of the next line. When this command is used in |
848 the middle of a line, the line is split and the rest of the line becomes | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
849 the new headline@footnote{If you do not want the line to be split, |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
850 customize the variable @code{org-M-RET-may-split-line}.}. If the |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
851 command is used at the beginning of a headline, the new headline is |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
852 created before the current line. If at the beginning of any other line, |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
853 the content of that line is made the new heading. If the command is |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
854 used at the end of a folded subtree (i.e. behind the ellipses at the end |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
855 of a headline), then a headline like the current one will be inserted |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
856 after the end of the subtree. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
857 @kindex C-@key{RET} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
858 @item C-@key{RET} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
859 Insert a new heading after the current subtree, same level as the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
860 current headline. This command works from anywhere in the entry. |
84308 | 861 @kindex M-S-@key{RET} |
862 @item M-S-@key{RET} | |
863 Insert new TODO entry with same level as current heading. | |
864 @kindex M-@key{left} | |
865 @item M-@key{left} | |
866 Promote current heading by one level. | |
867 @kindex M-@key{right} | |
868 @item M-@key{right} | |
869 Demote current heading by one level. | |
870 @kindex M-S-@key{left} | |
871 @item M-S-@key{left} | |
872 Promote the current subtree by one level. | |
873 @kindex M-S-@key{right} | |
874 @item M-S-@key{right} | |
875 Demote the current subtree by one level. | |
876 @kindex M-S-@key{up} | |
877 @item M-S-@key{up} | |
878 Move subtree up (swap with previous subtree of same | |
879 level). | |
880 @kindex M-S-@key{down} | |
881 @item M-S-@key{down} | |
882 Move subtree down (swap with next subtree of same level). | |
883 @kindex C-c C-x C-w | |
884 @kindex C-c C-x C-k | |
885 @item C-c C-x C-w | |
886 @itemx C-c C-x C-k | |
887 Kill subtree, i.e. remove it from buffer but save in kill ring. | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
888 With a numeric prefix argument N, kill N sequential subtrees. |
84308 | 889 @kindex C-c C-x M-w |
890 @item C-c C-x M-w | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
891 Copy subtree to kill ring. With a numeric prefix argument N, copy the N |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
892 sequential subtrees. |
84308 | 893 @kindex C-c C-x C-y |
894 @item C-c C-x C-y | |
895 Yank subtree from kill ring. This does modify the level of the subtree to | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
896 make sure the tree fits in nicely at the yank position. The yank level can |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
897 also be specified with a numeric prefix argument, or by yanking after a |
84308 | 898 headline marker like @samp{****}. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
899 @kindex C-c C-w |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
900 @item C-c C-w |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
901 Refile entry to a different location. @xref{Refiling notes}. |
84308 | 902 @kindex C-c ^ |
903 @item C-c ^ | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
904 Sort same-level entries. When there is an active region, all entries in the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
905 region will be sorted. Otherwise the children of the current headline are |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
906 sorted. The command prompts for the sorting method, which can be |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
907 alphabetically, numerically, by time (using the first time stamp in each |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
908 entry), by priority, or by TODO keyword (in the sequence the keywords have |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
909 been defined in the setup). Reverse sorting is possible as well. You can |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
910 also supply your own function to extract the sorting key. With a @kbd{C-u} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
911 prefix, sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes, |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
912 duplicate entries will also be removed. |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
913 @kindex C-c * |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
914 @item C-c * |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
915 Turn a normal line or plain list item into a headline (so that it |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
916 becomes a subheading at its location). Also turn a headline into a |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
917 normal line by removing the stars. If there is an active region, turn |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
918 all lines in the region into headlines. Or, if the first line is a |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
919 headline, remove the stars from all headlines in the region. |
84308 | 920 @end table |
921 | |
922 @cindex region, active | |
923 @cindex active region | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
924 @cindex Transient mark mode |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
925 When there is an active region (Transient mark mode), promotion and |
84308 | 926 demotion work on all headlines in the region. To select a region of |
927 headlines, it is best to place both point and mark at the beginning of a | |
928 line, mark at the beginning of the first headline, and point at the line | |
929 just after the last headline to change. Note that when the cursor is | |
930 inside a table (@pxref{Tables}), the Meta-Cursor keys have different | |
931 functionality. | |
932 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
933 @node Archiving, Sparse trees, Structure editing, Document Structure |
84308 | 934 @section Archiving |
935 @cindex archiving | |
936 | |
937 When a project represented by a (sub)tree is finished, you may want | |
938 to move the tree out of the way and to stop it from contributing to the | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
939 agenda. Org mode knows two ways of archiving. You can mark a tree with |
84308 | 940 the ARCHIVE tag, or you can move an entire (sub)tree to a different |
941 location. | |
942 | |
943 @menu | |
944 * ARCHIVE tag:: Marking a tree as inactive | |
945 * Moving subtrees:: Moving a tree to an archive file | |
946 @end menu | |
947 | |
948 @node ARCHIVE tag, Moving subtrees, Archiving, Archiving | |
949 @subsection The ARCHIVE tag | |
950 @cindex internal archiving | |
951 | |
952 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at | |
953 its location in the outline tree, but behaves in the following way: | |
954 @itemize @minus | |
955 @item | |
956 It does not open when you attempt to do so with a visibility cycling | |
957 command (@pxref{Visibility cycling}). You can force cycling archived | |
958 subtrees with @kbd{C-@key{TAB}}, or by setting the option | |
959 @code{org-cycle-open-archived-trees}. Also normal outline commands like | |
960 @code{show-all} will open archived subtrees. | |
961 @item | |
962 During sparse tree construction (@pxref{Sparse trees}), matches in | |
963 archived subtrees are not exposed, unless you configure the option | |
964 @code{org-sparse-tree-open-archived-trees}. | |
965 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
966 During agenda view construction (@pxref{Agenda Views}), the content of |
84308 | 967 archived trees is ignored unless you configure the option |
968 @code{org-agenda-skip-archived-trees}. | |
969 @item | |
970 Archived trees are not exported (@pxref{Exporting}), only the headline | |
971 is. Configure the details using the variable | |
972 @code{org-export-with-archived-trees}. | |
973 @end itemize | |
974 | |
975 The following commands help managing the ARCHIVE tag: | |
976 | |
977 @table @kbd | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
978 @kindex C-c C-x a |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
979 @item C-c C-x a |
84308 | 980 Toggle the ARCHIVE tag for the current headline. When the tag is set, |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
981 the headline changes to a shadowed face, and the subtree below it is |
84308 | 982 hidden. |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
983 @kindex C-u C-c C-x a |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
984 @item C-u C-c C-x a |
84308 | 985 Check if any direct children of the current headline should be archived. |
986 To do this, each subtree is checked for open TODO entries. If none are | |
987 found, the command offers to set the ARCHIVE tag for the child. If the | |
988 cursor is @emph{not} on a headline when this command is invoked, the | |
989 level 1 trees will be checked. | |
990 @kindex C-@kbd{TAB} | |
991 @item C-@kbd{TAB} | |
992 Cycle a tree even if it is tagged with ARCHIVE. | |
993 @end table | |
994 | |
995 @node Moving subtrees, , ARCHIVE tag, Archiving | |
996 @subsection Moving subtrees | |
997 @cindex external archiving | |
998 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
999 Once an entire project is finished, you may want to move it to a different |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1000 location. Org can move it to an @emph{Attic Sibling} in the same tree, to a |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1001 different tree in the current file, or to a different file, the archive file. |
84308 | 1002 |
1003 @table @kbd | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1004 @kindex C-c C-x A |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1005 @item C-c C-x A |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1006 Move the curent entry to the @emph{Attic Sibling}. This is a sibling of the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1007 entry with the heading @samp{Attic} and the tag @samp{ARCHIVE} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1008 (@pxref{ARCHIVE tag}). The entry becomes a child of that sibling and in this |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1009 way retains a lot of its original context, including inherited tags and |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1010 approximate position in the outline. |
84308 | 1011 @kindex C-c C-x C-s |
1012 @item C-c C-x C-s | |
1013 Archive the subtree starting at the cursor position to the location | |
1014 given by @code{org-archive-location}. Context information that could be | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1015 lost like the file name, the category, inherited tags, and the TODO |
84308 | 1016 state will be store as properties in the entry. |
1017 @kindex C-u C-c C-x C-s | |
1018 @item C-u C-c C-x C-s | |
1019 Check if any direct children of the current headline could be moved to | |
1020 the archive. To do this, each subtree is checked for open TODO entries. | |
1021 If none are found, the command offers to move it to the archive | |
1022 location. If the cursor is @emph{not} on a headline when this command | |
1023 is invoked, the level 1 trees will be checked. | |
1024 @end table | |
1025 | |
1026 @cindex archive locations | |
1027 The default archive location is a file in the same directory as the | |
1028 current file, with the name derived by appending @file{_archive} to the | |
1029 current file name. For information and examples on how to change this, | |
1030 see the documentation string of the variable | |
1031 @code{org-archive-location}. There is also an in-buffer option for | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1032 setting this variable, for example@footnote{For backward compatibility, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1033 the following also works: If there are several such lines in a file, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1034 each specifies the archive location for the text below it. The first |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1035 such line also applies to any text before its definition. However, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1036 using this method is @emph{strongly} deprecated as it is incompatible |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1037 with the outline structure of the document. The correct method for |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1038 setting multiple archive locations in a buffer is using a property.}: |
84308 | 1039 |
1040 @example | |
1041 #+ARCHIVE: %s_done:: | |
1042 @end example | |
1043 | |
1044 @noindent | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1045 If you would like to have a special ARCHIVE location for a single entry |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1046 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1047 location as the value (@pxref{Properties and Columns}). |
84308 | 1048 |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
1049 When a subtree is moved, it receives a number of special properties that |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
1050 record context information like the file from where the entry came, it's |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
1051 outline path the archiving time etc. Configure the variable |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
1052 @code{org-archive-save-context-info} to adjust the amount of information |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
1053 added. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
1054 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1055 @node Sparse trees, Plain lists, Archiving, Document Structure |
84308 | 1056 @section Sparse trees |
1057 @cindex sparse trees | |
1058 @cindex trees, sparse | |
1059 @cindex folding, sparse trees | |
1060 @cindex occur, command | |
1061 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1062 An important feature of Org mode is the ability to construct |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1063 @emph{sparse trees} for selected information in an outline tree, so that |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1064 the entire document is folded as much as possible, but the selected |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1065 information is made visible along with the headline structure above |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1066 it@footnote{See also the variables @code{org-show-hierarchy-above}, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1067 @code{org-show-following-heading}, and @code{org-show-siblings} for |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1068 detailed control on how much context is shown around each match.}. Just |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1069 try it out and you will see immediately how it works. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1070 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1071 Org mode contains several commands creating such trees, all these |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1072 commands can be accessed through a dispatcher: |
84308 | 1073 |
1074 @table @kbd | |
1075 @kindex C-c / | |
1076 @item C-c / | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1077 This prompts for an extra key to select a sparse-tree creating command. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1078 @kindex C-c / r |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1079 @item C-c / r |
84308 | 1080 Occur. Prompts for a regexp and shows a sparse tree with all matches. |
1081 If the match is in a headline, the headline is made visible. If the | |
1082 match is in the body of an entry, headline and body are made visible. | |
1083 In order to provide minimal context, also the full hierarchy of | |
1084 headlines above the match is shown, as well as the headline following | |
1085 the match. Each match is also highlighted; the highlights disappear | |
1086 when the buffer is changed by an editing command, or by pressing | |
1087 @kbd{C-c C-c}. When called with a @kbd{C-u} prefix argument, previous | |
1088 highlights are kept, so several calls to this command can be stacked. | |
1089 @end table | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1090 |
84308 | 1091 @noindent |
1092 For frequently used sparse trees of specific search strings, you can | |
1093 use the variable @code{org-agenda-custom-commands} to define fast | |
1094 keyboard access to specific sparse trees. These commands will then be | |
1095 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}). | |
1096 For example: | |
1097 | |
1098 @lisp | |
1099 (setq org-agenda-custom-commands | |
1100 '(("f" occur-tree "FIXME"))) | |
1101 @end lisp | |
1102 | |
1103 @noindent will define the key @kbd{C-c a f} as a shortcut for creating | |
1104 a sparse tree matching the string @samp{FIXME}. | |
1105 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1106 The other sparse tree commands select headings based on TODO keywords, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1107 tags, or properties and will be discussed later in this manual. |
84308 | 1108 |
1109 @kindex C-c C-e v | |
1110 @cindex printing sparse trees | |
1111 @cindex visible text, printing | |
1112 To print a sparse tree, you can use the Emacs command | |
1113 @code{ps-print-buffer-with-faces} which does not print invisible parts | |
1114 of the document @footnote{This does not work under XEmacs, because | |
1115 XEmacs uses selective display for outlining, not text properties.}. | |
1116 Or you can use the command @kbd{C-c C-e v} to export only the visible | |
1117 part of the document and print the resulting file. | |
1118 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1119 @node Plain lists, Drawers, Sparse trees, Document Structure |
84308 | 1120 @section Plain lists |
1121 @cindex plain lists | |
1122 @cindex lists, plain | |
1123 @cindex lists, ordered | |
1124 @cindex ordered lists | |
1125 | |
1126 Within an entry of the outline tree, hand-formatted lists can provide | |
1127 additional structure. They also provide a way to create lists of | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1128 checkboxes (@pxref{Checkboxes}). Org supports editing such lists, |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1129 and the HTML exporter (@pxref{Exporting}) parses and formats them. |
84308 | 1130 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1131 Org knows ordered and unordered lists. Unordered list items start |
84308 | 1132 with @samp{-}, @samp{+}, or @samp{*}@footnote{When using @samp{*} as a |
1133 bullet, lines must be indented or they will be seen as top-level | |
1134 headlines. Also, when you are hiding leading stars to get a clean | |
1135 outline view, plain list items starting with a star are visually | |
1136 indistinguishable from true headlines. In short: even though @samp{*} | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1137 is supported, it may be better to not use it for plain list items.} as |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1138 bullets. Ordered list items start with a numeral followed by either a |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1139 period or a right parenthesis, such as @samp{1.} or @samp{1)}. Items |
84308 | 1140 belonging to the same list must have the same indentation on the first |
1141 line. In particular, if an ordered list reaches number @samp{10.}, then | |
1142 the 2--digit numbers must be written left-aligned with the other numbers | |
1143 in the list. Indentation also determines the end of a list item. It | |
1144 ends before the next line that is indented like the bullet/number, or | |
1145 less. Empty lines are part of the previous item, so you can have | |
1146 several paragraphs in one item. If you would like an empty line to | |
1147 terminate all currently open plain lists, configure the variable | |
1148 @code{org-empty-line-terminates-plain-lists}. Here is an example: | |
1149 | |
1150 @example | |
1151 @group | |
1152 ** Lord of the Rings | |
1153 My favorite scenes are (in this order) | |
1154 1. The attack of the Rohirrim | |
1155 2. Eowyns fight with the witch king | |
1156 + this was already my favorite scene in the book | |
1157 + I really like Miranda Otto. | |
1158 3. Peter Jackson being shot by Legolas | |
1159 - on DVD only | |
1160 He makes a really funny face when it happens. | |
1161 But in the end, not individual scenes matter but the film as a whole. | |
1162 @end group | |
1163 @end example | |
1164 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1165 Org supports these lists by tuning filling and wrapping commands to |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1166 deal with them correctly@footnote{Org only changes the filling |
84308 | 1167 settings for Emacs. For XEmacs, you should use Kyle E. Jones' |
1168 @file{filladapt.el}. To turn this on, put into @file{.emacs}: | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
1169 @code{(require 'filladapt)}}. |
84308 | 1170 |
1171 The following commands act on items when the cursor is in the first line | |
1172 of an item (the line with the bullet or number). | |
1173 | |
1174 @table @kbd | |
1175 @kindex @key{TAB} | |
1176 @item @key{TAB} | |
1177 Items can be folded just like headline levels if you set the variable | |
1178 @code{org-cycle-include-plain-lists}. The level of an item is then | |
1179 given by the indentation of the bullet/number. Items are always | |
1180 subordinate to real headlines, however; the hierarchies remain | |
1181 completely separated. | |
1182 | |
1183 If @code{org-cycle-include-plain-lists} has not been set, @key{TAB} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1184 fixes the indentation of the current line in a heuristic way. |
84308 | 1185 @kindex M-@key{RET} |
1186 @item M-@key{RET} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1187 Insert new item at current level. With a prefix argument, force a new |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1188 heading (@pxref{Structure editing}). If this command is used in the middle |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1189 of a line, the line is @emph{split} and the rest of the line becomes the new |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1190 item@footnote{If you do not want the line to be split, customize the variable |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1191 @code{org-M-RET-may-split-line}.}. If this command is executed in the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1192 @emph{whitespace before a bullet or number}, the new item is created |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1193 @emph{before} the current item. If the command is executed in the white |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1194 space before the text that is part of an item but does not contain the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1195 bullet, a bullet is added to the current line. |
84308 | 1196 @kindex M-S-@key{RET} |
1197 @item M-S-@key{RET} | |
1198 Insert a new item with a checkbox (@pxref{Checkboxes}). | |
1199 @kindex S-@key{up} | |
1200 @kindex S-@key{down} | |
1201 @item S-@key{up} | |
1202 @itemx S-@key{down} | |
1203 Jump to the previous/next item in the current list. | |
1204 @kindex M-S-@key{up} | |
1205 @kindex M-S-@key{down} | |
1206 @item M-S-@key{up} | |
1207 @itemx M-S-@key{down} | |
1208 Move the item including subitems up/down (swap with previous/next item | |
1209 of same indentation). If the list is ordered, renumbering is | |
1210 automatic. | |
1211 @kindex M-S-@key{left} | |
1212 @kindex M-S-@key{right} | |
1213 @item M-S-@key{left} | |
1214 @itemx M-S-@key{right} | |
1215 Decrease/increase the indentation of the item, including subitems. | |
1216 Initially, the item tree is selected based on current indentation. | |
1217 When these commands are executed several times in direct succession, | |
1218 the initially selected region is used, even if the new indentation | |
1219 would imply a different hierarchy. To use the new hierarchy, break | |
1220 the command chain with a cursor motion or so. | |
1221 @kindex C-c C-c | |
1222 @item C-c C-c | |
1223 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1224 state of the checkbox. If not, this command makes sure that all the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1225 items on this list level use the same bullet. Furthermore, if this is |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1226 an ordered list, make sure the numbering is OK. |
84308 | 1227 @kindex C-c - |
1228 @item C-c - | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1229 Cycle the entire list level through the different itemize/enumerate bullets |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1230 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}). With a numeric prefix |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1231 argument N, select the Nth bullet from this list. If there is an active |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1232 region when calling this, all lines will be converted to list items. If the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1233 first line already was a list item, any item markers will be removed from the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1234 list. Finally, even without an active region, a normal line will be |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1235 converted into a list item. |
84308 | 1236 @end table |
1237 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1238 @node Drawers, Orgstruct mode, Plain lists, Document Structure |
84308 | 1239 @section Drawers |
1240 @cindex drawers | |
1241 @cindex visibility cycling, drawers | |
1242 | |
1243 Sometimes you want to keep information associated with an entry, but you | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1244 normally don't want to see it. For this, Org mode has @emph{drawers}. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1245 Drawers need to be configured with the variable |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1246 @code{org-drawers}@footnote{You can define drawers on a per-file basis |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1247 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers |
84308 | 1248 look like this: |
1249 | |
1250 @example | |
1251 ** This is a headline | |
1252 Still outside the drawer | |
1253 :DRAWERNAME: | |
1254 This is inside the drawer. | |
1255 :END: | |
1256 After the drawer. | |
1257 @end example | |
1258 | |
1259 Visibility cycling (@pxref{Visibility cycling}) on the headline will | |
1260 hide and show the entry, but keep the drawer collapsed to a single line. | |
1261 In order to look inside the drawer, you need to move the cursor to the | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1262 drawer line and press @key{TAB} there. Org mode uses a drawer for |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1263 storing properties (@pxref{Properties and Columns}). |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1264 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1265 @node Orgstruct mode, , Drawers, Document Structure |
84308 | 1266 @section The Orgstruct minor mode |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1267 @cindex Orgstruct mode |
84308 | 1268 @cindex minor mode for structure editing |
1269 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1270 If you like the intuitive way the Org mode structure editing and list |
84308 | 1271 formatting works, you might want to use these commands in other modes |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1272 like Text mode or Mail mode as well. The minor mode Orgstruct mode |
84308 | 1273 makes this possible. You can always toggle the mode with @kbd{M-x |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1274 orgstruct-mode}. To turn it on by default, for example in Mail mode, |
84308 | 1275 use |
1276 | |
1277 @lisp | |
1278 (add-hook 'mail-mode-hook 'turn-on-orgstruct) | |
1279 @end lisp | |
1280 | |
1281 When this mode is active and the cursor is on a line that looks to | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1282 Org like a headline of the first line of a list item, most |
84308 | 1283 structure editing commands will work, even if the same keys normally |
1284 have different functionality in the major mode you are using. If the | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1285 cursor is not in one of those special lines, Orgstruct mode lurks |
84308 | 1286 silently in the shadow. |
1287 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1288 @node Tables, Hyperlinks, Document Structure, Top |
84308 | 1289 @chapter Tables |
1290 @cindex tables | |
1291 @cindex editing tables | |
1292 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1293 Org comes with a fast and intuitive table editor. Spreadsheet-like |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1294 calculations are supported in connection with the Emacs @file{calc} |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
1295 package |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1296 @ifinfo |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1297 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}). |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1298 @end ifinfo |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1299 @ifnotinfo |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1300 (see the Emacs Calculator manual for more information about the Emacs |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1301 calculator). |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1302 @end ifnotinfo |
84308 | 1303 |
1304 @menu | |
1305 * Built-in table editor:: Simple tables | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
1306 * Narrow columns:: Stop wasting space in tables |
84308 | 1307 * Column groups:: Grouping to trigger vertical lines |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1308 * Orgtbl mode:: The table editor as minor mode |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1309 * The spreadsheet:: The table editor has spreadsheet capabilities |
84308 | 1310 @end menu |
1311 | |
1312 @node Built-in table editor, Narrow columns, Tables, Tables | |
1313 @section The built-in table editor | |
1314 @cindex table editor, built-in | |
1315 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1316 Org makes it easy to format tables in plain ASCII. Any line with |
84308 | 1317 @samp{|} as the first non-whitespace character is considered part of a |
1318 table. @samp{|} is also the column separator. A table might look like | |
1319 this: | |
1320 | |
1321 @example | |
1322 | Name | Phone | Age | | |
1323 |-------+-------+-----| | |
1324 | Peter | 1234 | 17 | | |
1325 | Anna | 4321 | 25 | | |
1326 @end example | |
1327 | |
1328 A table is re-aligned automatically each time you press @key{TAB} or | |
1329 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to | |
1330 the next field (@key{RET} to the next row) and creates new table rows | |
1331 at the end of the table or before horizontal lines. The indentation | |
1332 of the table is set by the first line. Any line starting with | |
1333 @samp{|-} is considered as a horizontal separator line and will be | |
1334 expanded on the next re-align to span the whole table width. So, to | |
1335 create the above table, you would only type | |
1336 | |
1337 @example | |
1338 |Name|Phone|Age| | |
1339 |- | |
1340 @end example | |
1341 | |
1342 @noindent and then press @key{TAB} to align the table and start filling in | |
1343 fields. | |
1344 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1345 When typing text into a field, Org treats @key{DEL}, |
84308 | 1346 @key{Backspace}, and all character keys in a special way, so that |
1347 inserting and deleting avoids shifting other fields. Also, when | |
1348 typing @emph{immediately after the cursor was moved into a new field | |
1349 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the | |
1350 field is automatically made blank. If this behavior is too | |
1351 unpredictable for you, configure the variables | |
1352 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}. | |
1353 | |
1354 @table @kbd | |
1355 @tsubheading{Creation and conversion} | |
1356 @kindex C-c | | |
1357 @item C-c | | |
1358 Convert the active region to table. If every line contains at least one | |
1359 TAB character, the function assumes that the material is tab separated. | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1360 If every line contains a comma, comma-separated values (CSV) are assumed. |
84308 | 1361 If not, lines are split at whitespace into fields. You can use a prefix |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1362 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1363 C-u} forces TAB, and a numeric argument N indicates that at least N |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1364 consecutive spaces, or alternatively a TAB will be the separator. |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
1365 @* |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1366 If there is no active region, this command creates an empty Org |
84308 | 1367 table. But it's easier just to start typing, like |
1368 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}. | |
1369 | |
1370 @tsubheading{Re-aligning and field motion} | |
1371 @kindex C-c C-c | |
1372 @item C-c C-c | |
1373 Re-align the table without moving the cursor. | |
1374 @c | |
1375 @kindex @key{TAB} | |
1376 @item @key{TAB} | |
1377 Re-align the table, move to the next field. Creates a new row if | |
1378 necessary. | |
1379 @c | |
1380 @kindex S-@key{TAB} | |
1381 @item S-@key{TAB} | |
1382 Re-align, move to previous field. | |
1383 @c | |
1384 @kindex @key{RET} | |
1385 @item @key{RET} | |
1386 Re-align the table and move down to next row. Creates a new row if | |
1387 necessary. At the beginning or end of a line, @key{RET} still does | |
1388 NEWLINE, so it can be used to split a table. | |
1389 | |
1390 @tsubheading{Column and row editing} | |
1391 @kindex M-@key{left} | |
1392 @kindex M-@key{right} | |
1393 @item M-@key{left} | |
1394 @itemx M-@key{right} | |
1395 Move the current column left/right. | |
1396 @c | |
1397 @kindex M-S-@key{left} | |
1398 @item M-S-@key{left} | |
1399 Kill the current column. | |
1400 @c | |
1401 @kindex M-S-@key{right} | |
1402 @item M-S-@key{right} | |
1403 Insert a new column to the left of the cursor position. | |
1404 @c | |
1405 @kindex M-@key{up} | |
1406 @kindex M-@key{down} | |
1407 @item M-@key{up} | |
1408 @itemx M-@key{down} | |
1409 Move the current row up/down. | |
1410 @c | |
1411 @kindex M-S-@key{up} | |
1412 @item M-S-@key{up} | |
1413 Kill the current row or horizontal line. | |
1414 @c | |
1415 @kindex M-S-@key{down} | |
1416 @item M-S-@key{down} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1417 Insert a new row above the current row. With a prefix argument, the line is |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1418 created below the current one. |
84308 | 1419 @c |
1420 @kindex C-c - | |
1421 @item C-c - | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1422 Insert a horizontal line below current row. With a prefix argument, the line |
84308 | 1423 is created above the current line. |
1424 @c | |
1425 @kindex C-c ^ | |
1426 @item C-c ^ | |
1427 Sort the table lines in the region. The position of point indicates the | |
1428 column to be used for sorting, and the range of lines is the range | |
1429 between the nearest horizontal separator lines, or the entire table. If | |
1430 point is before the first column, you will be prompted for the sorting | |
1431 column. If there is an active region, the mark specifies the first line | |
1432 and the sorting column, while point should be in the last line to be | |
1433 included into the sorting. The command prompts for the sorting type | |
1434 (alphabetically, numerically, or by time). When called with a prefix | |
1435 argument, alphabetic sorting will be case-sensitive. | |
1436 | |
1437 @tsubheading{Regions} | |
1438 @kindex C-c C-x M-w | |
1439 @item C-c C-x M-w | |
1440 Copy a rectangular region from a table to a special clipboard. Point | |
1441 and mark determine edge fields of the rectangle. The process ignores | |
1442 horizontal separator lines. | |
1443 @c | |
1444 @kindex C-c C-x C-w | |
1445 @item C-c C-x C-w | |
1446 Copy a rectangular region from a table to a special clipboard, and | |
1447 blank all fields in the rectangle. So this is the ``cut'' operation. | |
1448 @c | |
1449 @kindex C-c C-x C-y | |
1450 @item C-c C-x C-y | |
1451 Paste a rectangular region into a table. | |
1452 The upper right corner ends up in the current field. All involved fields | |
1453 will be overwritten. If the rectangle does not fit into the present table, | |
1454 the table is enlarged as needed. The process ignores horizontal separator | |
1455 lines. | |
1456 @c | |
1457 @kindex C-c C-q | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
1458 @kindex M-@key{RET} |
84308 | 1459 @item C-c C-q |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
1460 @itemx M-@kbd{RET} |
84308 | 1461 Wrap several fields in a column like a paragraph. If there is an active |
1462 region, and both point and mark are in the same column, the text in the | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1463 column is wrapped to minimum width for the given number of lines. A numeric |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1464 prefix argument may be used to change the number of desired lines. If there |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1465 is no region, the current field is split at the cursor position and the text |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1466 fragment to the right of the cursor is prepended to the field one line |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1467 down. If there is no region, but you specify a prefix argument, the current |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1468 field is made blank, and the content is appended to the field above. |
84308 | 1469 |
1470 @tsubheading{Calculations} | |
1471 @cindex formula, in tables | |
1472 @cindex calculations, in tables | |
1473 @cindex region, active | |
1474 @cindex active region | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1475 @cindex Transient mark mode |
84308 | 1476 @kindex C-c + |
1477 @item C-c + | |
1478 Sum the numbers in the current column, or in the rectangle defined by | |
1479 the active region. The result is shown in the echo area and can | |
1480 be inserted with @kbd{C-y}. | |
1481 @c | |
1482 @kindex S-@key{RET} | |
1483 @item S-@key{RET} | |
1484 When current field is empty, copy from first non-empty field above. | |
1485 When not empty, copy current field down to next row and move cursor | |
1486 along with it. Depending on the variable | |
1487 @code{org-table-copy-increment}, integer field values will be | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1488 incremented during copy. This key is also used by CUA mode |
84308 | 1489 (@pxref{Cooperation}). |
1490 | |
1491 @tsubheading{Miscellaneous} | |
1492 @kindex C-c ` | |
1493 @item C-c ` | |
1494 Edit the current field in a separate window. This is useful for fields | |
1495 that are not fully visible (@pxref{Narrow columns}). When called with a | |
1496 @kbd{C-u} prefix, just make the full field visible, so that it can be | |
1497 edited in place. | |
1498 @c | |
1499 @item M-x org-table-import | |
1500 Import a file as a table. The table should be TAB- or whitespace | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1501 separated. Useful, for example, to import a spreadsheet table or data |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1502 from a database, because these programs generally can write |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1503 TAB-separated text files. This command works by inserting the file into |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1504 the buffer and then converting the region to a table. Any prefix |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1505 argument is passed on to the converter, which uses it to determine the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1506 separator. |
84308 | 1507 @item C-c | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1508 Tables can also be imported by pasting tabular text into the Org |
84308 | 1509 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the |
1510 @kbd{C-c |} command (see above under @i{Creation and conversion}. | |
1511 @c | |
1512 @item M-x org-table-export | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1513 Export the table, by default as a TAB-separated file. Useful for data |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1514 exchange with, for example, spreadsheet or database programs. The format |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1515 used to export the file can be configured in the variable |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1516 @code{org-table-export-default-format}. You may also use properties |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1517 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1518 name and the format for table export in a subtree. |
84308 | 1519 @end table |
1520 | |
1521 If you don't like the automatic table editor because it gets in your | |
1522 way on lines which you would like to start with @samp{|}, you can turn | |
1523 it off with | |
1524 | |
1525 @lisp | |
1526 (setq org-enable-table-editor nil) | |
1527 @end lisp | |
1528 | |
1529 @noindent Then the only table command that still works is | |
1530 @kbd{C-c C-c} to do a manual re-align. | |
1531 | |
1532 @node Narrow columns, Column groups, Built-in table editor, Tables | |
1533 @section Narrow columns | |
1534 @cindex narrow columns in tables | |
1535 | |
1536 The width of columns is automatically determined by the table editor. | |
1537 Sometimes a single field or a few fields need to carry more text, | |
1538 leading to inconveniently wide columns. To limit@footnote{This feature | |
1539 does not work on XEmacs.} the width of a column, one field anywhere in | |
1540 the column may contain just the string @samp{<N>} where @samp{N} is an | |
1541 integer specifying the width of the column in characters. The next | |
1542 re-align will then set the width of this column to no more than this | |
1543 value. | |
1544 | |
1545 @example | |
1546 @group | |
1547 |---+------------------------------| |---+--------| | |
1548 | | | | | <6> | | |
1549 | 1 | one | | 1 | one | | |
1550 | 2 | two | ----\ | 2 | two | | |
1551 | 3 | This is a long chunk of text | ----/ | 3 | This=> | | |
1552 | 4 | four | | 4 | four | | |
1553 |---+------------------------------| |---+--------| | |
1554 @end group | |
1555 @end example | |
1556 | |
1557 @noindent | |
1558 Fields that are wider become clipped and end in the string @samp{=>}. | |
1559 Note that the full text is still in the buffer, it is only invisible. | |
1560 To see the full text, hold the mouse over the field - a tool-tip window | |
1561 will show the full content. To edit such a field, use the command | |
1562 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will | |
1563 open a new window with the full field. Edit it and finish with @kbd{C-c | |
1564 C-c}. | |
1565 | |
1566 When visiting a file containing a table with narrowed columns, the | |
1567 necessary character hiding has not yet happened, and the table needs to | |
1568 be aligned before it looks nice. Setting the option | |
1569 @code{org-startup-align-all-tables} will realign all tables in a file | |
1570 upon visiting, but also slow down startup. You can also set this option | |
1571 on a per-file basis with: | |
1572 | |
1573 @example | |
1574 #+STARTUP: align | |
1575 #+STARTUP: noalign | |
1576 @end example | |
1577 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1578 @node Column groups, Orgtbl mode, Narrow columns, Tables |
84308 | 1579 @section Column groups |
1580 @cindex grouping columns in tables | |
1581 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1582 When Org exports tables, it does so by default without vertical |
84308 | 1583 lines because that is visually more satisfying in general. Occasionally |
1584 however, vertical lines can be useful to structure a table into groups | |
1585 of columns, much like horizontal lines can do for groups of rows. In | |
1586 order to specify column groups, you can use a special row where the | |
1587 first field contains only @samp{/}. The further fields can either | |
1588 contain @samp{<} to indicate that this column should start a group, | |
1589 @samp{>} to indicate the end of a column, or @samp{<>} to make a column | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1590 a group of its own. Boundaries between column groups will upon export be |
84308 | 1591 marked with vertical lines. Here is an example: |
1592 | |
1593 @example | |
1594 | | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) | | |
1595 |---+----+-----+-----+-----+---------+------------| | |
1596 | / | <> | < | | > | < | > | | |
1597 | # | 1 | 1 | 1 | 1 | 1 | 1 | | |
1598 | # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 | | |
1599 | # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 | | |
1600 |---+----+-----+-----+-----+---------+------------| | |
1601 #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2)) | |
1602 @end example | |
1603 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1604 It is also sufficient to just insert the column group starters after |
84308 | 1605 every vertical line you'd like to have: |
1606 | |
1607 @example | |
1608 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) | | |
1609 |----+-----+-----+-----+---------+------------| | |
1610 | / | < | | | < | | | |
1611 @end example | |
1612 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1613 @node Orgtbl mode, The spreadsheet, Column groups, Tables |
84308 | 1614 @section The Orgtbl minor mode |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1615 @cindex Orgtbl mode |
84308 | 1616 @cindex minor mode for tables |
1617 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1618 If you like the intuitive way the Org table editor works, you |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1619 might also want to use it in other modes like Text mode or Mail mode. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1620 The minor mode Orgtbl mode makes this possible. You can always toggle |
84308 | 1621 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for |
1622 example in mail mode, use | |
1623 | |
1624 @lisp | |
1625 (add-hook 'mail-mode-hook 'turn-on-orgtbl) | |
1626 @end lisp | |
1627 | |
1628 Furthermore, with some special setup, it is possible to maintain tables | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1629 in arbitrary syntax with Orgtbl mode. For example, it is possible to |
84308 | 1630 construct La@TeX{} tables with the underlying ease and power of |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1631 Orgtbl mode, including spreadsheet capabilities. For details, see |
84308 | 1632 @ref{Tables in arbitrary syntax}. |
1633 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1634 @node The spreadsheet, , Orgtbl mode, Tables |
84308 | 1635 @section The spreadsheet |
1636 @cindex calculations, in tables | |
1637 @cindex spreadsheet capabilities | |
1638 @cindex @file{calc} package | |
1639 | |
1640 The table editor makes use of the Emacs @file{calc} package to implement | |
1641 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1642 derive fields from other fields. While fully featured, Org's |
84308 | 1643 implementation is not identical to other spreadsheets. For example, |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1644 Org knows the concept of a @emph{column formula} that will be |
84308 | 1645 applied to all non-header fields in a column without having to copy the |
1646 formula to each relevant field. | |
1647 | |
1648 @menu | |
1649 * References:: How to refer to another field or range | |
1650 * Formula syntax for Calc:: Using Calc to compute stuff | |
1651 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp | |
1652 * Field formulas:: Formulas valid for a single field | |
1653 * Column formulas:: Formulas valid for an entire column | |
1654 * Editing and debugging formulas:: Fixing formulas | |
1655 * Updating the table:: Recomputing all dependent fields | |
1656 * Advanced features:: Field names, parameters and automatic recalc | |
1657 @end menu | |
1658 | |
1659 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet | |
1660 @subsection References | |
1661 @cindex references | |
1662 | |
1663 To compute fields in the table from other fields, formulas must | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1664 reference other fields or ranges. In Org, fields can be referenced |
84308 | 1665 by name, by absolute coordinates, and by relative coordinates. To find |
1666 out what the coordinates of a field are, press @kbd{C-c ?} in that | |
1667 field, or press @kbd{C-c @}} to toggle the display of a grid. | |
1668 | |
1669 @subsubheading Field references | |
1670 @cindex field references | |
1671 @cindex references, to fields | |
1672 | |
1673 Formulas can reference the value of another field in two ways. Like in | |
1674 any other spreadsheet, you may reference fields with a letter/number | |
1675 combination like @code{B3}, meaning the 2nd field in the 3rd row. | |
1676 @c Such references are always fixed to that field, they don't change | |
1677 @c when you copy and paste a formula to a different field. So | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1678 @c Org's @code{B3} behaves like @code{$B$3} in other spreadsheets. |
84308 | 1679 |
1680 @noindent | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1681 Org also uses another, more general operator that looks like this: |
84308 | 1682 @example |
1683 @@row$column | |
1684 @end example | |
1685 | |
1686 @noindent | |
1687 Column references can be absolute like @samp{1}, @samp{2},...@samp{N}, | |
1688 or relative to the current column like @samp{+1} or @samp{-2}. | |
1689 | |
1690 The row specification only counts data lines and ignores horizontal | |
1691 separator lines (hlines). You can use absolute row numbers | |
1692 @samp{1}...@samp{N}, and row numbers relative to the current row like | |
1693 @samp{+3} or @samp{-1}. Or specify the row relative to one of the | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1694 hlines: @samp{I} refers to the first hline@footnote{Note that only |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1695 hlines are counted that @emph{separate} table lines. If the table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1696 starts with a hline above the header, it does not count.}, @samp{II} to |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1697 the second etc. @samp{-I} refers to the first such line above the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1698 current line, @samp{+I} to the first such line below the current line. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1699 You can also write @samp{III+2} which is the second data line after the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1700 third hline in the table. Relative row numbers like @samp{-3} will not |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1701 cross hlines if the current line is too close to the hline. Instead, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1702 the value directly at the hline is used. |
84308 | 1703 |
1704 @samp{0} refers to the current row and column. Also, if you omit | |
1705 either the column or the row part of the reference, the current | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
1706 row/column is implied. |
84308 | 1707 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1708 Org's references with @emph{unsigned} numbers are fixed references |
84308 | 1709 in the sense that if you use the same reference in the formula for two |
1710 different fields, the same field will be referenced each time. | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1711 Org's references with @emph{signed} numbers are floating |
84308 | 1712 references because the same reference operator can reference different |
1713 fields depending on the field being calculated by the formula. | |
1714 | |
1715 Here are a few examples: | |
1716 | |
1717 @example | |
1718 @@2$3 @r{2nd row, 3rd column} | |
1719 C2 @r{same as previous} | |
1720 $5 @r{column 5 in the current row} | |
1721 E& @r{same as previous} | |
1722 @@2 @r{current column, row 2} | |
1723 @@-1$-3 @r{the field one row up, three columns to the left} | |
1724 @@-I$2 @r{field just under hline above current row, column 2} | |
1725 @end example | |
1726 | |
1727 @subsubheading Range references | |
1728 @cindex range references | |
1729 @cindex references, to ranges | |
1730 | |
1731 You may reference a rectangular range of fields by specifying two field | |
1732 references connected by two dots @samp{..}. If both fields are in the | |
1733 current row, you may simply use @samp{$2..$7}, but if at least one field | |
1734 is in a different row, you need to use the general @code{@@row$column} | |
1735 format at least for the first field (i.e the reference must start with | |
1736 @samp{@@} in order to be interpreted correctly). Examples: | |
1737 | |
1738 @example | |
1739 $1..$3 @r{First three fields in the current row.} | |
1740 $P..$Q @r{Range, using column names (see under Advanced)} | |
1741 @@2$1..@@4$3 @r{6 fields between these two fields.} | |
1742 A2..C4 @r{Same as above.} | |
1743 @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row} | |
1744 @end example | |
1745 | |
1746 @noindent Range references return a vector of values that can be fed | |
1747 into Calc vector functions. Empty fields in ranges are normally | |
1748 suppressed, so that the vector contains only the non-empty fields (but | |
1749 see the @samp{E} mode switch below). If there are no non-empty fields, | |
1750 @samp{[0]} is returned to avoid syntax errors in formulas. | |
1751 | |
1752 @subsubheading Named references | |
1753 @cindex named references | |
1754 @cindex references, named | |
1755 @cindex name, of column or field | |
1756 @cindex constants, in calculations | |
1757 | |
1758 @samp{$name} is interpreted as the name of a column, parameter or | |
1759 constant. Constants are defined globally through the variable | |
1760 @code{org-table-formula-constants}, and locally (for the file) through a | |
1761 line like | |
1762 | |
1763 @example | |
1764 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6 | |
1765 @end example | |
1766 | |
1767 @noindent | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1768 Also properties (@pxref{Properties and Columns}) can be used as |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1769 constants in table formulas: For a property @samp{:Xyz:} use the name |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1770 @samp{$PROP_Xyz}, and the property will be searched in the current |
84308 | 1771 outline entry and in the hierarchy above it. If you have the |
1772 @file{constants.el} package, it will also be used to resolve constants, | |
1773 including natural constants like @samp{$h} for Planck's constant, and | |
1774 units like @samp{$km} for kilometers@footnote{@file{Constant.el} can | |
1775 supply the values of constants in two different unit systems, @code{SI} | |
1776 and @code{cgs}. Which one is used depends on the value of the variable | |
1777 @code{constants-unit-system}. You can use the @code{#+STARTUP} options | |
1778 @code{constSI} and @code{constcgs} to set this value for the current | |
1779 buffer.}. Column names and parameters can be specified in special table | |
1780 lines. These are described below, see @ref{Advanced features}. All | |
1781 names must start with a letter, and further consist of letters and | |
1782 numbers. | |
1783 | |
1784 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet | |
1785 @subsection Formula syntax for Calc | |
1786 @cindex formula syntax, Calc | |
1787 @cindex syntax, of formulas | |
1788 | |
1789 A formula can be any algebraic expression understood by the Emacs | |
1790 @file{Calc} package. @b{Note that @file{calc} has the | |
1791 non-standard convention that @samp{/} has lower precedence than | |
1792 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before | |
1793 evaluation by @code{calc-eval} (@pxref{Calling Calc from | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1794 Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU |
84308 | 1795 Emacs Calc Manual}), |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1796 @c FIXME: The link to the Calc manual in HTML does not work. |
84308 | 1797 variable substitution takes place according to the rules described above. |
1798 @cindex vectors, in table calculations | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1799 The range vectors can be directly fed into the Calc vector functions |
84308 | 1800 like @samp{vmean} and @samp{vsum}. |
1801 | |
1802 @cindex format specifier | |
1803 @cindex mode, for @file{calc} | |
1804 A formula can contain an optional mode string after a semicolon. This | |
1805 string consists of flags to influence Calc and other modes during | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1806 execution. By default, Org uses the standard Calc modes (precision |
84308 | 1807 12, angular units degrees, fraction and symbolic modes off. The display |
1808 format, however, has been changed to @code{(float 5)} to keep tables | |
1809 compact. The default settings can be configured using the variable | |
1810 @code{org-calc-default-modes}. | |
1811 | |
1812 @example | |
1813 p20 @r{switch the internal precision to 20 digits} | |
1814 n3 s3 e2 f4 @r{normal, scientific, engineering, or fixed display format} | |
1815 D R @r{angle modes: degrees, radians} | |
1816 F S @r{fraction and symbolic modes} | |
1817 N @r{interpret all fields as numbers, use 0 for non-numbers} | |
1818 T @r{force text interpretation} | |
1819 E @r{keep empty fields in ranges} | |
1820 @end example | |
1821 | |
1822 @noindent | |
1823 In addition, you may provide a @code{printf} format specifier to | |
1824 reformat the final result. A few examples: | |
1825 | |
1826 @example | |
1827 $1+$2 @r{Sum of first and second field} | |
1828 $1+$2;%.2f @r{Same, format result to two decimals} | |
1829 exp($2)+exp($1) @r{Math functions can be used} | |
1830 $0;%.1f @r{Reformat current cell to 1 decimal} | |
1831 ($3-32)*5/9 @r{Degrees F -> C conversion} | |
1832 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}} | |
1833 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1} | |
1834 sin($1);Dp3%.1e @r{Same, but use printf specifier for display} | |
1835 vmean($2..$7) @r{Compute column range mean, using vector function} | |
1836 vmean($2..$7);EN @r{Same, but treat empty fields as 0} | |
1837 taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree} | |
1838 @end example | |
1839 | |
1840 Calc also contains a complete set of logical operations. For example | |
1841 | |
1842 @example | |
1843 if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty} | |
1844 @end example | |
1845 | |
1846 @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet | |
1847 @subsection Emacs Lisp forms as formulas | |
1848 @cindex Lisp forms, as table formulas | |
1849 | |
1850 It is also possible to write a formula in Emacs Lisp; this can be useful | |
1851 for string manipulation and control structures, if the Calc's | |
1852 functionality is not enough. If a formula starts with a single quote | |
1853 followed by an opening parenthesis, then it is evaluated as a lisp form. | |
1854 The evaluation should return either a string or a number. Just as with | |
1855 @file{calc} formulas, you can specify modes and a printf format after a | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1856 semicolon. With Emacs Lisp forms, you need to be conscious about the way |
84308 | 1857 field references are interpolated into the form. By default, a |
1858 reference will be interpolated as a Lisp string (in double quotes) | |
1859 containing the field. If you provide the @samp{N} mode switch, all | |
1860 referenced elements will be numbers (non-number fields will be zero) and | |
1861 interpolated as Lisp numbers, without quotes. If you provide the | |
1862 @samp{L} flag, all fields will be interpolated literally, without quotes. | |
1863 I.e., if you want a reference to be interpreted as a string by the Lisp | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1864 form, enclose the reference operator itself in double quotes, like |
84308 | 1865 @code{"$3"}. Ranges are inserted as space-separated fields, so you can |
1866 embed them in list or vector syntax. A few examples, note how the | |
1867 @samp{N} mode is used when we do computations in lisp. | |
1868 | |
1869 @example | |
1870 @r{Swap the first two characters of the content of column 1} | |
1871 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2)) | |
1872 @r{Add columns 1 and 2, equivalent to the Calc's @code{$1+$2}} | |
1873 '(+ $1 $2);N | |
1874 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}} | |
1875 '(apply '+ '($1..$4));N | |
1876 @end example | |
1877 | |
1878 @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet | |
1879 @subsection Field formulas | |
1880 @cindex field formula | |
1881 @cindex formula, for individual table field | |
1882 | |
1883 To assign a formula to a particular field, type it directly into the | |
1884 field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you | |
1885 press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in | |
1886 the field, the formula will be stored as the formula for this field, | |
1887 evaluated, and the current field replaced with the result. | |
1888 | |
1889 Formulas are stored in a special line starting with @samp{#+TBLFM:} | |
1890 directly below the table. If you typed the equation in the 4th field of | |
1891 the 3rd data line in the table, the formula will look like | |
1892 @samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows | |
1893 with the appropriate commands, @i{absolute references} (but not relative | |
1894 ones) in stored formulas are modified in order to still reference the | |
1895 same field. Of cause this is not true if you edit the table structure | |
1896 with normal editing commands - then you must fix the equations yourself. | |
1897 | |
1898 Instead of typing an equation into the field, you may also use the | |
1899 following command | |
1900 | |
1901 @table @kbd | |
1902 @kindex C-u C-c = | |
1903 @item C-u C-c = | |
1904 Install a new formula for the current field. The command prompts for a | |
1905 formula, with default taken from the @samp{#+TBLFM:} line, applies | |
1906 it to the current field and stores it. | |
1907 @end table | |
1908 | |
1909 @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet | |
1910 @subsection Column formulas | |
1911 @cindex column formula | |
1912 @cindex formula, for table column | |
1913 | |
1914 Often in a table, the same formula should be used for all fields in a | |
1915 particular column. Instead of having to copy the formula to all fields | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1916 in that column, Org allows to assign a single formula to an entire |
84308 | 1917 column. If the table contains horizontal separator hlines, everything |
1918 before the first such line is considered part of the table @emph{header} | |
1919 and will not be modified by column formulas. | |
1920 | |
1921 To assign a formula to a column, type it directly into any field in the | |
1922 column, preceded by an equal sign, like @samp{=$1+$2}. When you press | |
1923 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the | |
1924 field, the formula will be stored as the formula for the current column, | |
1925 evaluated and the current field replaced with the result. If the field | |
1926 contains only @samp{=}, the previously stored formula for this column is | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1927 used. For each column, Org will only remember the most recently |
84308 | 1928 used formula. In the @samp{TBLFM:} line, column formulas will look like |
1929 @samp{$4=$1+$2}. | |
1930 | |
1931 Instead of typing an equation into the field, you may also use the | |
1932 following command: | |
1933 | |
1934 @table @kbd | |
1935 @kindex C-c = | |
1936 @item C-c = | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1937 Install a new formula for the current column and replace current field with |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1938 the result of the formula. The command prompts for a formula, with default |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1939 taken from the @samp{#+TBLFM} line, applies it to the current field and |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1940 stores it. With a numeric prefix argument(e.g. @kbd{C-5 C-c =}) the command |
84308 | 1941 will apply it to that many consecutive fields in the current column. |
1942 @end table | |
1943 | |
1944 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1945 @subsection Editing and debugging formulas |
84308 | 1946 @cindex formula editing |
1947 @cindex editing, of table formulas | |
1948 | |
1949 You can edit individual formulas in the minibuffer or directly in the | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1950 field. Org can also prepare a special buffer with all active |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1951 formulas of a table. When offering a formula for editing, Org |
84308 | 1952 converts references to the standard format (like @code{B3} or @code{D&}) |
1953 if possible. If you prefer to only work with the internal format (like | |
1954 @code{@@3$2} or @code{$4}), configure the variable | |
1955 @code{org-table-use-standard-references}. | |
1956 | |
1957 @table @kbd | |
1958 @kindex C-c = | |
1959 @kindex C-u C-c = | |
1960 @item C-c = | |
1961 @itemx C-u C-c = | |
1962 Edit the formula associated with the current column/field in the | |
1963 minibuffer. See @ref{Column formulas} and @ref{Field formulas}. | |
1964 @kindex C-u C-u C-c = | |
1965 @item C-u C-u C-c = | |
1966 Re-insert the active formula (either a | |
1967 field formula, or a column formula) into the current field, so that you | |
1968 can edit it directly in the field. The advantage over editing in the | |
1969 minibuffer is that you can use the command @kbd{C-c ?}. | |
1970 @kindex C-c ? | |
1971 @item C-c ? | |
1972 While editing a formula in a table field, highlight the field(s) | |
1973 referenced by the reference at the cursor position in the formula. | |
1974 @kindex C-c @} | |
1975 @item C-c @} | |
1976 Toggle the display of row and column numbers for a table, using | |
1977 overlays. These are updated each time the table is aligned, you can | |
1978 force it with @kbd{C-c C-c}. | |
1979 @kindex C-c @{ | |
1980 @item C-c @{ | |
1981 Toggle the formula debugger on and off. See below. | |
1982 @kindex C-c ' | |
1983 @item C-c ' | |
1984 Edit all formulas for the current table in a special buffer, where the | |
1985 formulas will be displayed one per line. If the current field has an | |
1986 active formula, the cursor in the formula editor will mark it. | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1987 While inside the special buffer, Org will automatically highlight |
84308 | 1988 any field or range reference at the cursor position. You may edit, |
1989 remove and add formulas, and use the following commands: | |
1990 @table @kbd | |
1991 @kindex C-c C-c | |
1992 @kindex C-x C-s | |
1993 @item C-c C-c | |
1994 @itemx C-x C-s | |
1995 Exit the formula editor and store the modified formulas. With @kbd{C-u} | |
1996 prefix, also apply the new formulas to the entire table. | |
1997 @kindex C-c C-q | |
1998 @item C-c C-q | |
1999 Exit the formula editor without installing changes. | |
2000 @kindex C-c C-r | |
2001 @item C-c C-r | |
2002 Toggle all references in the formula editor between standard (like | |
2003 @code{B3}) and internal (like @code{@@3$2}). | |
2004 @kindex @key{TAB} | |
2005 @item @key{TAB} | |
2006 Pretty-print or indent lisp formula at point. When in a line containing | |
2007 a lisp formula, format the formula according to Emacs Lisp rules. | |
2008 Another @key{TAB} collapses the formula back again. In the open | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2009 formula, @key{TAB} re-indents just like in Emacs lisp mode. |
84308 | 2010 @kindex M-@key{TAB} |
2011 @item M-@key{TAB} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2012 Complete Lisp symbols, just like in Emacs lisp mode. |
84308 | 2013 @kindex S-@key{up} |
2014 @kindex S-@key{down} | |
2015 @kindex S-@key{left} | |
2016 @kindex S-@key{right} | |
2017 @item S-@key{up}/@key{down}/@key{left}/@key{right} | |
2018 Shift the reference at point. For example, if the reference is | |
2019 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}. | |
2020 This also works for relative references, and for hline references. | |
2021 @kindex M-S-@key{up} | |
2022 @kindex M-S-@key{down} | |
2023 @item M-S-@key{up}/@key{down} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2024 Move the test line for column formulas in the Org buffer up and |
84308 | 2025 down. |
2026 @kindex M-@key{up} | |
2027 @kindex M-@key{down} | |
2028 @item M-@key{up}/@key{down} | |
2029 Scroll the window displaying the table. | |
2030 @kindex C-c @} | |
2031 @item C-c @} | |
2032 Turn the coordinate grid in the table on and off. | |
2033 @end table | |
2034 @end table | |
2035 | |
2036 Making a table field blank does not remove the formula associated with | |
2037 the field, because that is stored in a different line (the @samp{TBLFM} | |
2038 line) - during the next recalculation the field will be filled again. | |
2039 To remove a formula from a field, you have to give an empty reply when | |
2040 prompted for the formula, or to edit the @samp{#+TBLFM} line. | |
2041 | |
2042 @kindex C-c C-c | |
2043 You may edit the @samp{#+TBLFM} directly and re-apply the changed | |
2044 equations with @kbd{C-c C-c} in that line, or with the normal | |
2045 recalculation commands in the table. | |
2046 | |
2047 @subsubheading Debugging formulas | |
2048 @cindex formula debugging | |
2049 @cindex debugging, of table formulas | |
2050 When the evaluation of a formula leads to an error, the field content | |
2051 becomes the string @samp{#ERROR}. If you would like see what is going | |
2052 on during variable substitution and calculation in order to find a bug, | |
2053 turn on formula debugging in the @code{Tbl} menu and repeat the | |
2054 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a | |
2055 field. Detailed information will be displayed. | |
2056 | |
2057 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2058 @subsection Updating the table |
84308 | 2059 @cindex recomputing table fields |
2060 @cindex updating, table | |
2061 | |
2062 Recalculation of a table is normally not automatic, but needs to be | |
2063 triggered by a command. See @ref{Advanced features} for a way to make | |
2064 recalculation at least semi-automatically. | |
2065 | |
2066 In order to recalculate a line of a table or the entire table, use the | |
2067 following commands: | |
2068 | |
2069 @table @kbd | |
2070 @kindex C-c * | |
2071 @item C-c * | |
2072 Recalculate the current row by first applying the stored column formulas | |
2073 from left to right, and all field formulas in the current row. | |
2074 @c | |
2075 @kindex C-u C-c * | |
2076 @item C-u C-c * | |
2077 @kindex C-u C-c C-c | |
2078 @itemx C-u C-c C-c | |
2079 Recompute the entire table, line by line. Any lines before the first | |
2080 hline are left alone, assuming that these are part of the table header. | |
2081 @c | |
2082 @kindex C-u C-u C-c * | |
2083 @kindex C-u C-u C-c C-c | |
2084 @item C-u C-u C-c * | |
2085 @itemx C-u C-u C-c C-c | |
2086 Iterate the table by recomputing it until no further changes occur. | |
2087 This may be necessary if some computed fields use the value of other | |
2088 fields that are computed @i{later} in the calculation sequence. | |
2089 @end table | |
2090 | |
2091 @node Advanced features, , Updating the table, The spreadsheet | |
2092 @subsection Advanced features | |
2093 | |
2094 If you want the recalculation of fields to happen automatically, or if | |
2095 you want to be able to assign @i{names} to fields and columns, you need | |
2096 to reserve the first column of the table for special marking characters. | |
2097 @table @kbd | |
2098 @kindex C-# | |
2099 @item C-# | |
2100 Rotate the calculation mark in first column through the states @samp{}, | |
2101 @samp{#}, @samp{*}, @samp{!}, @samp{$}. The meaning of these characters | |
2102 is discussed below. When there is an active region, change all marks in | |
2103 the region. | |
2104 @end table | |
2105 | |
2106 Here is an example of a table that collects exam results of students and | |
2107 makes use of these features: | |
2108 | |
2109 @example | |
2110 @group | |
2111 |---+---------+--------+--------+--------+-------+------| | |
2112 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note | | |
2113 |---+---------+--------+--------+--------+-------+------| | |
2114 | ! | | P1 | P2 | P3 | Tot | | | |
2115 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 | | |
2116 | ^ | | m1 | m2 | m3 | mt | | | |
2117 |---+---------+--------+--------+--------+-------+------| | |
2118 | # | Peter | 10 | 8 | 23 | 41 | 8.2 | | |
2119 | # | Sara | 6 | 14 | 19 | 39 | 7.8 | | |
2120 | # | Sam | 2 | 4 | 3 | 9 | 1.8 | | |
2121 |---+---------+--------+--------+--------+-------+------| | |
2122 | | Average | | | | 29.7 | | | |
2123 | ^ | | | | | at | | | |
2124 | $ | max=50 | | | | | | | |
2125 |---+---------+--------+--------+--------+-------+------| | |
2126 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f | |
2127 @end group | |
2128 @end example | |
2129 | |
2130 @noindent @b{Important}: Please note that for these special tables, | |
2131 recalculating the table with @kbd{C-u C-c *} will only affect rows that | |
2132 are marked @samp{#} or @samp{*}, and fields that have a formula assigned | |
2133 to the field itself. The column formulas are not applied in rows with | |
2134 empty first field. | |
2135 | |
2136 @cindex marking characters, tables | |
2137 The marking characters have the following meaning: | |
2138 @table @samp | |
2139 @item ! | |
2140 The fields in this line define names for the columns, so that you may | |
2141 refer to a column as @samp{$Tot} instead of @samp{$6}. | |
2142 @item ^ | |
2143 This row defines names for the fields @emph{above} the row. With such | |
2144 a definition, any formula in the table may use @samp{$m1} to refer to | |
2145 the value @samp{10}. Also, if you assign a formula to a names field, it | |
2146 will be stored as @samp{$name=...}. | |
2147 @item _ | |
2148 Similar to @samp{^}, but defines names for the fields in the row | |
2149 @emph{below}. | |
2150 @item $ | |
2151 Fields in this row can define @emph{parameters} for formulas. For | |
2152 example, if a field in a @samp{$} row contains @samp{max=50}, then | |
2153 formulas in this table can refer to the value 50 using @samp{$max}. | |
2154 Parameters work exactly like constants, only that they can be defined on | |
2155 a per-table basis. | |
2156 @item # | |
2157 Fields in this row are automatically recalculated when pressing | |
2158 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row | |
2159 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked | |
2160 lines will be left alone by this command. | |
2161 @item * | |
2162 Selects this line for global recalculation with @kbd{C-u C-c *}, but | |
2163 not for automatic recalculation. Use this when automatic | |
2164 recalculation slows down editing too much. | |
2165 @item | |
2166 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}. | |
2167 All lines that should be recalculated should be marked with @samp{#} | |
2168 or @samp{*}. | |
2169 @item / | |
2170 Do not export this line. Useful for lines that contain the narrowing | |
2171 @samp{<N>} markers. | |
2172 @end table | |
2173 | |
2174 Finally, just to whet your appetite on what can be done with the | |
2175 fantastic @file{calc} package, here is a table that computes the Taylor | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2176 series of degree @code{n} at location @code{x} for a couple of |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2177 functions. |
84308 | 2178 |
2179 @example | |
2180 @group | |
2181 |---+-------------+---+-----+--------------------------------------| | |
2182 | | Func | n | x | Result | | |
2183 |---+-------------+---+-----+--------------------------------------| | |
2184 | # | exp(x) | 1 | x | 1 + x | | |
2185 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 | | |
2186 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 | | |
2187 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 | | |
2188 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 | | |
2189 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 | | |
2190 |---+-------------+---+-----+--------------------------------------| | |
2191 #+TBLFM: $5=taylor($2,$4,$3);n3 | |
2192 @end group | |
2193 @end example | |
2194 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2195 @node Hyperlinks, TODO Items, Tables, Top |
84308 | 2196 @chapter Hyperlinks |
2197 @cindex hyperlinks | |
2198 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2199 Like HTML, Org provides links inside a file, external links to |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2200 other files, Usenet articles, emails, and much more. |
84308 | 2201 |
2202 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2203 * Link format:: How links in Org are formatted |
84308 | 2204 * Internal links:: Links to other places in the current file |
2205 * External links:: URL-like links to the world | |
2206 * Handling links:: Creating, inserting and following | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2207 * Using links outside Org:: Linking from my C source code? |
84308 | 2208 * Link abbreviations:: Shortcuts for writing complex links |
2209 * Search options:: Linking to a specific location | |
2210 * Custom searches:: When the default search is not enough | |
2211 @end menu | |
2212 | |
2213 @node Link format, Internal links, Hyperlinks, Hyperlinks | |
2214 @section Link format | |
2215 @cindex link format | |
2216 @cindex format, of links | |
2217 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2218 Org will recognize plain URL-like links and activate them as |
84308 | 2219 clickable links. The general link format, however, looks like this: |
2220 | |
2221 @example | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2222 [[link][description]] @r{or alternatively} [[link]] |
84308 | 2223 @end example |
2224 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2225 Once a link in the buffer is complete (all brackets present), Org |
84308 | 2226 will change the display so that @samp{description} is displayed instead |
2227 of @samp{[[link][description]]} and @samp{link} is displayed instead of | |
2228 @samp{[[link]]}. Links will be highlighted in the face @code{org-link}, | |
2229 which by default is an underlined face. You can directly edit the | |
2230 visible part of a link. Note that this can be either the @samp{link} | |
2231 part (if there is no description) or the @samp{description} part. To | |
2232 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the | |
2233 cursor on the link. | |
2234 | |
2235 If you place the cursor at the beginning or just behind the end of the | |
2236 displayed text and press @key{BACKSPACE}, you will remove the | |
2237 (invisible) bracket at that location. This makes the link incomplete | |
2238 and the internals are again displayed as plain text. Inserting the | |
2239 missing bracket hides the link internals again. To show the | |
2240 internal structure of all links, use the menu entry | |
2241 @code{Org->Hyperlinks->Literal links}. | |
2242 | |
2243 @node Internal links, External links, Link format, Hyperlinks | |
2244 @section Internal links | |
2245 @cindex internal links | |
2246 @cindex links, internal | |
2247 @cindex targets, for links | |
2248 | |
2249 If the link does not look like a URL, it is considered to be internal in | |
2250 the current file. Links such as @samp{[[My Target]]} or @samp{[[My | |
2251 Target][Find my target]]} lead to a text search in the current file. | |
2252 The link can be followed with @kbd{C-c C-o} when the cursor is on the | |
2253 link, or with a mouse click (@pxref{Handling links}). The preferred | |
2254 match for such a link is a dedicated target: the same string in double | |
2255 angular brackets. Targets may be located anywhere; sometimes it is | |
2256 convenient to put them into a comment line. For example | |
2257 | |
2258 @example | |
2259 # <<My Target>> | |
2260 @end example | |
2261 | |
2262 @noindent In HTML export (@pxref{HTML export}), such targets will become | |
2263 named anchors for direct access through @samp{http} links@footnote{Note | |
2264 that text before the first headline is usually not exported, so the | |
2265 first such target should be after the first headline.}. | |
2266 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2267 If no dedicated target exists, Org will search for the words in the |
84308 | 2268 link. In the above example the search would be for @samp{my target}. |
2269 Links starting with a star like @samp{*My Target} restrict the search to | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2270 headlines. When searching, Org mode will first try an exact match, but |
84308 | 2271 then move on to more and more lenient searches. For example, the link |
2272 @samp{[[*My Targets]]} will find any of the following: | |
2273 | |
2274 @example | |
2275 ** My targets | |
2276 ** TODO my targets are bright | |
2277 ** my 20 targets are | |
2278 @end example | |
2279 | |
2280 To insert a link targeting a headline, in-buffer completion can be used. | |
2281 Just type a star followed by a few optional letters into the buffer and | |
2282 press @kbd{M-@key{TAB}}. All headlines in the current buffer will be | |
2283 offered as completions. @xref{Handling links}, for more commands | |
2284 creating links. | |
2285 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2286 Following a link pushes a mark onto Org's own mark ring. You can |
84308 | 2287 return to the previous position with @kbd{C-c &}. Using this command |
2288 several times in direct succession goes back to positions recorded | |
2289 earlier. | |
2290 | |
2291 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2292 * Radio targets:: Make targets trigger links in plain text |
84308 | 2293 @end menu |
2294 | |
2295 @node Radio targets, , Internal links, Internal links | |
2296 @subsection Radio targets | |
2297 @cindex radio targets | |
2298 @cindex targets, radio | |
2299 @cindex links, radio targets | |
2300 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2301 Org can automatically turn any occurrences of certain target names |
84308 | 2302 in normal text into a link. So without explicitly creating a link, the |
2303 text connects to the target radioing its position. Radio targets are | |
2304 enclosed by triple angular brackets. For example, a target @samp{<<<My | |
2305 Target>>>} causes each occurrence of @samp{my target} in normal text to | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2306 become activated as a link. The Org file is scanned automatically |
84308 | 2307 for radio targets only when the file is first loaded into Emacs. To |
2308 update the target list during editing, press @kbd{C-c C-c} with the | |
2309 cursor on or at a target. | |
2310 | |
2311 @node External links, Handling links, Internal links, Hyperlinks | |
2312 @section External links | |
2313 @cindex links, external | |
2314 @cindex external links | |
2315 @cindex links, external | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2316 @cindex Gnus links |
84308 | 2317 @cindex BBDB links |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2318 @cindex IRC links |
84308 | 2319 @cindex URL links |
2320 @cindex file links | |
2321 @cindex VM links | |
2322 @cindex RMAIL links | |
2323 @cindex WANDERLUST links | |
2324 @cindex MH-E links | |
2325 @cindex USENET links | |
2326 @cindex SHELL links | |
2327 @cindex Info links | |
2328 @cindex elisp links | |
2329 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2330 Org supports links to files, websites, Usenet and email messages, |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2331 BBDB database entries and links to both IRC conversations and their |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2332 logs. External links are URL-like locators. They start with a short |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2333 identifying string followed by a colon. There can be no space after |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2334 the colon. The following list shows examples for each link type. |
84308 | 2335 |
2336 @example | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2337 http://www.astro.uva.nl/~dominik @r{on the web} |
84308 | 2338 file:/home/dominik/images/jupiter.jpg @r{file, absolute path} |
2339 file:papers/last.pdf @r{file, relative path} | |
2340 news:comp.emacs @r{Usenet link} | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2341 mailto:adent@@galaxy.net @r{Mail link} |
84308 | 2342 vm:folder @r{VM folder link} |
2343 vm:folder#id @r{VM message link} | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2344 vm://myself@@some.where.org/folder#id @r{VM on remote machine} |
84308 | 2345 wl:folder @r{WANDERLUST folder link} |
2346 wl:folder#id @r{WANDERLUST message link} | |
2347 mhe:folder @r{MH-E folder link} | |
2348 mhe:folder#id @r{MH-E message link} | |
2349 rmail:folder @r{RMAIL folder link} | |
2350 rmail:folder#id @r{RMAIL message link} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2351 gnus:group @r{Gnus group link} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2352 gnus:group#id @r{Gnus article link} |
84308 | 2353 bbdb:Richard Stallman @r{BBDB link} |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2354 irc:/irc.com/#emacs/bob @r{IRC link} |
84308 | 2355 shell:ls *.org @r{A shell command} |
2356 elisp:(find-file-other-frame "Elisp.org") @r{An elisp form to evaluate} | |
2357 @end example | |
2358 | |
2359 A link should be enclosed in double brackets and may contain a | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2360 descriptive text to be displayed instead of the URL (@pxref{Link |
84308 | 2361 format}), for example: |
2362 | |
2363 @example | |
2364 [[http://www.gnu.org/software/emacs/][GNU Emacs]] | |
2365 @end example | |
2366 | |
2367 @noindent | |
2368 If the description is a file name or URL that points to an image, HTML | |
2369 export (@pxref{HTML export}) will inline the image as a clickable | |
2370 button. If there is no description at all and the link points to an | |
2371 image, | |
2372 that image will be inlined into the exported HTML file. | |
2373 | |
2374 @cindex angular brackets, around links | |
2375 @cindex plain text external links | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2376 Org also finds external links in the normal text and activates them |
84308 | 2377 as links. If spaces must be part of the link (for example in |
2378 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities | |
2379 about the end of the link, enclose them in angular brackets. | |
2380 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2381 @node Handling links, Using links outside Org, External links, Hyperlinks |
84308 | 2382 @section Handling links |
2383 @cindex links, handling | |
2384 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2385 Org provides methods to create a link in the correct syntax, to |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2386 insert it into an Org file, and to follow the link. |
84308 | 2387 |
2388 @table @kbd | |
2389 @kindex C-c l | |
2390 @cindex storing links | |
2391 @item C-c l | |
2392 Store a link to the current location. This is a @emph{global} command | |
2393 which can be used in any buffer to create a link. The link will be | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2394 stored for later insertion into an Org buffer (see below). For |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2395 Org files, if there is a @samp{<<target>>} at the cursor, the |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2396 link points to the target. Otherwise it points to the current |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2397 headline. For VM, Rmail, Wanderlust, MH-E, Gnus and BBDB buffers, the |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2398 link will indicate the current article/entry. For W3 and W3M buffers, |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2399 the link goes to the current URL. For IRC links, if you set the |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2400 variable @code{org-irc-link-to-logs} to non-nil then @kbd{C-c l} will |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2401 store a @samp{file:/} style link to the relevant point in the logs for |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2402 the current conversation. Otherwise an @samp{irc:/} style link to the |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2403 user/channel/server under the point will be stored. For any other |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2404 files, the link will point to the file, with a search string |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2405 (@pxref{Search options}) pointing to the contents of the current line. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2406 If there is an active region, the selected words will form the basis |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2407 of the search string. If the automatically created link is not |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2408 working correctly or accurately enough, you can write custom functions |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2409 to select the search string and to do the search for particular file |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2410 types - see @ref{Custom searches}. The key binding @kbd{C-c l} is |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2411 only a suggestion - see @ref{Installation}. |
84308 | 2412 @c |
2413 @kindex C-c C-l | |
2414 @cindex link completion | |
2415 @cindex completion, of links | |
2416 @cindex inserting links | |
2417 @item C-c C-l | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2418 Insert a link. This prompts for a link to be inserted into the buffer. You |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2419 can just type a link, using text for an internal link, or one of the link |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2420 type prefixes mentioned in the examples above. All links stored during the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2421 current session are part of the history for this prompt, so you can access |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2422 them with @key{up} and @key{down} (or @kbd{M-p/n}). Completion, on the other |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2423 hand, will help you to insert valid link prefixes like @samp{http:} or |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2424 @samp{ftp:}, including the prefixes defined through link abbreviations |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2425 (@pxref{Link abbreviations}). The link will be inserted into the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2426 buffer@footnote{After insertion of a stored link, the link will be removed |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2427 from the list of stored links. To keep it in the list later use, use a |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2428 triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2429 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2430 If some text was selected when this command is called, the selected text |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2431 becomes the default description.@* Note that you don't have to use this |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2432 command to insert a link. Links in Org are plain text, and you can type |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2433 or paste them straight into the buffer. By using this command, the links are |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2434 automatically enclosed in double brackets, and you will be asked for the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2435 optional descriptive text. |
84308 | 2436 @c |
2437 @c If the link is a @samp{file:} link and | |
2438 @c the linked file is located in the same directory as the current file or | |
2439 @c a subdirectory of it, the path of the file will be inserted relative to | |
2440 @c the current directory. | |
2441 @c | |
2442 @kindex C-u C-c C-l | |
2443 @cindex file name completion | |
2444 @cindex completion, of file names | |
2445 @item C-u C-c C-l | |
2446 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to | |
2447 a file will be inserted and you may use file name completion to select | |
2448 the name of the file. The path to the file is inserted relative to the | |
2449 directory of the current org file, if the linked file is in the current | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2450 directory or in a sub-directory of it, or if the path is written relative |
84308 | 2451 to the current directory using @samp{../}. Otherwise an absolute path |
2452 is used, if possible with @samp{~/} for your home directory. You can | |
2453 force an absolute path with two @kbd{C-u} prefixes. | |
2454 @c | |
2455 @item C-c C-l @r{(with cursor on existing link)} | |
2456 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the | |
2457 link and description parts of the link. | |
2458 @c | |
2459 @cindex following links | |
2460 @kindex C-c C-o | |
2461 @item C-c C-o | |
2462 Open link at point. This will launch a web browser for URLs (using | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2463 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB |
84308 | 2464 for the corresponding links, and execute the command in a shell link. |
2465 When the cursor is on an internal link, this commands runs the | |
2466 corresponding search. When the cursor is on a TAG list in a headline, | |
2467 it creates the corresponding TAGS view. If the cursor is on a time | |
2468 stamp, it compiles the agenda for that date. Furthermore, it will visit | |
2469 text and remote files in @samp{file:} links with Emacs and select a | |
2470 suitable application for local non-text files. Classification of files | |
2471 is based on file extension only. See option @code{org-file-apps}. If | |
2472 you want to override the default application and visit the file with | |
2473 Emacs, use a @kbd{C-u} prefix. | |
2474 @c | |
2475 @kindex mouse-2 | |
2476 @kindex mouse-1 | |
2477 @item mouse-2 | |
2478 @itemx mouse-1 | |
2479 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o} | |
2480 would. Under Emacs 22, also @kbd{mouse-1} will follow a link. | |
2481 @c | |
2482 @kindex mouse-3 | |
2483 @item mouse-3 | |
2484 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and | |
2485 internal links to be displayed in another window@footnote{See the | |
2486 variable @code{org-display-internal-link-with-indirect-buffer}}. | |
2487 @c | |
2488 @cindex mark ring | |
2489 @kindex C-c % | |
2490 @item C-c % | |
2491 Push the current position onto the mark ring, to be able to return | |
2492 easily. Commands following an internal link do this automatically. | |
2493 @c | |
2494 @cindex links, returning to | |
2495 @kindex C-c & | |
2496 @item C-c & | |
2497 Jump back to a recorded position. A position is recorded by the | |
2498 commands following internal links, and by @kbd{C-c %}. Using this | |
2499 command several times in direct succession moves through a ring of | |
2500 previously recorded positions. | |
2501 @c | |
2502 @kindex C-c C-x C-n | |
2503 @kindex C-c C-x C-p | |
2504 @cindex links, finding next/previous | |
2505 @item C-c C-x C-n | |
2506 @itemx C-c C-x C-p | |
2507 Move forward/backward to the next link in the buffer. At the limit of | |
2508 the buffer, the search fails once, and then wraps around. The key | |
2509 bindings for this are really too long, you might want to bind this also | |
2510 to @kbd{C-n} and @kbd{C-p} | |
2511 @lisp | |
2512 (add-hook 'org-load-hook | |
2513 (lambda () | |
2514 (define-key 'org-mode-map "\C-n" 'org-next-link) | |
2515 (define-key 'org-mode-map "\C-p" 'org-previous-link))) | |
2516 @end lisp | |
2517 @end table | |
2518 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2519 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2520 @section Using links outside Org |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2521 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2522 You can insert and follow links that have Org syntax not only in |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2523 Org, but in any Emacs buffer. For this, you should create two |
84308 | 2524 global commands, like this (please select suitable global keys |
2525 yourself): | |
2526 | |
2527 @lisp | |
2528 (global-set-key "\C-c L" 'org-insert-link-global) | |
2529 (global-set-key "\C-c o" 'org-open-at-point-global) | |
2530 @end lisp | |
2531 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2532 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks |
84308 | 2533 @section Link abbreviations |
2534 @cindex link abbreviations | |
2535 @cindex abbreviation, links | |
2536 | |
2537 Long URLs can be cumbersome to type, and often many similar links are | |
2538 needed in a document. For this you can use link abbreviations. An | |
2539 abbreviated link looks like this | |
2540 | |
2541 @example | |
2542 [[linkword:tag][description]] | |
2543 @end example | |
2544 | |
2545 @noindent | |
2546 where the tag is optional. Such abbreviations are resolved according to | |
2547 the information in the variable @code{org-link-abbrev-alist} that | |
2548 relates the linkwords to replacement text. Here is an example: | |
2549 | |
2550 @lisp | |
2551 @group | |
2552 (setq org-link-abbrev-alist | |
2553 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=") | |
2554 ("google" . "http://www.google.com/search?q=") | |
2555 ("ads" . "http://adsabs.harvard.edu/cgi-bin/ | |
2556 nph-abs_connect?author=%s&db_key=AST"))) | |
2557 @end group | |
2558 @end lisp | |
2559 | |
2560 If the replacement text contains the string @samp{%s}, it will be | |
2561 replaced with the tag. Otherwise the tag will be appended to the string | |
2562 in order to create the link. You may also specify a function that will | |
2563 be called with the tag as the only argument to create the link. | |
2564 | |
2565 With the above setting, you could link to a specific bug with | |
2566 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2567 @code{[[google:OrgMode]]} and find out what the Org author is |
84308 | 2568 doing besides Emacs hacking with @code{[[ads:Dominik,C]]}. |
2569 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2570 If you need special abbreviations just for a single Org buffer, you |
84308 | 2571 can define them in the file with |
2572 | |
2573 @example | |
2574 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id= | |
2575 #+LINK: google http://www.google.com/search?q=%s | |
2576 @end example | |
2577 | |
2578 @noindent | |
2579 In-buffer completion @pxref{Completion} can be used after @samp{[} to | |
2580 complete link abbreviations. | |
2581 | |
2582 @node Search options, Custom searches, Link abbreviations, Hyperlinks | |
2583 @section Search options in file links | |
2584 @cindex search option in file links | |
2585 @cindex file links, searching | |
2586 | |
2587 File links can contain additional information to make Emacs jump to a | |
2588 particular location in the file when following a link. This can be a | |
2589 line number or a search option after a double@footnote{For backward | |
2590 compatibility, line numbers can also follow a single colon.} colon. For | |
2591 example, when the command @kbd{C-c l} creates a link (@pxref{Handling | |
2592 links}) to a file, it encodes the words in the current line as a search | |
2593 string that can be used to find this line back later when following the | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2594 link with @kbd{C-c C-o}. |
84308 | 2595 |
2596 Here is the syntax of the different ways to attach a search to a file | |
2597 link, together with an explanation: | |
2598 | |
2599 @example | |
2600 [[file:~/code/main.c::255]] | |
2601 [[file:~/xx.org::My Target]] | |
2602 [[file:~/xx.org::*My Target]] | |
2603 [[file:~/xx.org::/regexp/]] | |
2604 @end example | |
2605 | |
2606 @table @code | |
2607 @item 255 | |
2608 Jump to line 255. | |
2609 @item My Target | |
2610 Search for a link target @samp{<<My Target>>}, or do a text search for | |
2611 @samp{my target}, similar to the search in internal links, see | |
2612 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file | |
2613 link will become an HTML reference to the corresponding named anchor in | |
2614 the linked file. | |
2615 @item *My Target | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2616 In an Org file, restrict search to headlines. |
84308 | 2617 @item /regexp/ |
2618 Do a regular expression search for @code{regexp}. This uses the Emacs | |
2619 command @code{occur} to list all matches in a separate window. If the | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2620 target file is in Org mode, @code{org-occur} is used to create a |
84308 | 2621 sparse tree with the matches. |
2622 @c If the target file is a directory, | |
2623 @c @code{grep} will be used to search all files in the directory. | |
2624 @end table | |
2625 | |
2626 As a degenerate case, a file link with an empty file name can be used | |
2627 to search the current file. For example, @code{[[file:::find me]]} does | |
2628 a search for @samp{find me} in the current file, just as | |
2629 @samp{[[find me]]} would. | |
2630 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2631 @node Custom searches, , Search options, Hyperlinks |
84308 | 2632 @section Custom Searches |
2633 @cindex custom search strings | |
2634 @cindex search strings, custom | |
2635 | |
2636 The default mechanism for creating search strings and for doing the | |
2637 actual search related to a file link may not work correctly in all | |
2638 cases. For example, BibTeX database files have many entries like | |
2639 @samp{year="1993"} which would not result in good search strings, | |
2640 because the only unique identification for a BibTeX entry is the | |
2641 citation key. | |
2642 | |
2643 If you come across such a problem, you can write custom functions to set | |
2644 the right search string for a particular file type, and to do the search | |
2645 for the string in the file. Using @code{add-hook}, these functions need | |
2646 to be added to the hook variables | |
2647 @code{org-create-file-search-functions} and | |
2648 @code{org-execute-file-search-functions}. See the docstring for these | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2649 variables for more information. Org actually uses this mechanism |
84308 | 2650 for Bib@TeX{} database files, and you can use the corresponding code as |
2651 an implementation example. Search for @samp{BibTeX links} in the source | |
2652 file. | |
2653 | |
2654 | |
2655 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2656 @node TODO Items, Tags, Hyperlinks, Top |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2657 @chapter TODO Items |
84308 | 2658 @cindex TODO items |
2659 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2660 Org mode does not maintain TODO lists as separate documents. Instead, |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2661 TODO items are an integral part of the notes file, because TODO items |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2662 usually come up while taking notes! With Org mode, simply mark any |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2663 entry in a tree as being a TODO item. In this way, information is not |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2664 duplicated, and the entire context from which the TODO item emerged is |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2665 always present. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2666 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2667 Of course, this technique for managing TODO items scatters them |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2668 throughout your notes file. Org mode compensates for this by providing |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2669 methods to give you an overview of all the things that you have to do. |
84308 | 2670 |
2671 @menu | |
2672 * TODO basics:: Marking and displaying TODO entries | |
2673 * TODO extensions:: Workflow and assignments | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2674 * Progress logging:: Dates and notes for progress |
84308 | 2675 * Priorities:: Some things are more important than others |
2676 * Breaking down tasks:: Splitting a task into manageable pieces | |
2677 * Checkboxes:: Tick-off lists | |
2678 @end menu | |
2679 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2680 @node TODO basics, TODO extensions, TODO Items, TODO Items |
84308 | 2681 @section Basic TODO functionality |
2682 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2683 Any headline becomes a TODO item when it starts with the word |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2684 @samp{TODO}, for example: |
84308 | 2685 |
2686 @example | |
2687 *** TODO Write letter to Sam Fortune | |
2688 @end example | |
2689 | |
2690 @noindent | |
2691 The most important commands to work with TODO entries are: | |
2692 | |
2693 @table @kbd | |
2694 @kindex C-c C-t | |
2695 @cindex cycling, of TODO states | |
2696 @item C-c C-t | |
2697 Rotate the TODO state of the current item among | |
2698 | |
2699 @example | |
2700 ,-> (unmarked) -> TODO -> DONE --. | |
2701 '--------------------------------' | |
2702 @end example | |
2703 | |
2704 The same rotation can also be done ``remotely'' from the timeline and | |
2705 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}). | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2706 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2707 @kindex C-u C-c C-t |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2708 @item C-u C-c C-t |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2709 Select a specific keyword using completion or (if it has been set up) |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2710 the fast selection interface. For the latter, you need to assign keys |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2711 to TODO states, see @ref{Per-file keywords} and @ref{Setting tags} for |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2712 more information. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2713 |
84308 | 2714 @kindex S-@key{right} |
2715 @kindex S-@key{left} | |
2716 @item S-@key{right} | |
2717 @itemx S-@key{left} | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2718 Select the following/preceding TODO state, similar to cycling. Useful |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2719 mostly if more than two TODO states are possible (@pxref{TODO |
84308 | 2720 extensions}). |
2721 @kindex C-c C-v | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2722 @kindex C-c / t |
84308 | 2723 @cindex sparse tree, for TODO |
2724 @item C-c C-v | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2725 @itemx C-c / t |
84308 | 2726 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds |
2727 the entire buffer, but shows all TODO items and the headings hierarchy | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2728 above them. With a prefix argument, search for a specific TODO. You will be |
84308 | 2729 prompted for the keyword, and you can also give a list of keywords like |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2730 @code{KWD1|KWD2|...}. With numeric prefix argument N, show the tree for the |
84308 | 2731 Nth keyword in the variable @code{org-todo-keywords}. With two prefix |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2732 arguments, find all TODO and DONE entries. |
84308 | 2733 @kindex C-c a t |
2734 @item C-c a t | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2735 Show the global TODO list. Collects the TODO items from all agenda |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2736 files (@pxref{Agenda Views}) into a single buffer. The new buffer will |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2737 be in @code{agenda-mode}, which provides commands to examine and |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2738 manipulate the TODO entries from the new buffer (@pxref{Agenda |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2739 commands}). @xref{Global TODO list}, for more information. |
84308 | 2740 @kindex S-M-@key{RET} |
2741 @item S-M-@key{RET} | |
2742 Insert a new TODO entry below the current one. | |
2743 @end table | |
2744 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2745 @node TODO extensions, Progress logging, TODO basics, TODO Items |
84308 | 2746 @section Extended use of TODO keywords |
2747 @cindex extended TODO keywords | |
2748 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2749 By default, marked TODO entries have one of only two states: TODO and |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2750 DONE. Org mode allows you to classify TODO items in more complex ways |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2751 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2752 special setup, the TODO keyword system can work differently in different |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2753 files. |
84308 | 2754 |
2755 Note that @i{tags} are another way to classify headlines in general and | |
2756 TODO items in particular (@pxref{Tags}). | |
2757 | |
2758 @menu | |
2759 * Workflow states:: From TODO to DONE in steps | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2760 * TODO types:: I do this, Fred does the rest |
84308 | 2761 * Multiple sets in one file:: Mixing it all, and still finding your way |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2762 * Fast access to TODO states:: Single letter selection of a state |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2763 * Per-file keywords:: Different files, different requirements |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2764 * Faces for TODO keywords:: Highlighting states |
84308 | 2765 @end menu |
2766 | |
2767 @node Workflow states, TODO types, TODO extensions, TODO extensions | |
2768 @subsection TODO keywords as workflow states | |
2769 @cindex TODO workflow | |
2770 @cindex workflow states as TODO keywords | |
2771 | |
2772 You can use TODO keywords to indicate different @emph{sequential} states | |
2773 in the process of working on an item, for example@footnote{Changing | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2774 this variable only becomes effective after restarting Org mode in a |
84308 | 2775 buffer.}: |
2776 | |
2777 @lisp | |
2778 (setq org-todo-keywords | |
2779 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED"))) | |
2780 @end lisp | |
2781 | |
2782 The vertical bar separates the TODO keywords (states that @emph{need | |
2783 action}) from the DONE states (which need @emph{no further action}. If | |
2784 you don't provide the separator bar, the last state is used as the DONE | |
2785 state. | |
2786 @cindex completion, of TODO keywords | |
2787 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO | |
2788 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2789 also use a numeric prefix argument to quickly select a specific state. For |
84308 | 2790 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY. |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2791 Or you can use @kbd{S-left} to go backward through the sequence. If you |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2792 define many keywords, you can use in-buffer completion |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2793 (@pxref{Completion}) or even a special one-key selection scheme |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2794 (@pxref{Fast access to TODO states}) to insert these words into the |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2795 buffer. Changing a TODO state can be logged with a timestamp, see |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2796 @ref{Tracking TODO state changes} for more information. |
84308 | 2797 |
2798 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions | |
2799 @subsection TODO keywords as types | |
2800 @cindex TODO types | |
2801 @cindex names as TODO keywords | |
2802 @cindex types as TODO keywords | |
2803 | |
2804 The second possibility is to use TODO keywords to indicate different | |
2805 @emph{types} of action items. For example, you might want to indicate | |
2806 that items are for ``work'' or ``home''. Or, when you work with several | |
2807 people on a single project, you might want to assign action items | |
2808 directly to persons, by using their names as TODO keywords. This would | |
2809 be set up like this: | |
2810 | |
2811 @lisp | |
2812 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE"))) | |
2813 @end lisp | |
2814 | |
2815 In this case, different keywords do not indicate a sequence, but rather | |
2816 different types. So the normal work flow would be to assign a task to a | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2817 person, and later to mark it DONE. Org mode supports this style by adapting |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2818 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2819 @kbd{t} command in the timeline and agenda buffers.}. When used several |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2820 times in succession, it will still cycle through all names, in order to first |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2821 select the right type for a task. But when you return to the item after some |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2822 time and execute @kbd{C-c C-t} again, it will switch from any name directly |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2823 to DONE. Use prefix arguments or completion to quickly select a specific |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2824 name. You can also review the items of a specific TODO type in a sparse tree |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2825 by using a numeric prefix to @kbd{C-c C-v}. For example, to see all things |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2826 Lucy has to do, you would use @kbd{C-3 C-c C-v}. To collect Lucy's items |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2827 from all agenda files into a single buffer, you would use the numeric prefix |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2828 argument as well when creating the global TODO list: @kbd{C-3 C-c t}. |
84308 | 2829 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2830 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions |
84308 | 2831 @subsection Multiple keyword sets in one file |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2832 @cindex TODO keyword sets |
84308 | 2833 |
2834 Sometimes you may want to use different sets of TODO keywords in | |
2835 parallel. For example, you may want to have the basic | |
2836 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a | |
2837 separate state indicating that an item has been canceled (so it is not | |
2838 DONE, but also does not require action). Your setup would then look | |
2839 like this: | |
2840 | |
2841 @lisp | |
2842 (setq org-todo-keywords | |
2843 '((sequence "TODO" "|" "DONE") | |
2844 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED") | |
2845 (sequence "|" "CANCELED"))) | |
2846 @end lisp | |
2847 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2848 The keywords should all be different, this helps Org mode to keep track |
84308 | 2849 of which subsequence should be used for a given entry. In this setup, |
2850 @kbd{C-c C-t} only operates within a subsequence, so it switches from | |
2851 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to | |
2852 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially | |
2853 select the correct sequence. Besides the obvious ways like typing a | |
2854 keyword or using completion, you may also apply the following commands: | |
2855 | |
2856 @table @kbd | |
2857 @kindex C-S-@key{right} | |
2858 @kindex C-S-@key{left} | |
2859 @item C-S-@key{right} | |
2860 @itemx C-S-@key{left} | |
2861 These keys jump from one TODO subset to the next. In the above example, | |
2862 @kbd{C-S-@key{right}} would jump from @code{TODO} or @code{DONE} to | |
2863 @code{REPORT}, and any of the words in the second row to @code{CANCELED}. | |
2864 @kindex S-@key{right} | |
2865 @kindex S-@key{left} | |
2866 @item S-@key{right} | |
2867 @itemx S-@key{left} | |
2868 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through | |
2869 @emph{all} keywords from all sets, so for example @kbd{S-@key{<right>}} | |
2870 would switch from @code{DONE} to @code{REPORT} in the example above. | |
2871 @end table | |
2872 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2873 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2874 @subsection Fast access to TODO states |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2875 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2876 If you would like to quickly change an entry to an arbitrary TODO state |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2877 instead of cycling through the states, you can set up keys for |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2878 single-letter access to the states. This is done by adding the section |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2879 key after each keyword, in parenthesis. For example: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2880 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2881 @lisp |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2882 (setq org-todo-keywords |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2883 '((sequence "TODO(t)" "|" "DONE(d)") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2884 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2885 (sequence "|" "CANCELED(c)"))) |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2886 @end lisp |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2887 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2888 If you then press @code{C-u C-c C-t} followed by the selection key, the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2889 entry will be switched to this state. @key{SPC} can be used to remove |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2890 any TODO keyword from an entry. Should you like this way of selecting |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2891 TODO states a lot, you might want to set the variable |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2892 @code{org-use-fast-todo-selection} to @code{t} and make this behavior |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2893 the default. Check also the variable |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2894 @code{org-fast-tag-selection-include-todo}, it allows to change the TODO |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2895 state through the tags interface (@pxref{Setting tags}), in case you |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2896 like to mingle the two concepts. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2897 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2898 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions |
84308 | 2899 @subsection Setting up keywords for individual files |
2900 @cindex keyword options | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2901 @cindex per-file keywords |
84308 | 2902 |
2903 It can be very useful to use different aspects of the TODO mechanism in | |
2904 different files. For file-local settings, you need to add special lines | |
2905 to the file which set the keywords and interpretation for that file | |
2906 only. For example, to set one of the two examples discussed above, you | |
2907 need one of the following lines, starting in column zero anywhere in the | |
2908 file: | |
2909 | |
2910 @example | |
2911 #+SEQ_TODO: TODO FEEDBACK VERIFY | DONE CANCELED | |
2912 @end example | |
2913 or | |
2914 @example | |
2915 #+TYP_TODO: Fred Sara Lucy Mike | DONE | |
2916 @end example | |
2917 | |
2918 A setup for using several sets in parallel would be: | |
2919 | |
2920 @example | |
2921 #+SEQ_TODO: TODO | DONE | |
2922 #+SEQ_TODO: REPORT BUG KNOWNCAUSE | FIXED | |
2923 #+SEQ_TODO: | CANCELED | |
2924 @end example | |
2925 | |
2926 @cindex completion, of option keywords | |
2927 @kindex M-@key{TAB} | |
2928 @noindent To make sure you are using the correct keyword, type | |
2929 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion. | |
2930 | |
2931 @cindex DONE, final TODO keyword | |
2932 Remember that the keywords after the vertical bar (or the last keyword | |
2933 if no bar is there) must always mean that the item is DONE (although you | |
2934 may use a different word). After changing one of these lines, use | |
2935 @kbd{C-c C-c} with the cursor still in the line to make the changes | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2936 known to Org mode@footnote{Org mode parses these lines only when |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2937 Org mode is activated after visiting a file. @kbd{C-c C-c} with the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2938 cursor in a line starting with @samp{#+} is simply restarting Org mode |
84308 | 2939 for the current buffer.}. |
2940 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2941 @node Faces for TODO keywords, , Per-file keywords, TODO extensions |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2942 @subsection Faces for TODO keywords |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2943 @cindex faces, for TODO keywords |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2944 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2945 Org mode highlights TODO keywords with special faces: @code{org-todo} |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2946 for keywords indicating that an item still has to be acted upon, and |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2947 @code{org-done} for keywords indicating that an item is finished. If |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2948 you are using more than 2 different states, you might want to use |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2949 special faces for some of them. This can be done using the variable |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2950 @code{org-todo-keyword-faces}. For example: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2951 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2952 @lisp |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2953 (setq org-todo-keyword-faces |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2954 '(("TODO" . org-warning) |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2955 ("DEFERRED" . shadow) |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2956 ("CANCELED" . (:foreground "blue" :weight bold)))) |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2957 @end lisp |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2958 |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2959 While using a list with face properties as shown for CANCELED |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2960 @emph{should} work, this does not aways seem to be the case. If |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2961 necessary, define a special face and use that. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2962 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2963 @page |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2964 @node Progress logging, Priorities, TODO extensions, TODO Items |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2965 @section Progress logging |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2966 @cindex progress logging |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2967 @cindex logging, of progress |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2968 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2969 Org mode can automatically record a time stamp and possibly a note when |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2970 you mark a TODO item as DONE, or even each time you change the state of |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2971 a TODO item. This system is highly configurable, settings can be on a |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2972 per-keyword basis and can be localized to a file or even a subtree. For |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2973 information on how to clock working time for a task, see @ref{Clocking |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2974 work time}. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2975 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2976 @menu |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2977 * Closing items:: When was this entry marked DONE? |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2978 * Tracking TODO state changes:: When did the status change? |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2979 @end menu |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2980 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2981 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2982 @subsection Closing items |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2983 |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2984 The most basic logging is to keep track of @emph{when} a certain TODO |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2985 item was finished. This is achieved with@footnote{The corresponding |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2986 in-buffer setting is: @code{#+STARTUP: logdone}}. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2987 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2988 @lisp |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2989 (setq org-log-done 'time) |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2990 @end lisp |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2991 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2992 @noindent |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2993 Then each time you turn an entry from a TODO (not-done) state into any |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2994 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2995 just after the headline. If you turn the entry back into a TODO item |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2996 through further state cycling, that line will be removed again. If you |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2997 want to record a note along with the timestamp, use@footnote{The |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2998 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}} |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2999 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3000 @lisp |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3001 (setq org-log-done 'note) |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3002 @end lisp |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3003 |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3004 @noindent |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3005 You will then be prompted for a note, and that note will be stored below |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3006 the entry with a @samp{Closing Note} heading. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3007 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3008 In the timeline (@pxref{Timeline}) and in the agenda |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3009 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3010 display the TODO items with a @samp{CLOSED} timestamp on each day, |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3011 giving you an overview of what has been done. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3012 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3013 @node Tracking TODO state changes, , Closing items, Progress logging |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3014 @subsection Tracking TODO state changes |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3015 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3016 When TODO keywords are used as workflow states (@pxref{Workflow |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3017 states}), you might want to keep track of when a state change occurred |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3018 and maybe take a note about this change. Since it is normally too much |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3019 to record a note for every state, Org mode expects configuration on a |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3020 per-keyword basis for this. This is achieved by adding special markers |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3021 @samp{!} (for a time stamp) and @samp{@@} (for a note) in parenthesis |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3022 after each keyword. For example, with the setting |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3023 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3024 @lisp |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3025 (setq org-todo-keywords |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3026 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)"))) |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3027 @end lisp |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3028 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3029 @noindent |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3030 you not only define global TODO keywords and fast access keys, but also |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3031 request that a time is recorded when the entry is turned into |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3032 DONE@footnote{It is possible that Org mode will record two time stamps |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3033 when you are using both @code{org-log-done} and state change logging. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3034 However, it will never prompt for two notes - if you have configured |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3035 both, the state change recording note will take precedence and cancel |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3036 the @samp{Closing Note}.}, and that a note is recorded when switching to |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3037 WAIT or CANCELED. The setting for WAIT is even more special: The |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3038 @samp{!} after the slash means that in addition to the note taken when |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3039 entering the state, a time stamp should be recorded when @i{leaving} the |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3040 WAIT state, if and only if the @i{target} state does not configure |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3041 logging for entering it. So it has no effect when switching from WAIT |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3042 to DONE, because DONE is configured to record a timestamp only. But |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3043 when switching from WAIT back to TODO, the @samp{/!} in the WAIT |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3044 setting now triggers a timestamp even though TODO has no logging |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3045 configured. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3046 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3047 You can use the exact same syntax for setting logging preferences local |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3048 to a buffer: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3049 @example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3050 #+SEQ_TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@) |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3051 @end example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3052 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3053 In order to define logging settings that are local to a subtree or a |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3054 single item, define a LOGGING property in this entry. Any non-empty |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3055 LOGGING property resets all logging settings to nil. You may then turn |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3056 on logging for this specific tree using STARTUP keywords like |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3057 @code{lognotedone} or @code{logrepeat}, as well as adding state specific |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3058 settings like @code{TODO(!)}. For example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3059 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3060 @example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3061 * TODO Log each state with only a time |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3062 :PROPERTIES: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3063 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!) |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3064 :END: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3065 * TODO Only log when switching to WAIT, and when repeating |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3066 :PROPERTIES: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3067 :LOGGING: WAIT(@@) logrepeat |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3068 :END: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3069 * TODO No logging at all |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3070 :PROPERTIES: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3071 :LOGGING: nil |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3072 :END: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3073 @end example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3074 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3075 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3076 @node Priorities, Breaking down tasks, Progress logging, TODO Items |
84308 | 3077 @section Priorities |
3078 @cindex priorities | |
3079 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3080 If you use Org mode extensively, you may end up enough TODO items that |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3081 it starts to make sense to prioritize them. Prioritizing can be done by |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3082 placing a @emph{priority cookie} into the headline of a TODO item, like |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3083 this |
84308 | 3084 |
3085 @example | |
3086 *** TODO [#A] Write letter to Sam Fortune | |
3087 @end example | |
3088 | |
3089 @noindent | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3090 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3091 @samp{C}. @samp{A} is the highest priority. An entry without a cookie |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3092 is treated as priority @samp{B}. Priorities make a difference only in |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3093 the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they have |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3094 no inherent meaning to Org mode. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3095 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3096 Priorities can be attached to any outline tree entries; they do not need |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3097 to be TODO items. |
84308 | 3098 |
3099 @table @kbd | |
3100 @kindex @kbd{C-c ,} | |
3101 @item @kbd{C-c ,} | |
3102 Set the priority of the current headline. The command prompts for a | |
3103 priority character @samp{A}, @samp{B} or @samp{C}. When you press | |
3104 @key{SPC} instead, the priority cookie is removed from the headline. | |
3105 The priorities can also be changed ``remotely'' from the timeline and | |
3106 agenda buffer with the @kbd{,} command (@pxref{Agenda commands}). | |
3107 @c | |
3108 @kindex S-@key{up} | |
3109 @kindex S-@key{down} | |
3110 @item S-@key{up} | |
3111 @itemx S-@key{down} | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3112 Increase/decrease priority of current headline@footnote{See also the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3113 option @code{org-priority-start-cycle-with-default'}.}. Note that these |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3114 keys are also used to modify time stamps (@pxref{Creating timestamps}). |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3115 Furthermore, these keys are also used by CUA mode (@pxref{Conflicts}). |
84308 | 3116 @end table |
3117 | |
3118 You can change the range of allowed priorities by setting the variables | |
3119 @code{org-highest-priority}, @code{org-lowest-priority}, and | |
3120 @code{org-default-priority}. For an individual buffer, you may set | |
3121 these values (highest, lowest, default) like this (please make sure that | |
3122 the highest priority is earlier in the alphabet than the lowest | |
3123 priority): | |
3124 | |
3125 @example | |
3126 #+PRIORITIES: A C B | |
3127 @end example | |
3128 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3129 @node Breaking down tasks, Checkboxes, Priorities, TODO Items |
84308 | 3130 @section Breaking tasks down into subtasks |
3131 @cindex tasks, breaking down | |
3132 | |
3133 It is often advisable to break down large tasks into smaller, manageable | |
3134 subtasks. You can do this by creating an outline tree below a TODO | |
3135 item, with detailed subtasks on the tree@footnote{To keep subtasks out | |
3136 of the global TODO list, see the | |
3137 @code{org-agenda-todo-list-sublevels}.}. Another possibility is the use | |
3138 of checkboxes to identify (a hierarchy of) a large number of subtasks | |
3139 (@pxref{Checkboxes}). | |
3140 | |
3141 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3142 @node Checkboxes, , Breaking down tasks, TODO Items |
84308 | 3143 @section Checkboxes |
3144 @cindex checkboxes | |
3145 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3146 Every item in a plain list (@pxref{Plain lists}) can be made into a |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3147 checkbox by starting it with the string @samp{[ ]}. This feature is |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3148 similar to TODO items (@pxref{TODO Items}), but is more lightweight. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3149 Checkboxes are not included into the global TODO list, so they are often |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3150 great to split a task into a number of simple steps. Or you can use |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3151 them in a shopping list. To toggle a checkbox, use @kbd{C-c C-c}, or |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3152 use the mouse (thanks to Piotr Zielinski's @file{org-mouse.el}). |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3153 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3154 Here is an example of a checkbox list. |
84308 | 3155 |
3156 @example | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3157 * TODO Organize party [2/4] |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3158 - [-] call people [1/3] |
84308 | 3159 - [ ] Peter |
3160 - [X] Sarah | |
3161 - [ ] Sam | |
3162 - [X] order food | |
3163 - [ ] think about what music to play | |
3164 - [X] talk to the neighbors | |
3165 @end example | |
3166 | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3167 Checkboxes work hierarchically, so if a checkbox item has children that |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3168 are checkboxes, toggling one of the children checkboxes will make the |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3169 parent checkbox reflect if none, some, or all of the children are |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3170 checked. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3171 |
84308 | 3172 @cindex statistics, for checkboxes |
3173 @cindex checkbox statistics | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3174 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3175 cookies indicating how many checkboxes present in this entry have been |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3176 checked off, and the total number of checkboxes are present. This can |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3177 give you an idea on how many checkboxes remain, even without opening a |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3178 folded entry. The cookies can be placed into a headline or into (the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3179 first line of) a plain list item. Each cookie covers all checkboxes |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3180 structurally below the headline/item on which the cookie appear. You |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3181 have to insert the cookie yourself by typing either @samp{[/]} or |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3182 @samp{[%]}. With @samp{[/]} you get an @samp{n out of m} result, as in |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3183 the examples above. With @samp{[%]} you get information about the |
84308 | 3184 percentage of checkboxes checked (in the above example, this would be |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3185 @samp{[50%]} and @samp{[33%]}, respectively). |
84308 | 3186 |
3187 @noindent The following commands work with checkboxes: | |
3188 | |
3189 @table @kbd | |
3190 @kindex C-c C-c | |
3191 @item C-c C-c | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3192 Toggle checkbox at point. With a prefix argument, set it to @samp{[-]}, |
84308 | 3193 which is considered to be an intermediate state. |
3194 @kindex C-c C-x C-b | |
3195 @item C-c C-x C-b | |
3196 Toggle checkbox at point. | |
3197 @itemize @minus | |
3198 @item | |
3199 If there is an active region, toggle the first checkbox in the region | |
3200 and set all remaining boxes to the same status as the first. If you | |
3201 want to toggle all boxes in the region independently, use a prefix | |
3202 argument. | |
3203 @item | |
3204 If the cursor is in a headline, toggle checkboxes in the region between | |
3205 this headline and the next (so @emph{not} the entire subtree). | |
3206 @item | |
3207 If there is no active region, just toggle the checkbox at point. | |
3208 @end itemize | |
3209 @kindex M-S-@key{RET} | |
3210 @item M-S-@key{RET} | |
3211 Insert a new item with a checkbox. | |
3212 This works only if the cursor is already in a plain list item | |
3213 (@pxref{Plain lists}). | |
3214 @kindex C-c # | |
3215 @item C-c # | |
3216 Update the checkbox statistics in the current outline entry. When | |
3217 called with a @kbd{C-u} prefix, update the entire file. Checkbox | |
3218 statistic cookies are updated automatically if you toggle checkboxes | |
3219 with @kbd{C-c C-c} and make new ones with @kbd{M-S-@key{RET}}. If you | |
3220 delete boxes or add/change them by hand, use this command to get things | |
3221 back into synch. Or simply toggle any checkbox twice with @kbd{C-c C-c}. | |
3222 @end table | |
3223 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3224 @node Tags, Properties and Columns, TODO Items, Top |
84308 | 3225 @chapter Tags |
3226 @cindex tags | |
3227 @cindex headline tagging | |
3228 @cindex matching, tags | |
3229 @cindex sparse tree, tag based | |
3230 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3231 An excellent way to implement labels and contexts for cross-correlating |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3232 information is to assign @i{tags} to headlines. Org mode has extensive |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3233 support for tags. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3234 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3235 Every headline can contain a list of tags; they occur at the end of the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3236 headline. Tags are normal words containing letters, numbers, @samp{_}, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3237 and @samp{@@}. Tags must be preceded and followed by a single colon, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3238 e.g., @samp{:WORK:}. Several tags can be specified, as in |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3239 @samp{:work:URGENT:}. |
84308 | 3240 |
3241 @menu | |
3242 * Tag inheritance:: Tags use the tree structure of the outline | |
3243 * Setting tags:: How to assign tags to a headline | |
3244 * Tag searches:: Searching for combinations of tags | |
3245 @end menu | |
3246 | |
3247 @node Tag inheritance, Setting tags, Tags, Tags | |
3248 @section Tag inheritance | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3249 @cindex tag inheritance |
84308 | 3250 @cindex inheritance, of tags |
3251 @cindex sublevels, inclusion into tags match | |
3252 | |
3253 @i{Tags} make use of the hierarchical structure of outline trees. If a | |
3254 heading has a certain tag, all subheadings will inherit the tag as | |
3255 well. For example, in the list | |
3256 | |
3257 @example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3258 * Meeting with the French group :work: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3259 ** Summary by Frank :boss:notes: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3260 *** TODO Prepare slides for him :action: |
84308 | 3261 @end example |
3262 | |
3263 @noindent | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3264 the final heading will have the tags @samp{:work:}, @samp{:boss:}, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3265 @samp{:notes:}, and @samp{:action:} even though the final heading is not |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3266 explicitly marked with those tags. When executing tag searches and |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3267 Org mode finds that a certain headline matches the search criterion, it |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3268 will not check any sublevel headline, assuming that these also match and |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3269 that the list of matches could become very long because of that. If you |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3270 do want the sublevels be tested and listed as well, you may set the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3271 variable @code{org-tags-match-list-sublevels}. To limit tag inheritance |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3272 to specific tags, or to turn it off entirely, use the variable |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3273 @code{org-use-tag-inheritance}. |
84308 | 3274 |
3275 @node Setting tags, Tag searches, Tag inheritance, Tags | |
3276 @section Setting tags | |
3277 @cindex setting tags | |
3278 @cindex tags, setting | |
3279 | |
3280 @kindex M-@key{TAB} | |
3281 Tags can simply be typed into the buffer at the end of a headline. | |
3282 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is | |
3283 also a special command for inserting tags: | |
3284 | |
3285 @table @kbd | |
3286 @kindex C-c C-c | |
3287 @item C-c C-c | |
3288 @cindex completion, of tags | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3289 Enter new tags for the current headline. Org mode will either offer |
84308 | 3290 completion or a special single-key interface for setting tags, see |
3291 below. After pressing @key{RET}, the tags will be inserted and aligned | |
3292 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all | |
3293 tags in the current buffer will be aligned to that column, just to make | |
3294 things look nice. TAGS are automatically realigned after promotion, | |
3295 demotion, and TODO state changes (@pxref{TODO basics}). | |
3296 @end table | |
3297 | |
3298 Org will support tag insertion based on a @emph{list of tags}. By | |
3299 default this list is constructed dynamically, containing all tags | |
3300 currently used in the buffer. You may also globally specify a hard list | |
3301 of tags with the variable @code{org-tag-alist}. Finally you can set | |
3302 the default tags for a given file with lines like | |
3303 | |
3304 @example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3305 #+TAGS: @@work @@home @@tennisclub |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3306 #+TAGS: laptop car pc sailboat |
84308 | 3307 @end example |
3308 | |
3309 If you have globally defined your preferred set of tags using the | |
3310 variable @code{org-tag-alist}, but would like to use a dynamic tag list | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3311 in a specific file, add an empty TAGS option line to that file: |
84308 | 3312 |
3313 @example | |
3314 #+TAGS: | |
3315 @end example | |
3316 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3317 By default Org mode uses the standard minibuffer completion facilities for |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3318 entering tags. However, it also implements another, quicker, tag selection |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3319 method called @emph{fast tag selection}. This allows you to select and |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3320 deselect tags with just a single key press. For this to work well you should |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3321 assign unique letters to most of your commonly used tags. You can do this |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3322 globally by configuring the variable @code{org-tag-alist} in your |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3323 @file{.emacs} file. For example, you may find the need to tag many items in |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3324 different files with @samp{:@@home:}. In this case you can set something |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3325 like: |
84308 | 3326 |
3327 @lisp | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3328 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l))) |
84308 | 3329 @end lisp |
3330 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3331 @noindent If the tag is only relevant to the file you are working on then you |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3332 can, instead, set the TAGS option line as: |
84308 | 3333 |
3334 @example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3335 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p) |
84308 | 3336 @end example |
3337 | |
3338 @noindent | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3339 You can also group together tags that are mutually exclusive. By using |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3340 braces, as in: |
84308 | 3341 |
3342 @example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3343 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p) |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3344 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3345 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3346 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home}, |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3347 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed. |
84308 | 3348 |
3349 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of | |
3350 these lines to activate any changes. | |
3351 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3352 @noindent |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3353 To set these mutually exclusive groups in the variable @code{org-mode-alist} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3354 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3355 of the braces. The previous example would be set globally by the following |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3356 configuration: |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3357 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3358 @lisp |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3359 (setq org-tag-alist '((:startgroup . nil) |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3360 ("@@work" . ?w) ("@@home" . ?h) |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3361 ("@@tennisclub" . ?t) |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3362 (:endgroup . nil) |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3363 ("laptop" . ?l) ("pc" . ?p))) |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3364 @end lisp |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3365 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3366 If at least one tag has a selection key then pressing @kbd{C-c C-c} will |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3367 automatically present you with a special interface, listing inherited tags, |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3368 the tags of the current headline, and a list of all valid tags with |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3369 corresponding keys@footnote{Keys will automatically be assigned to tags which |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3370 have no configured keys.}. In this interface, you can use the following |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3371 keys: |
84308 | 3372 |
3373 @table @kbd | |
3374 @item a-z... | |
3375 Pressing keys assigned to tags will add or remove them from the list of | |
3376 tags in the current line. Selecting a tag in a group of mutually | |
3377 exclusive tags will turn off any other tags from that group. | |
3378 @kindex @key{TAB} | |
3379 @item @key{TAB} | |
3380 Enter a tag in the minibuffer, even if the tag is not in the predefined | |
3381 list. You will be able to complete on all tags present in the buffer. | |
3382 @kindex @key{SPC} | |
3383 @item @key{SPC} | |
3384 Clear all tags for this line. | |
3385 @kindex @key{RET} | |
3386 @item @key{RET} | |
3387 Accept the modified set. | |
3388 @item C-g | |
3389 Abort without installing changes. | |
3390 @item q | |
3391 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}. | |
3392 @item ! | |
3393 Turn off groups of mutually exclusive tags. Use this to (as an | |
3394 exception) assign several tags from such a group. | |
3395 @item C-c | |
3396 Toggle auto-exit after the next change (see below). | |
3397 If you are using expert mode, the first @kbd{C-c} will display the | |
3398 selection window. | |
3399 @end table | |
3400 | |
3401 @noindent | |
3402 This method lets you assign tags to a headline with very few keys. With | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3403 the above setup, you could clear the current tags and set @samp{@@home}, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3404 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3405 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3406 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or |
84308 | 3407 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag |
3408 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h | |
3409 @key{RET} @key{RET}}. | |
3410 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3411 If you find that most of the time, you need only a single key press to |
84308 | 3412 modify your list of tags, set the variable |
3413 @code{org-fast-tag-selection-single-key}. Then you no longer have to | |
3414 press @key{RET} to exit fast tag selection - it will immediately exit | |
3415 after the first change. If you then occasionally need more keys, press | |
3416 @kbd{C-c} to turn off auto-exit for the current tag selection process | |
3417 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c | |
3418 C-c}). If you set the variable to the value @code{expert}, the special | |
3419 window is not even shown for single-key tag selection, it comes up only | |
3420 when you press an extra @kbd{C-c}. | |
3421 | |
3422 @node Tag searches, , Setting tags, Tags | |
3423 @section Tag searches | |
3424 @cindex tag searches | |
3425 @cindex searching for tags | |
3426 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3427 Once a system of tags has been set up, it can be used to collect related |
84308 | 3428 information into special lists. |
3429 | |
3430 @table @kbd | |
3431 @kindex C-c \ | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3432 @kindex C-c / T |
84308 | 3433 @item C-c \ |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3434 @itemx C-c / T |
84308 | 3435 Create a sparse tree with all headlines matching a tags search. With a |
3436 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line. | |
3437 @kindex C-c a m | |
3438 @item C-c a m | |
3439 Create a global list of tag matches from all agenda files. | |
3440 @xref{Matching tags and properties}. | |
3441 @kindex C-c a M | |
3442 @item C-c a M | |
3443 Create a global list of tag matches from all agenda files, but check | |
3444 only TODO items and force checking subitems (see variable | |
3445 @code{org-tags-match-list-sublevels}). | |
3446 @end table | |
3447 | |
3448 @cindex Boolean logic, for tag searches | |
3449 A @i{tags} search string can use Boolean operators @samp{&} for AND and | |
3450 @samp{|} for OR. @samp{&} binds more strongly than @samp{|}. | |
3451 Parenthesis are currently not implemented. A tag may also be preceded | |
3452 by @samp{-}, to select against it, and @samp{+} is syntactic sugar for | |
3453 positive selection. The AND operator @samp{&} is optional when @samp{+} | |
3454 or @samp{-} is present. Examples: | |
3455 | |
3456 @table @samp | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3457 @item +work-boss |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3458 Select headlines tagged @samp{:work:}, but discard those also tagged |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3459 @samp{:boss:}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3460 @item work|laptop |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3461 Selects lines tagged @samp{:work:} or @samp{:laptop:}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3462 @item work|laptop&night |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3463 Like before, but require the @samp{:laptop:} lines to be tagged also |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3464 @samp{:night:}. |
84308 | 3465 @end table |
3466 | |
3467 @cindex TODO keyword matching, with tags search | |
3468 If you are using multi-state TODO keywords (@pxref{TODO extensions}), it | |
3469 can be useful to also match on the TODO keyword. This can be done by | |
3470 adding a condition after a slash to a tags match. The syntax is similar | |
3471 to the tag matches, but should be applied with consideration: For | |
3472 example, a positive selection on several TODO keywords can not | |
3473 meaningfully be combined with boolean AND. However, @emph{negative | |
3474 selection} combined with AND can be meaningful. To make sure that only | |
3475 lines are checked that actually have any TODO keyword, use @kbd{C-c a | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3476 M}, or equivalently start the TODO part after the slash with @samp{!}. |
84308 | 3477 Examples: |
3478 | |
3479 @table @samp | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3480 @item work/WAITING |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3481 Select @samp{:work:}-tagged TODO lines with the specific TODO |
84308 | 3482 keyword @samp{WAITING}. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3483 @item work/!-WAITING-NEXT |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3484 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING} |
84308 | 3485 nor @samp{NEXT} |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3486 @item work/+WAITING|+NEXT |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3487 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or |
84308 | 3488 @samp{NEXT}. |
3489 @end table | |
3490 | |
3491 @cindex regular expressions, with tags search | |
3492 Any element of the tag/todo match can be a regular expression - in this | |
3493 case it must be enclosed in curly braces. For example, | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3494 @samp{work+@{^boss.*@}} matches headlines that contain the tag |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3495 @samp{:work:} and any tag @i{starting} with @samp{boss}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3496 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3497 @cindex level, require for tags/property match |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3498 @cindex category, require for tags/property match |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3499 You can also require a headline to be of a certain level or category, by |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3500 writing instead of any TAG an expression like @samp{LEVEL=3} or |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3501 @samp{CATEGORY="work"}, respectively. For example, a search |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3502 @samp{+LEVEL=3+boss/-DONE} lists all level three headlines that have the |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3503 tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3504 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3505 @node Properties and Columns, Dates and Times, Tags, Top |
84308 | 3506 @chapter Properties and Columns |
3507 @cindex properties | |
3508 | |
3509 Properties are a set of key-value pairs associated with an entry. There | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3510 are two main applications for properties in Org mode. First, properties |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3511 are like tags, but with a value. Second, you can use properties to |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3512 implement (very basic) database capabilities in an Org buffer. For |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3513 an example of the first application, imagine maintaining a file where |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3514 you document bugs and plan releases of a piece of software. Instead of |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3515 using tags like @code{:release_1:}, @code{:release_2:}, one can use a |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3516 property, say @code{:Release:}, that in different subtrees has different |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3517 values, such as @code{1.0} or @code{2.0}. For an example of the second |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3518 application of properties, imagine keeping track of your music CD's, |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3519 where properties could be things such as the album artist, date of |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3520 release, number of tracks, and so on. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3521 |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3522 Properties can be conveniently edited and viewed in column view |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3523 (@pxref{Column view}). |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3524 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3525 Properties are like tags, but with a value. For example, in a file |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3526 where you document bugs and plan releases of a piece of software, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3527 instead of using tags like @code{:release_1:}, @code{:release_2:}, it |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3528 can be more efficient to use a property @code{:Release:} with a value |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3529 @code{1.0} or @code{2.0}. Second, you can use properties to implement |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3530 (very basic) database capabilities in an Org buffer, for example to |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3531 create a list of Music CD's you own. You can edit and view properties |
84308 | 3532 conveniently in column view (@pxref{Column view}). |
3533 | |
3534 @menu | |
3535 * Property syntax:: How properties are spelled out | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3536 * Special properties:: Access to other Org mode features |
84308 | 3537 * Property searches:: Matching property values |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3538 * Property inheritance:: Passing values down the tree |
84308 | 3539 * Column view:: Tabular viewing and editing |
3540 * Property API:: Properties for Lisp programmers | |
3541 @end menu | |
3542 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3543 @node Property syntax, Special properties, Properties and Columns, Properties and Columns |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3544 @section Property syntax |
84308 | 3545 @cindex property syntax |
3546 @cindex drawer, for properties | |
3547 | |
3548 Properties are key-value pairs. They need to be inserted into a special | |
3549 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property | |
3550 is specified on a single line, with the key (surrounded by colons) | |
3551 first, and the value after it. Here is an example: | |
3552 | |
3553 @example | |
3554 * CD collection | |
3555 ** Classic | |
3556 *** Goldberg Variations | |
3557 :PROPERTIES: | |
3558 :Title: Goldberg Variations | |
3559 :Composer: J.S. Bach | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3560 :Artist: Glen Gould |
84308 | 3561 :Publisher: Deutsche Grammphon |
3562 :NDisks: 1 | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3563 :END: |
84308 | 3564 @end example |
3565 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3566 You may define the allowed values for a particular property @samp{:Xyz:} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3567 by setting a property @samp{:Xyz_ALL:}. This special property is |
84308 | 3568 @emph{inherited}, so if you set it in a level 1 entry, it will apply to |
3569 the entire tree. When allowed values are defined, setting the | |
3570 corresponding property becomes easier and is less prone to typing | |
3571 errors. For the example with the CD collection, we can predefine | |
3572 publishers and the number of disks in a box like this: | |
3573 | |
3574 @example | |
3575 * CD collection | |
3576 :PROPERTIES: | |
3577 :NDisks_ALL: 1 2 3 4 | |
3578 :Publisher_ALL: "Deutsche Grammophon" Phillips EMI | |
3579 :END: | |
3580 @end example | |
3581 | |
3582 If you want to set properties that can be inherited by any entry in a | |
3583 file, use a line like | |
3584 | |
3585 @example | |
3586 #+PROPERTY: NDisks_ALL 1 2 3 4 | |
3587 @end example | |
3588 | |
3589 Property values set with the global variable | |
3590 @code{org-global-properties} can be inherited by all entries in all | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3591 Org files. |
84308 | 3592 |
3593 @noindent | |
3594 The following commands help to work with properties: | |
3595 | |
3596 @table @kbd | |
3597 @kindex M-@key{TAB} | |
3598 @item M-@key{TAB} | |
3599 After an initial colon in a line, complete property keys. All keys used | |
3600 in the current file will be offered as possible completions. | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3601 @kindex C-c C-x p |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3602 @item C-c C-x p |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3603 Set a property. This prompts for a property name and a value. If |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3604 necessary, the property drawer is created as well. |
84308 | 3605 @item M-x org-insert-property-drawer |
3606 Insert a property drawer into the current entry. The drawer will be | |
3607 inserted early in the entry, but after the lines with planning | |
3608 information like deadlines. | |
3609 @kindex C-c C-c | |
3610 @item C-c C-c | |
3611 With the cursor in a property drawer, this executes property commands. | |
3612 @item C-c C-c s | |
3613 Set a property in the current entry. Both the property and the value | |
3614 can be inserted using completion. | |
3615 @kindex S-@key{right} | |
3616 @kindex S-@key{left} | |
3617 @item S-@key{left}/@key{right} | |
3618 Switch property at point to the next/previous allowed value. | |
3619 @item C-c C-c d | |
3620 Remove a property from the current entry. | |
3621 @item C-c C-c D | |
3622 Globally remove a property, from all entries in the current file. | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3623 @item C-c C-c c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3624 Compute the property at point, using the operator and scope from the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3625 nearest column format definition. |
84308 | 3626 @end table |
3627 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3628 @node Special properties, Property searches, Property syntax, Properties and Columns |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3629 @section Special properties |
84308 | 3630 @cindex properties, special |
3631 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3632 Special properties provide alternative access method to Org mode |
84308 | 3633 features discussed in the previous chapters, like the TODO state or the |
3634 priority of an entry. This interface exists so that you can include | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3635 these states into columns view (@pxref{Column view}), or to use them in |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3636 queries. The following property names are special and should not be |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3637 used as keys in the properties drawer: |
84308 | 3638 |
3639 @example | |
3640 TODO @r{The TODO keyword of the entry.} | |
3641 TAGS @r{The tags defined directly in the headline.} | |
3642 ALLTAGS @r{All tags, including inherited ones.} | |
3643 PRIORITY @r{The priority of the entry, a string with a single letter.} | |
3644 DEADLINE @r{The deadline time string, without the angular brackets.} | |
3645 SCHEDULED @r{The scheduling time stamp, without the angular brackets.} | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3646 TIMESTAMP @r{The first keyword-less time stamp in the entry.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3647 TIMESTAMP_IA @r{The first inactive time stamp in the entry.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3648 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3649 @r{must be run first to compute the values.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3650 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3651 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3652 @node Property searches, Property inheritance, Special properties, Properties and Columns |
84308 | 3653 @section Property searches |
3654 @cindex properties, searching | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3655 @cindex searching, of properties |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3656 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3657 To create sparse trees and special lists with selection based on properties, |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3658 the same commands are used as for tag searches (@pxref{Tag searches}), and |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3659 the same logic applies. For example, here is a search string: |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3660 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3661 @example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3662 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2+With=@{Sarah\|Denny@} |
84308 | 3663 @end example |
3664 | |
3665 @noindent | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3666 If the comparison value is a plain number, a numerical comparison is done, |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3667 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=}, |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3668 @samp{>=}, and @samp{<>}. If the comparison value is enclosed in double |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3669 quotes, a string comparison is done, and the same operators are allowed. If |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3670 the comparison value is enclosed in curly braces, a regexp match is |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3671 performed, with @samp{=} meaning that the regexp matches the property value, |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3672 and @samp{<>} meaning that it does not match. So the search string in the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3673 example finds entries tagged @samp{:work:} but not @samp{:boss:}, which also |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3674 have a priority value @samp{A}, a @samp{:Coffee:} property with the value |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3675 @samp{unlimited}, an @samp{Effort} property that is numerically smaller than |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3676 2, and a @samp{:With:} property that is matched by the regular expression |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3677 @samp{Sarah\|Denny}. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3678 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3679 You can configure Org mode to use property inheritance during a search, but |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3680 beware that this can slow down searches considerably. See @ref{Property |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3681 inheritance} for details. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3682 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3683 There is also a special command for creating sparse trees based on a |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3684 single property: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3685 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3686 @table @kbd |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3687 @kindex C-c / p |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3688 @item C-c / p |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3689 Create a sparse tree based on the value of a property. This first |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3690 prompts for the name of a property, and then for a value. A sparse tree |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3691 is created with all entries that define this property with the given |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3692 value. If you enclose the value into curly braces, it is interpreted as |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3693 a regular expression and matched against the property values. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3694 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3695 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3696 @node Property inheritance, Column view, Property searches, Properties and Columns |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3697 @section Property Inheritance |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3698 @cindex properties, inheritance |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3699 @cindex inheritance, of properties |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3700 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3701 The outline structure of Org mode documents lends itself for an |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3702 inheritance model of properties: If the parent in a tree has a certain |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3703 property, the children can inherit this property. Org mode does not |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3704 turn this on by default, because it can slow down property searches |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3705 significantly and is often not needed. However, if you find inheritance |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3706 useful, you can turn it on by setting the variable |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3707 @code{org-use-property-inheritance}. It may be set to @code{t}, to make |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3708 all properties inherited from the parent, to a list of properties |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3709 that should be inherited, or to a regular expression that matches |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3710 inherited properties. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3711 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3712 Org mode has a few properties for which inheritance is hard-coded, at |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3713 least for the special applications for which they are used: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3714 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3715 @table @code |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3716 @item COLUMNS |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3717 The @code{:COLUMNS:} property defines the format of column view |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3718 (@pxref{Column view}). It is inherited in the sense that the level |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3719 where a @code{:COLUMNS:} property is defined is used as the starting |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3720 point for a column view table, independently of the location in the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3721 subtree from where columns view is turned on. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3722 @item CATEGORY |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3723 For agenda view, a category set through a @code{:CATEGORY:} property |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3724 applies to the entire subtree. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3725 @item ARCHIVE |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3726 For archiving, the @code{:ARCHIVE:} property may define the archive |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3727 location for the entire subtree (@pxref{Moving subtrees}). |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3728 @item LOGGING |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3729 The LOGGING property may define logging settings for an entry or a |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3730 subtree (@pxref{Tracking TODO state changes}). |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3731 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3732 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3733 @node Column view, Property API, Property inheritance, Properties and Columns |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3734 @section Column view |
84308 | 3735 |
3736 A great way to view and edit properties in an outline tree is | |
3737 @emph{column view}. In column view, each outline item is turned into a | |
3738 table row. Columns in this table provide access to properties of the | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3739 entries. Org mode implements columns by overlaying a tabular structure |
84308 | 3740 over the headline of each item. While the headlines have been turned |
3741 into a table row, you can still change the visibility of the outline | |
3742 tree. For example, you get a compact table by switching to CONTENTS | |
3743 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view | |
3744 is active), but you can still open, read, and edit the entry below each | |
3745 headline. Or, you can switch to column view after executing a sparse | |
3746 tree command and in this way get a table only for the selected items. | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3747 Column view also works in agenda buffers (@pxref{Agenda Views}) where |
84308 | 3748 queries have collected selected items, possibly from a number of files. |
3749 | |
3750 @menu | |
3751 * Defining columns:: The COLUMNS format property | |
3752 * Using column view:: How to create and use column view | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3753 * Capturing column view:: A dynamic block for column view |
84308 | 3754 @end menu |
3755 | |
3756 @node Defining columns, Using column view, Column view, Column view | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3757 @subsection Defining columns |
84308 | 3758 @cindex column view, for properties |
3759 @cindex properties, column view | |
3760 | |
3761 Setting up a column view first requires defining the columns. This is | |
3762 done by defining a column format line. | |
3763 | |
3764 @menu | |
3765 * Scope of column definitions:: Where defined, where valid? | |
3766 * Column attributes:: Appearance and content of a column | |
3767 @end menu | |
3768 | |
3769 @node Scope of column definitions, Column attributes, Defining columns, Defining columns | |
3770 @subsubsection Scope of column definitions | |
3771 | |
3772 To define a column format for an entire file, use a line like | |
3773 | |
3774 @example | |
3775 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO | |
3776 @end example | |
3777 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3778 To specify a format that only applies to a specific tree, add a |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3779 @code{:COLUMNS:} property to the top node of that tree, for example: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3780 |
84308 | 3781 @example |
3782 ** Top node for columns view | |
3783 :PROPERTIES: | |
3784 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO | |
3785 :END: | |
3786 @end example | |
3787 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3788 If a @code{:COLUMNS:} property is present in an entry, it defines columns |
84308 | 3789 for the entry itself, and for the entire subtree below it. Since the |
3790 column definition is part of the hierarchical structure of the document, | |
3791 you can define columns on level 1 that are general enough for all | |
3792 sublevels, and more specific columns further down, when you edit a | |
3793 deeper part of the tree. | |
3794 | |
3795 @node Column attributes, , Scope of column definitions, Defining columns | |
3796 @subsubsection Column attributes | |
3797 A column definition sets the attributes of a column. The general | |
3798 definition looks like this: | |
3799 | |
3800 @example | |
3801 %[width]property[(title)][@{summary-type@}] | |
3802 @end example | |
3803 | |
3804 @noindent | |
3805 Except for the percent sign and the property name, all items are | |
3806 optional. The individual parts have the following meaning: | |
3807 | |
3808 @example | |
3809 width @r{An integer specifying the width of the column in characters.} | |
3810 @r{If omitted, the width will be determined automatically.} | |
3811 property @r{The property that should be edited in this column.} | |
3812 (title) @r{The header text for the column. If omitted, the} | |
3813 @r{property name is used.} | |
3814 @{summary-type@} @r{The summary type. If specified, the column values for} | |
3815 @r{parent nodes are computed from the children.} | |
3816 @r{Supported summary types are:} | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3817 @{+@} @r{Sum numbers in this column.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3818 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3819 @{$@} @r{Currency, short for @samp{+;%.2f}.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3820 @{:@} @r{Sum times, HH:MM:SS, plain numbers are hours.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3821 @{X@} @r{Checkbox status, [X] if all children are [X].} |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3822 @{X/@} @r{Checkbox status, [n/m].} |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3823 @{X%@} @r{Checkbox status, [n%].} |
84308 | 3824 @end example |
3825 | |
3826 @noindent | |
3827 Here is an example for a complete columns definition, along with allowed | |
3828 values. | |
3829 | |
3830 @example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3831 :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.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3832 %10Time_Estimate@{:@} %CLOCKSUM |
84308 | 3833 :Owner_ALL: Tammy Mark Karl Lisa Don |
3834 :Status_ALL: "In progress" "Not started yet" "Finished" "" | |
3835 :Approved_ALL: "[ ]" "[X]" | |
3836 @end example | |
3837 | |
3838 The first column, @samp{%25ITEM}, means the first 25 characters of the | |
3839 item itself, i.e. of the headline. You probably always should start the | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3840 column definition with the @samp{ITEM} specifier. The other specifiers |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3841 create columns @samp{Owner} with a list of names as allowed values, for |
84308 | 3842 @samp{Status} with four different possible values, and for a checkbox |
3843 field @samp{Approved}. When no width is given after the @samp{%} | |
3844 character, the column will be exactly as wide as it needs to be in order | |
3845 to fully display all values. The @samp{Approved} column does have a | |
3846 modified title (@samp{Approved?}, with a question mark). Summaries will | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3847 be created for the @samp{Time_Estimate} column by adding time duration |
84308 | 3848 expressions like HH:MM, and for the @samp{Approved} column, by providing |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3849 an @samp{[X]} status if all children have been checked. The |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3850 @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3851 in the subtree. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3852 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3853 @node Using column view, Capturing column view, Defining columns, Column view |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3854 @subsection Using column view |
84308 | 3855 |
3856 @table @kbd | |
3857 @tsubheading{Turning column view on and off} | |
3858 @kindex C-c C-x C-c | |
3859 @item C-c C-x C-c | |
3860 Create the column view for the local environment. This command searches | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3861 the hierarchy, up from point, for a @code{:COLUMNS:} property that defines |
84308 | 3862 a format. When one is found, the column view table is established for |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3863 the entire tree, starting from the entry that contains the @code{:COLUMNS:} |
84308 | 3864 property. If none is found, the format is taken from the @code{#+COLUMNS} |
3865 line or from the variable @code{org-columns-default-format}, and column | |
3866 view is established for the current entry and its subtree. | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3867 @kindex r |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3868 @item r |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3869 Recreate the column view, to include recent changes made in the buffer. |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3870 @kindex g |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3871 @item g |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3872 Same as @kbd{r}. |
84308 | 3873 @kindex q |
3874 @item q | |
3875 Exit column view. | |
3876 @tsubheading{Editing values} | |
3877 @item @key{left} @key{right} @key{up} @key{down} | |
3878 Move through the column view from field to field. | |
3879 @kindex S-@key{left} | |
3880 @kindex S-@key{right} | |
3881 @item S-@key{left}/@key{right} | |
3882 Switch to the next/previous allowed value of the field. For this, you | |
3883 have to have specified allowed values for a property. | |
3884 @kindex n | |
3885 @kindex p | |
3886 @itemx n / p | |
3887 Same as @kbd{S-@key{left}/@key{right}} | |
3888 @kindex e | |
3889 @item e | |
3890 Edit the property at point. For the special properties, this will | |
3891 invoke the same interface that you normally use to change that | |
3892 property. For example, when editing a TAGS property, the tag completion | |
3893 or fast selection interface will pop up. | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3894 @kindex C-c C-c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3895 @item C-c C-c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3896 When there is a checkbox at point, toggle it. |
84308 | 3897 @kindex v |
3898 @item v | |
3899 View the full value of this property. This is useful if the width of | |
3900 the column is smaller than that of the value. | |
3901 @kindex a | |
3902 @item a | |
3903 Edit the list of allowed values for this property. If the list is found | |
3904 in the hierarchy, the modified values is stored there. If no list is | |
3905 found, the new value is stored in the first entry that is part of the | |
3906 current column view. | |
3907 @tsubheading{Modifying the table structure} | |
3908 @kindex < | |
3909 @kindex > | |
3910 @item < / > | |
3911 Make the column narrower/wider by one character. | |
3912 @kindex S-M-@key{right} | |
3913 @item S-M-@key{right} | |
3914 Insert a new column, to the right of the current column. | |
3915 @kindex S-M-@key{left} | |
3916 @item S-M-@key{left} | |
3917 Delete the current column. | |
3918 @end table | |
3919 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3920 @node Capturing column view, , Using column view, Column view |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3921 @subsection Capturing column view |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3922 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3923 Since column view is just an overlay over a buffer, it cannot be |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3924 exported or printed directly. If you want to capture a column view, use |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3925 this @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3926 of this block looks like this: |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3927 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3928 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3929 * The column view |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3930 #+BEGIN: columnview :hlines 1 :id "label" |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3931 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3932 #+END: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3933 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3934 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3935 @noindent This dynamic block has the following parameters: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3936 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3937 @table @code |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3938 @item :id |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3939 This is most important parameter. Column view is a feature that is |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3940 often localized to a certain (sub)tree, and the capture block might be |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3941 in a different location in the file. To identify the tree whose view to |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3942 capture, you can use 3 values: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3943 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3944 local @r{use the tree in which the capture block is located} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3945 global @r{make a global view, including all headings in the file} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3946 "label" @r{call column view in the tree that has and @code{:ID:}} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3947 @r{property with the value @i{label}} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3948 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3949 @item :hlines |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3950 When @code{t}, insert a hline after every line. When a number N, insert |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3951 a hline before each headline with level @code{<= N}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3952 @item :vlines |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3953 When set to @code{t}, enforce column groups to get vertical lines. |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3954 @item :maxlevel |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3955 When set to a number, don't capture entries below this level. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3956 @item :skip-empty-rows |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3957 When set to @code{t}, skip row where the only non-empty specifier of the |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3958 column view is @code{ITEM}. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3959 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3960 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3961 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3962 @noindent |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3963 The following commands insert or update the dynamic block: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3964 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3965 @table @kbd |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3966 @kindex C-c C-x r |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3967 @item C-c C-x r |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3968 Insert a dynamic block capturing a column view. You will be prompted |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3969 for the scope or id of the view. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3970 @kindex C-c C-c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3971 @item C-c C-c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3972 @kindex C-c C-x C-u |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3973 @itemx C-c C-x C-u |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3974 Update dynamical block at point. The cursor needs to be in the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3975 @code{#+BEGIN} line of the dynamic block. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3976 @kindex C-u C-c C-x C-u |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3977 @item C-u C-c C-x C-u |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3978 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3979 you have several clock table blocks in a buffer. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3980 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3981 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3982 @node Property API, , Column view, Properties and Columns |
84308 | 3983 @section The Property API |
3984 @cindex properties, API | |
3985 @cindex API, for properties | |
3986 | |
3987 There is a full API for accessing and changing properties. This API can | |
3988 be used by Emacs Lisp programs to work with properties and to implement | |
3989 features based on them. For more information see @ref{Using the | |
3990 property API}. | |
3991 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3992 @node Dates and Times, Remember, Properties and Columns, Top |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3993 @chapter Dates and Times |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3994 @cindex dates |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3995 @cindex times |
84308 | 3996 @cindex time stamps |
3997 @cindex date stamps | |
3998 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3999 To assist project planning, TODO items can be labeled with a date and/or |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4000 a time. The specially formatted string carrying the date and time |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4001 information is called a @emph{timestamp} in Org mode. This may be a |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4002 little confusing because timestamp is often used as indicating when |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4003 something was created or last changed. However, in Org mode this term |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4004 is used in a much wider sense. |
84308 | 4005 |
4006 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4007 * Timestamps:: Assigning a time to a tree entry |
84308 | 4008 * Creating timestamps:: Commands which insert timestamps |
4009 * Deadlines and scheduling:: Planning your work | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4010 * Clocking work time:: Tracking how long you spend on a task |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4011 * Effort estimates:: Planning work effort in advance |
84308 | 4012 @end menu |
4013 | |
4014 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4015 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4016 @section Timestamps, deadlines and scheduling |
84308 | 4017 @cindex time stamps |
4018 @cindex ranges, time | |
4019 @cindex date stamps | |
4020 @cindex deadlines | |
4021 @cindex scheduling | |
4022 | |
4023 A time stamp is a specification of a date (possibly with time or a range | |
4024 of times) in a special format, either @samp{<2003-09-16 Tue>} or | |
4025 @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4026 12:00-12:30>}@footnote{This is the standard ISO date/time format. To |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4027 use an alternative format, see @ref{Custom time format}.}. A time stamp |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4028 can appear anywhere in the headline or body of an Org tree entry. Its |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4029 presence causes entries to be shown on specific dates in the agenda |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4030 (@pxref{Weekly/daily agenda}). We distinguish: |
84308 | 4031 |
4032 @table @var | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4033 @item Plain time stamp; Event; Appointment |
84308 | 4034 @cindex timestamp |
4035 A simple time stamp just assigns a date/time to an item. This is just | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4036 like writing down an appointment or event in a paper agenda. In the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4037 timeline and agenda displays, the headline of an entry associated with a |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4038 plain time stamp will be shown exactly on that date. |
84308 | 4039 |
4040 @example | |
4041 * Meet Peter at the movies <2006-11-01 Wed 19:15> | |
4042 * Discussion on climate change <2006-11-02 Thu 20:00-22:00> | |
4043 @end example | |
4044 | |
4045 @item Time stamp with repeater interval | |
4046 @cindex timestamp, with repeater interval | |
4047 A time stamp may contain a @emph{repeater interval}, indicating that it | |
4048 applies not only on the given date, but again and again after a certain | |
4049 interval of N days (d), weeks (w), months(m), or years(y). The | |
4050 following will show up in the agenda every Wednesday: | |
4051 | |
4052 @example | |
4053 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w> | |
4054 @end example | |
4055 | |
4056 @item Diary-style sexp entries | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4057 For more complex date specifications, Org mode supports using the |
84308 | 4058 special sexp diary entries implemented in the Emacs calendar/diary |
4059 package. For example | |
4060 | |
4061 @example | |
4062 * The nerd meeting on every 2nd Thursday of the month | |
4063 <%%(diary-float t 4 2)> | |
4064 @end example | |
4065 | |
4066 @item Time/Date range | |
4067 @cindex timerange | |
4068 @cindex date range | |
4069 Two time stamps connected by @samp{--} denote a range. The headline | |
4070 will be shown on the first and last day of the range, and on any dates | |
4071 that are displayed and fall in the range. Here is an example: | |
4072 | |
4073 @example | |
4074 ** Meeting in Amsterdam | |
4075 <2004-08-23 Mon>--<2004-08-26 Thu> | |
4076 @end example | |
4077 | |
4078 @item Inactive time stamp | |
4079 @cindex timestamp, inactive | |
4080 @cindex inactive timestamp | |
4081 Just like a plain time stamp, but with square brackets instead of | |
4082 angular ones. These time stamps are inactive in the sense that they do | |
4083 @emph{not} trigger an entry to show up in the agenda. | |
4084 | |
4085 @example | |
4086 * Gillian comes late for the fifth time [2006-11-01 Wed] | |
4087 @end example | |
4088 | |
4089 @end table | |
4090 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4091 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times |
84308 | 4092 @section Creating timestamps |
4093 @cindex creating timestamps | |
4094 @cindex timestamps, creating | |
4095 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4096 For Org mode to recognize time stamps, they need to be in the specific |
84308 | 4097 format. All commands listed below produce time stamps in the correct |
4098 format. | |
4099 | |
4100 @table @kbd | |
4101 @kindex C-c . | |
4102 @item C-c . | |
4103 Prompt for a date and insert a corresponding time stamp. When the | |
4104 cursor is at a previously used time stamp, it is updated to NOW. When | |
4105 this command is used twice in succession, a time range is inserted. | |
4106 @c | |
4107 @kindex C-u C-c . | |
4108 @item C-u C-c . | |
4109 Like @kbd{C-c .}, but use the alternative format which contains date | |
4110 and time. The default time can be rounded to multiples of 5 minutes, | |
4111 see the option @code{org-time-stamp-rounding-minutes}. | |
4112 @c | |
4113 @kindex C-c ! | |
4114 @item C-c ! | |
4115 Like @kbd{C-c .}, but insert an inactive time stamp that will not cause | |
4116 an agenda entry. | |
4117 @c | |
4118 @kindex C-c < | |
4119 @item C-c < | |
4120 Insert a time stamp corresponding to the cursor date in the Calendar. | |
4121 @c | |
4122 @kindex C-c > | |
4123 @item C-c > | |
4124 Access the Emacs calendar for the current date. If there is a | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4125 timestamp in the current line, go to the corresponding date |
84308 | 4126 instead. |
4127 @c | |
4128 @kindex C-c C-o | |
4129 @item C-c C-o | |
4130 Access the agenda for the date given by the time stamp or -range at | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4131 point (@pxref{Weekly/daily agenda}). |
84308 | 4132 @c |
4133 @kindex S-@key{left} | |
4134 @kindex S-@key{right} | |
4135 @item S-@key{left} | |
4136 @itemx S-@key{right} | |
4137 Change date at cursor by one day. These key bindings conflict with | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4138 CUA mode (@pxref{Conflicts}). |
84308 | 4139 @c |
4140 @kindex S-@key{up} | |
4141 @kindex S-@key{down} | |
4142 @item S-@key{up} | |
4143 @itemx S-@key{down} | |
4144 Change the item under the cursor in a timestamp. The cursor can be on a | |
4145 year, month, day, hour or minute. Note that if the cursor is in a | |
4146 headline and not at a time stamp, these same keys modify the priority of | |
4147 an item. (@pxref{Priorities}). The key bindings also conflict with | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4148 CUA mode (@pxref{Conflicts}). |
84308 | 4149 @c |
4150 @kindex C-c C-y | |
4151 @cindex evaluate time range | |
4152 @item C-c C-y | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4153 Evaluate a time range by computing the difference between start and end. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4154 With a prefix argument, insert result after the time range (in a table: into |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4155 the following column). |
84308 | 4156 @end table |
4157 | |
4158 | |
4159 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4160 * The date/time prompt:: How Org mode helps you entering date and time |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4161 * Custom time format:: Making dates look different |
84308 | 4162 @end menu |
4163 | |
4164 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps | |
4165 @subsection The date/time prompt | |
4166 @cindex date, reading in minibuffer | |
4167 @cindex time, reading in minibuffer | |
4168 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4169 When Org mode prompts for a date/time, the default is shown as an ISO |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4170 date, and the prompt therefore seems to ask for an ISO date. But it |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4171 will in fact accept any string containing some date and/or time |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4172 information, and it is really smart about interpreting your input. You |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4173 can, for example, use @kbd{C-y} to paste a (possibly multi-line) string |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4174 copied from an email message. Org mode will find whatever information |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4175 is in there and derive anything you have not specified from the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4176 @emph{default date and time}. The default is usually the current date |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4177 and time, but when modifying an existing time stamp, or when entering |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4178 the second stamp of a range, it is taken from the stamp in the buffer. |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4179 When filling in information, Org mode assumes that most of the time you |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4180 will want to enter a date in the future: If you omit the month/year and |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4181 the given day/month is @i{before} today, it will assume that you mean a |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4182 future date@footnote{See the variable |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4183 @code{org-read-date-prefer-future}.}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4184 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4185 For example, lets assume that today is @b{June 13, 2006}. Here is how |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4186 various inputs will be interpreted, the items filled in by Org mode are |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4187 in @b{bold}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4188 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4189 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4190 3-2-5 --> 2003-02-05 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4191 14 --> @b{2006}-@b{06}-14 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4192 12 --> @b{2006}-@b{07}-12 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4193 Fri --> nearest Friday (defaultdate or later) |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4194 sep 15 --> @b{2006}-11-15 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4195 feb 15 --> @b{2007}-02-15 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4196 sep 12 9 --> 2009-09-12 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4197 12:45 --> @b{2006}-@b{06}-@b{13} 12:45 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4198 22 sept 0:34 --> @b{2006}-09-22 0:34 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4199 w4 --> ISO week for of the current year @b{2006} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4200 2012 w4 fri --> Friday of ISO week 4 in 2012 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4201 2012-w04-5 --> Same as above |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4202 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4203 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4204 Furthermore you can specify a relative date by giving, as the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4205 @emph{first} thing in the input: a plus/minus sign, a number and a |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4206 letter [dwmy] to indicate change in days weeks, months, years. With a |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4207 single plus or minus, the date is always relative to today. With a |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4208 double plus or minus, it is relative to the default date. If instead of |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4209 a single letter, you use the abbreviation of day name, the date will be |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4210 the nth such day. E.g. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4211 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4212 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4213 +4d --> four days from today |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4214 +4 --> same as above |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4215 +2w --> two weeks from today |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4216 ++5 --> five days from default date |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4217 +2tue --> second tuesday from now. |
84308 | 4218 @end example |
4219 | |
4220 The function understands English month and weekday abbreviations. If | |
4221 you want to use unabbreviated names and/or other languages, configure | |
4222 the variables @code{parse-time-months} and @code{parse-time-weekdays}. | |
4223 | |
4224 @cindex calendar, for selecting date | |
4225 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If | |
4226 you don't need/want the calendar, configure the variable | |
4227 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date | |
4228 prompt, either by clicking on a date in the calendar, or by pressing | |
4229 @key{RET}, the date selected in the calendar will be combined with the | |
4230 information entered at the prompt. You can control the calendar fully | |
4231 from the minibuffer: | |
4232 | |
4233 @kindex < | |
4234 @kindex > | |
4235 @kindex mouse-1 | |
4236 @kindex S-@key{right} | |
4237 @kindex S-@key{left} | |
4238 @kindex S-@key{down} | |
4239 @kindex S-@key{up} | |
4240 @kindex M-S-@key{right} | |
4241 @kindex M-S-@key{left} | |
4242 @kindex @key{RET} | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4243 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4244 > / < @r{Scroll calendar forward/backward by one month.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4245 mouse-1 @r{Select date by clicking on it.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4246 S-@key{right}/@key{left} @r{One day forward/backward.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4247 S-@key{down}/@key{up} @r{One week forward/backward.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4248 M-S-@key{right}/@key{left} @r{One month forward/backward.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4249 @key{RET} @r{Choose date in calendar.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4250 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4251 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4252 The actions of the date/time prompt may seem complex, but I assure you they |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4253 will grow on you, and you will start getting annoyed by pretty much any other |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4254 way of entering a date/time out there. To help you understand what is going |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4255 on, the current interpretation of your input will be displayed live in the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4256 minibuffer@footnote{If you find this distracting, turn the display of with |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4257 @code{org-read-date-display-live}.}. |
84308 | 4258 |
4259 @node Custom time format, , The date/time prompt, Creating timestamps | |
4260 @subsection Custom time format | |
4261 @cindex custom date/time format | |
4262 @cindex time format, custom | |
4263 @cindex date format, custom | |
4264 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4265 Org mode uses the standard ISO notation for dates and times as it is |
84308 | 4266 defined in ISO 8601. If you cannot get used to this and require another |
4267 representation of date and time to keep you happy, you can get it by | |
4268 customizing the variables @code{org-display-custom-times} and | |
4269 @code{org-time-stamp-custom-formats}. | |
4270 | |
4271 @table @kbd | |
4272 @kindex C-c C-x C-t | |
4273 @item C-c C-x C-t | |
4274 Toggle the display of custom formats for dates and times. | |
4275 @end table | |
4276 | |
4277 @noindent | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4278 Org mode needs the default format for scanning, so the custom date/time |
84308 | 4279 format does not @emph{replace} the default format - instead it is put |
4280 @emph{over} the default format using text properties. This has the | |
4281 following consequences: | |
4282 @itemize @bullet | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4283 @item |
84308 | 4284 You cannot place the cursor onto a time stamp anymore, only before or |
4285 after. | |
4286 @item | |
4287 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust | |
4288 each component of a time stamp. If the cursor is at the beginning of | |
4289 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day, | |
4290 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the | |
4291 time will be changed by one minute. | |
4292 @item | |
4293 If the time stamp contains a range of clock times or a repeater, these | |
4294 will not be overlayed, but remain in the buffer as they were. | |
4295 @item | |
4296 When you delete a time stamp character-by-character, it will only | |
4297 disappear from the buffer after @emph{all} (invisible) characters | |
4298 belonging to the ISO timestamp have been removed. | |
4299 @item | |
4300 If the custom time stamp format is longer than the default and you are | |
4301 using dates in tables, table alignment will be messed up. If the custom | |
4302 format is shorter, things do work as expected. | |
4303 @end itemize | |
4304 | |
4305 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4306 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4307 @section Deadlines and scheduling |
84308 | 4308 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4309 A time stamp may be preceded by special keywords to facilitate planning: |
84308 | 4310 |
4311 @table @var | |
4312 @item DEADLINE | |
4313 @cindex DEADLINE keyword | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4314 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4315 Meaning: the task (most likely a TODO item, though not necessarily) is supposed |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4316 to be finished on that date. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4317 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4318 On the deadline date, the task will be listed in the agenda. In |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4319 addition, the agenda for @emph{today} will carry a warning about the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4320 approaching or missed deadline, starting |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4321 @code{org-deadline-warning-days} before the due date, and continuing |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4322 until the entry is marked DONE. An example: |
84308 | 4323 |
4324 @example | |
4325 *** TODO write article about the Earth for the Guide | |
4326 The editor in charge is [[bbdb:Ford Prefect]] | |
4327 DEADLINE: <2004-02-29 Sun> | |
4328 @end example | |
4329 | |
4330 You can specify a different lead time for warnings for a specific | |
4331 deadlines using the following syntax. Here is an example with a warning | |
4332 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}. | |
4333 | |
4334 @item SCHEDULED | |
4335 @cindex SCHEDULED keyword | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4336 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4337 Meaning: you are planning to start working on that task on the given |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4338 date. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4339 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4340 The headline will be listed under the given date@footnote{It will still |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4341 be listed on that date after it has been marked DONE. If you don't like |
84308 | 4342 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In |
4343 addition, a reminder that the scheduled date has passed will be present | |
4344 in the compilation for @emph{today}, until the entry is marked DONE. | |
4345 I.e., the task will automatically be forwarded until completed. | |
4346 | |
4347 @example | |
4348 *** TODO Call Trillian for a date on New Years Eve. | |
4349 SCHEDULED: <2004-12-25 Sat> | |
4350 @end example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4351 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4352 @noindent |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4353 @b{Important:} Scheduling an item in Org mode should @i{not} be |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4354 understood in the same way that we understand @i{scheduling a meeting}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4355 Setting a date for a meeting is just a simple appointment, you should |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4356 mark this entry with a simple plain time stamp, to get this item shown |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4357 on the date where it applies. This is a frequent mis-understanding from |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4358 Org-users. In Org mode, @i{scheduling} means setting a date when you |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4359 want to start working on an action item. |
84308 | 4360 @end table |
4361 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4362 You may use time stamps with repeaters in scheduling and deadline |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4363 entries. Org mode will issue early and late warnings based on the |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4364 assumption that the time stamp represents the @i{nearest instance} of |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4365 the repeater. However, the use of diary sexp entries like |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4366 @c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4367 @code{<%%(diary-float t 42)>} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4368 @c |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4369 in scheduling and deadline timestamps is limited. Org mode does not |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4370 know enough about the internals of each sexp function to issue early and |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4371 late warnings. However, it will show the item on each day where the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4372 sexp entry matches. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4373 |
84308 | 4374 @menu |
4375 * Inserting deadline/schedule:: Planning items | |
4376 * Repeated tasks:: Items that show up again and again | |
4377 @end menu | |
4378 | |
4379 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4380 @subsection Inserting deadlines or schedules |
84308 | 4381 |
4382 The following commands allow to quickly insert a deadline or to schedule | |
4383 an item: | |
4384 | |
4385 @table @kbd | |
4386 @c | |
4387 @kindex C-c C-d | |
4388 @item C-c C-d | |
4389 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4390 happen in the line directly following the headline. When called with a |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4391 prefix arg, an existing deadline will be removed from the entry. |
84308 | 4392 @c FIXME Any CLOSED timestamp will be removed.???????? |
4393 @c | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4394 @kindex C-c / d |
84308 | 4395 @cindex sparse tree, for deadlines |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4396 @item C-c / d |
84308 | 4397 Create a sparse tree with all deadlines that are either past-due, or |
4398 which will become due within @code{org-deadline-warning-days}. | |
4399 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4400 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows |
84308 | 4401 all deadlines due tomorrow. |
4402 @c | |
4403 @kindex C-c C-s | |
4404 @item C-c C-s | |
4405 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will | |
4406 happen in the line directly following the headline. Any CLOSED | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4407 timestamp will be removed. When called with a prefix argument, remove |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4408 the scheduling date from the entry. |
84308 | 4409 @end table |
4410 | |
4411 @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4412 @subsection Repeated tasks |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4413 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4414 Some tasks need to be repeated again and again. Org mode helps to |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4415 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED, |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4416 or plain time stamp. In the following example |
84308 | 4417 @example |
4418 ** TODO Pay the rent | |
4419 DEADLINE: <2005-10-01 Sat +1m> | |
4420 @end example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4421 the @code{+1m} is a repeater; the intended interpretation is that the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4422 task has a deadline on <2005-10-01> and repeats itself every (one) month |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4423 starting from that time. If you need both a repeater and a special |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4424 warning period in a deadline entry, the repeater comes first and the |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4425 warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}. |
84308 | 4426 |
4427 Deadlines and scheduled items produce entries in the agenda when they | |
4428 are over-due, so it is important to be able to mark such an entry as | |
4429 completed once you have done so. When you mark a DEADLINE or a SCHEDULE | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4430 with the TODO keyword DONE, it will no longer produce entries in the |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4431 agenda. The problem with this is, however, that then also the |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4432 @emph{next} instance of the repeated entry will not be active. Org mode |
84308 | 4433 deals with this in the following way: When you try to mark such an entry |
4434 DONE (using @kbd{C-c C-t}), it will shift the base date of the repeating | |
4435 time stamp by the repeater interval, and immediately set the entry state | |
4436 back to TODO. In the example above, setting the state to DONE would | |
4437 actually switch the date like this: | |
4438 | |
4439 @example | |
4440 ** TODO Pay the rent | |
4441 DEADLINE: <2005-11-01 Tue +1m> | |
4442 @end example | |
4443 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4444 A timestamp@footnote{You can change this using the option |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4445 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat}, |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4446 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4447 will aslo be prompted for a note.} will be added under the deadline, to keep |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4448 a record that you actually acted on the previous instance of this deadline. |
84308 | 4449 |
4450 As a consequence of shifting the base date, this entry will no longer be | |
4451 visible in the agenda when checking past dates, but all future instances | |
4452 will be visible. | |
4453 | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4454 With the @samp{+1m} cookie, the date shift will always be exactly one |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4455 month. So if you have not payed the rent for three months, marking this |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4456 entry DONE will still keep it as an overdue deadline. Depending on the |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4457 task, this may not be the best way to handle it. For example, if you |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4458 forgot to call you father for 3 weeks, it does not make sense to call |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4459 him 3 times in a single day to make up for it. Finally, there are tasks |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4460 like changing batteries which should always repeat a certain time |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4461 @i{after} the last time you did it. For these tasks, Org mode has |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4462 special repeaters markers with @samp{++} and @samp{.+}. For example: |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4463 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4464 @example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4465 ** TODO Call Father |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4466 DEADLINE: <2008-02-10 Sun ++1w> |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4467 Marking this DONE will shift the date by at least one week, |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4468 but also by as many weeks as it takes to get this date into |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4469 the future. However, it stays on a Sunday, even if you called |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4470 and marked it done on Saturday. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4471 ** TODO Check the batteries in the smoke detectors |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4472 DEADLINE: <2005-11-01 Tue .+1m> |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4473 Marking this DONE will shift the date to one month after |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4474 today. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4475 @end example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4476 |
84308 | 4477 You may have both scheduling and deadline information for a specific |
4478 task - just make sure that the repeater intervals on both are the same. | |
4479 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4480 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4481 @section Clocking work time |
84308 | 4482 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4483 Org mode allows you to clock the time you spent on specific tasks in a |
84308 | 4484 project. When you start working on an item, you can start the clock. |
4485 When you stop working on that task, or when you mark the task done, the | |
4486 clock is stopped and the corresponding time interval is recorded. It | |
4487 also computes the total time spent on each subtree of a project. | |
4488 | |
4489 @table @kbd | |
4490 @kindex C-c C-x C-i | |
4491 @item C-c C-x C-i | |
4492 Start the clock on the current item (clock-in). This inserts the CLOCK | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4493 keyword together with a timestamp. If this is not the first clocking of |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4494 this item, the multiple CLOCK lines will be wrapped into a |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4495 @code{:CLOCK:} drawer (see also the variable |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4496 @code{org-clock-into-drawer}). When called with a @kbd{C-u} prefix argument, |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4497 select the task from a list of recently clocked tasks. With two @kbd{C-u |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4498 C-u} prefixes, clock into the task at point and mark it as the default task. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4499 The default task will always be available when selecting a clocking task, |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4500 with letter @kbd{d}. |
84308 | 4501 @kindex C-c C-x C-o |
4502 @item C-c C-x C-o | |
4503 Stop the clock (clock-out). The inserts another timestamp at the same | |
4504 location where the clock was last started. It also directly computes | |
4505 the resulting time in inserts it after the time range as @samp{=> | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4506 HH:MM}. See the variable @code{org-log-note-clock-out} for the |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4507 possibility to record an additional note together with the clock-out |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4508 time stamp@footnote{The corresponding in-buffer setting is: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4509 @code{#+STARTUP: lognoteclock-out}}. |
84308 | 4510 @kindex C-c C-y |
4511 @item C-c C-y | |
4512 Recompute the time interval after changing one of the time stamps. This | |
4513 is only necessary if you edit the time stamps directly. If you change | |
4514 them with @kbd{S-@key{cursor}} keys, the update is automatic. | |
4515 @kindex C-c C-t | |
4516 @item C-c C-t | |
4517 Changing the TODO state of an item to DONE automatically stops the clock | |
4518 if it is running in this same item. | |
4519 @kindex C-c C-x C-x | |
4520 @item C-c C-x C-x | |
4521 Cancel the current clock. This is useful if a clock was started by | |
4522 mistake, or if you ended up working on something else. | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4523 @kindex C-c C-x C-j |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4524 @item C-c C-x C-j |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4525 Jump to the entry that contains the currently running clock. With a |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4526 @kbd{C-u} prefix arg, select the target task from a list of recently clocked |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4527 tasks. |
84308 | 4528 @kindex C-c C-x C-d |
4529 @item C-c C-x C-d | |
4530 Display time summaries for each subtree in the current buffer. This | |
4531 puts overlays at the end of each headline, showing the total time | |
4532 recorded under that heading, including the time of any subheadings. You | |
4533 can use visibility cycling to study the tree, but the overlays disappear | |
4534 when you change the buffer (see variable | |
4535 @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}. | |
4536 @kindex C-c C-x C-r | |
4537 @item C-c C-x C-r | |
4538 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4539 report as an Org mode table into the current file. When the cursor is |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4540 at an existing clock table, just update it. When called with a prefix |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4541 argument, jump to the first clock report in the current document and |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4542 update it. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4543 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4544 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file |
84308 | 4545 #+END: clocktable |
4546 @end example | |
4547 @noindent | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4548 If such a block already exists at point, its content is replaced by the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4549 new table. The @samp{BEGIN} line can specify options: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4550 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4551 :maxlevel @r{Maximum level depth to which times are listed in the table.} |
84308 | 4552 :emphasize @r{When @code{t}, emphasize level one and level two items} |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4553 :scope @r{The scope to consider. This can be any of the following:} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4554 nil @r{the current buffer or narrowed region} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4555 file @r{the full current buffer} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4556 subtree @r{the subtree where the clocktable is located} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4557 treeN @r{the surrounding level N tree, for example @code{tree3}} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4558 tree @r{the surrounding level 1 tree} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4559 agenda @r{all agenda files} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4560 ("file"..) @r{scan these files} |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4561 file-with-archives @r{current file and its archives} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4562 agenda-with-archives @r{all agenda files, including archives} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4563 :block @r{The time block to consider. This block is specified either} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4564 @r{absolute, or relative to the current time and may be any of} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4565 @r{these formats:} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4566 2007-12-31 @r{New year eve 2007} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4567 2007-12 @r{December 2007} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4568 2007-W50 @r{ISO-week 50 in 2007} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4569 2007 @r{the year 2007} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4570 today, yesterday, today-N @r{a relative day} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4571 thisweek, lastweek, thisweek-N @r{a relative week} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4572 thismonth, lastmonth, thismonth-N @r{a relative month} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4573 thisyear, lastyear, thisyear-N @r{a relative year} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4574 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.} |
84308 | 4575 :tstart @r{A time string specifying when to start considering times} |
4576 :tend @r{A time string specifying when to stop considering times} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4577 :step @r{@code{week} or @code{day}, to split the table into chunks.} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4578 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.} |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4579 :link @r{Link the item headlines in the table to their origins} |
84308 | 4580 @end example |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4581 So to get a clock summary of the current level 1 tree, for the current |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4582 day, you could write |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4583 @example |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4584 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t |
84308 | 4585 #+END: clocktable |
4586 @end example | |
4587 and to use a specific time range you could write@footnote{Note that all | |
4588 parameters must be specified in a single line - the line is broken here | |
4589 only to fit it onto the manual.} | |
4590 @example | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4591 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>" |
84308 | 4592 :tend "<2006-08-10 Thu 12:00>" |
4593 #+END: clocktable | |
4594 @end example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4595 @kindex C-c C-c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4596 @item C-c C-c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4597 @kindex C-c C-x C-u |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4598 @itemx C-c C-x C-u |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4599 Update dynamical block at point. The cursor needs to be in the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4600 @code{#+BEGIN} line of the dynamic block. |
84308 | 4601 @kindex C-u C-c C-x C-u |
4602 @item C-u C-c C-x C-u | |
4603 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4604 you have several clock table blocks in a buffer. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4605 @kindex S-@key{left} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4606 @kindex S-@key{right} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4607 @item S-@key{left} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4608 @itemx S-@key{right} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4609 Shift the current @code{:block} interval and update the table. The cursor |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4610 needs to be in the @code{#+BEGIN: clocktable} line for this command. If |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4611 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc. |
84308 | 4612 @end table |
4613 | |
4614 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4615 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been |
84308 | 4616 worked on or closed during a day. |
4617 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4618 @node Effort estimates |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4619 @section Effort estimates |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4620 @cindex Effort estimates |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4621 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4622 If you want to plan your work in a very detailed way, or if you need to |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4623 produce offers with quotations of the estimated work effort, you may want to |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4624 assign effort estimates to entries. If you are also clocking your work, you |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4625 may later want to compare the planned effort with the actual working time, a |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4626 great way to improve planning estimates. Effort estimates are stored in a |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4627 special property @samp{Effort}@footnote{You may change the property being |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4628 used with the variable @code{org-effort-property}.}. Clearly the best way to |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4629 work with effort estimates is through column view (@pxref{Column view}). You |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4630 should start by setting up discrete values for effort estimates, and a |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4631 @code{COLUMNS} format that displays these values together with clock sums (if |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4632 you want to clock your time). For a specific buffer you can use |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4633 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4634 @example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4635 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4636 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4637 @end example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4638 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4639 @noindent |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4640 or you can set up these values globally by customizing the variables |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4641 @code{org-global-properties} and @code{org-columns-default-format}. In |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4642 particular if you want to use this setup also in the agenda, a global setup |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4643 may be advised. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4644 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4645 The way to assign estimates to individual items is then to switch to column |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4646 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4647 value. The values you enter will immediately be summed up in the hierarchy. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4648 In the column next to it, any clocked time will be displayed. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4649 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4650 If you switch to column view in the daily/weekly agenda, the effort column |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4651 will summarize the estimated work effort for each day@footnote{Please note |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4652 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4653 column view}.}, and you can use this to find space in your schedule. To get |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4654 an overview of the entire part of the day that is committed, you can set the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4655 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4656 appointments on a day that take place over a specified time interval will |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4657 then also be added to the load estimate of the day. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4658 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4659 @node Remember, Agenda Views, Dates and Times, Top |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4660 @chapter Remember |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4661 @cindex @file{remember.el} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4662 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4663 The @i{Remember} package by John Wiegley lets you store quick notes with |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4664 little interruption of your work flow. See |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4665 @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4666 information. It is an excellent way to add new notes and tasks to |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4667 Org files. Org significantly expands the possibilities of |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4668 @i{remember}: You may define templates for different note types, and |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4669 associate target files and headlines with specific templates. It also |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4670 allows you to select the location where a note should be stored |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4671 interactively, on the fly. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4672 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4673 @menu |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4674 * Setting up Remember:: Some code for .emacs to get things going |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4675 * Remember templates:: Define the outline of different note types |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4676 * Storing notes:: Directly get the note to where it belongs |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4677 * Refiling notes:: Moving a note or task to a project |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4678 @end menu |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4679 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4680 @node Setting up Remember, Remember templates, Remember, Remember |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4681 @section Setting up Remember |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4682 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4683 The following customization will tell @i{remember} to use org files as |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4684 target, and to create annotations compatible with Org links. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4685 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4686 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4687 (org-remember-insinuate) |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4688 (setq org-directory "~/path/to/my/orgfiles/") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4689 (setq org-default-notes-file (concat org-directory "/notes.org")) |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4690 (define-key global-map "\C-cr" 'org-remember) |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4691 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4692 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4693 The last line binds the command @code{org-remember} to a global |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4694 key@footnote{Please select your own key, @kbd{C-c r} is only a |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4695 suggestion.}. @code{org-remember} basically just calls @code{remember}, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4696 but it makes a few things easier: If there is an active region, it will |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4697 automatically copy the region into the remember buffer. It also allows |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4698 to jump to the buffer and location where remember notes are being |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4699 stored: Just call @code{org-remember} with a prefix argument. If you |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4700 use two prefix arguments, Org jumps to the location where the last |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4701 remember note was stored. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4702 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4703 @node Remember templates, Storing notes, Setting up Remember, Remember |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4704 @section Remember templates |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4705 @cindex templates, for remember |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4706 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4707 In combination with Org, you can use templates to generate |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4708 different types of @i{remember} notes. For example, if you would like |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4709 to use one template to create general TODO entries, another one for |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4710 journal entries, and a third one for collecting random ideas, you could |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4711 use: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4712 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4713 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4714 (setq org-remember-templates |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4715 '(("Todo" ?t "* TODO %?\n %i\n %a" "~/org/TODO.org" "Tasks") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4716 ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4717 ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas"))) |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4718 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4719 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4720 @noindent In these entries, the first string is just a name, and the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4721 character specifies how to select the template. It is useful if the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4722 character is also the first letter of the name. The next string |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4723 specifies the template. Two more (optional) strings give the file in |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4724 which, and the headline under which the new note should be stored. The |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4725 file (if not present or @code{nil}) defaults to |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4726 @code{org-default-notes-file}, the heading to |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4727 @code{org-remember-default-headline}. If the file name is not an |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4728 absolute path, it will be interpreted relative to @code{org-directory}. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4729 |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4730 An optional sixth element specifies the contexts in which the user can |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4731 select the template. This element can be either a list of major modes |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4732 or a function. @code{org-remember} will first check whether the function |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4733 returns @code{t} or if we are in any of the listed major mode, and select |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4734 the template accordingly. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4735 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4736 So for example: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4737 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4738 @example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4739 (setq org-remember-templates |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4740 '(("Bug" ?b "* BUG %?\n %i\n %a" "~/org/BUGS.org" "Bugs" (emacs-lisp-mode)) |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4741 ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org" my-check) |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4742 ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas"))) |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4743 @end example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4744 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4745 The first template will only be available when invoking @code{org-remember} |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4746 from an buffer in @code{emacs-lisp-mode}. The second template will only be |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4747 available when the function @code{my-check} returns @code{t}. The third |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4748 template will be proposed in any context. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4749 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4750 When you call @kbd{M-x remember} (or @kbd{M-x org-remember}) to remember |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4751 something, org will prompt for a key to select the template (if you have |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4752 more than one template) and then prepare the buffer like |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4753 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4754 * TODO |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4755 [[file:link to where you called remember]] |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4756 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4757 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4758 @noindent |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4759 During expansion of the template, special @kbd{%}-escapes allow dynamic |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4760 insertion of content: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4761 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4762 %^@{prompt@} @r{prompt the user for a string and replace this sequence with it.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4763 @r{You may specify a default value and a completion table with} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4764 @r{%^@{prompt|default|completion2|completion3...@}} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4765 @r{The arrow keys access a prompt-specific history.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4766 %t @r{time stamp, date only} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4767 %T @r{time stamp with date and time} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4768 %u, %U @r{like the above, but inactive time stamps} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4769 %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4770 @r{You may define a prompt like @code{%^@{Birthday@}t}} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4771 %n @r{user name (taken from @code{user-full-name})} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4772 %a @r{annotation, normally the link created with @code{org-store-link}} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4773 %A @r{like @code{%a}, but prompt for the description part} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4774 %i @r{initial content, the region when remember is called with C-u.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4775 @r{The entire text will be indented like @code{%i} itself.} |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4776 %c @r{Current kill ring head.} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4777 %x @r{Content of the X clipboard.} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4778 %^C @r{Interactive selection of which kill or clip to use.} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4779 %^L @r{Like @code{%^C}, but insert as link.} |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4780 %^g @r{prompt for tags, with completion on tags in target file.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4781 %^G @r{prompt for tags, with completion all tags in all agenda files.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4782 %:keyword @r{specific information for certain link types, see below} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4783 %[pathname] @r{insert the contents of the file given by @code{pathname}} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4784 %(sexp) @r{evaluate elisp @code{(sexp)} and replace with the result} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4785 %! @r{immediately store note after completing the template} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4786 @r{(skipping the @kbd{C-c C-c} that normally triggers storing)} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4787 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4788 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4789 @noindent |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4790 For specific link types, the following keywords will be |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4791 defined@footnote{If you define your own link types (@pxref{Adding |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4792 hyperlink types}), any property you store with |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4793 @code{org-store-link-props} can be accessed in remember templates in a |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4794 similar way.}: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4795 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4796 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4797 Link type | Available keywords |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4798 -------------------+---------------------------------------------- |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4799 bbdb | %:name %:company |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4800 bbdb | %::server %:port %:nick |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4801 vm, wl, mh, rmail | %:type %:subject %:message-id |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4802 | %:from %:fromname %:fromaddress |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4803 | %:to %:toname %:toaddress |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4804 | %: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}.}} |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4805 gnus | %:group, @r{for messages also all email fields} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4806 w3, w3m | %:url |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4807 info | %:file %:node |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4808 calendar | %:date" |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4809 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4810 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4811 @noindent |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4812 To place the cursor after template expansion use: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4813 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4814 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4815 %? @r{After completing the template, position cursor here.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4816 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4817 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4818 @noindent |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4819 If you change your mind about which template to use, call |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4820 @code{org-remember} in the remember buffer. You may then select a new |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4821 template that will be filled with the previous context information. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4822 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4823 @node Storing notes, Refiling notes, Remember templates, Remember |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4824 @section Storing notes |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4825 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4826 When you are finished preparing a note with @i{remember}, you have to |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4827 press @kbd{C-c C-c} to file the note away. The handler will store the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4828 note in the file and under the headline specified in the template, or it |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4829 will use the default file and headlines. The window configuration will |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4830 be restored, sending you back to the working context before the call to |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4831 @code{remember}. To re-use the location found during the last call to |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4832 @code{remember}, exit the remember buffer with @kbd{C-u C-u C-c C-c}, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4833 i.e. specify a double prefix argument to @kbd{C-c C-c}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4834 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4835 If you want to store the note directly to a different place, use |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4836 @kbd{C-u C-c C-c} instead to exit remember@footnote{Configure the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4837 variable @code{org-remember-store-without-prompt} to make this behavior |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4838 the default.}. The handler will then first prompt for a target file - |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4839 if you press @key{RET}, the value specified for the template is used. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4840 Then the command offers the headings tree of the selected file, with the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4841 cursor position at the default headline (if you had specified one in the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4842 template). You can either immediately press @key{RET} to get the note |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4843 placed there. Or you can use the following keys to find a different |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4844 location: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4845 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4846 @key{TAB} @r{Cycle visibility.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4847 @key{down} / @key{up} @r{Next/previous visible headline.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4848 n / p @r{Next/previous visible headline.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4849 f / b @r{Next/previous headline same level.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4850 u @r{One level up.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4851 @c 0-9 @r{Digit argument.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4852 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4853 @noindent |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4854 Pressing @key{RET} or @key{left} or @key{right} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4855 then leads to the following result. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4856 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4857 @multitable @columnfractions 0.2 0.15 0.65 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4858 @item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4859 @item on headline @tab @key{RET} @tab as sublevel of the heading at cursor, first or last |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4860 @item @tab @tab depending on @code{org-reverse-note-order}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4861 @item @tab @key{left}/@key{right} @tab as same level, before/after current heading |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4862 @item buffer-start @tab @key{RET} @tab as level 2 heading at end of file or level 1 at beginning |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4863 @item @tab @tab depending on @code{org-reverse-note-order}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4864 @item not on headline @tab @key{RET} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4865 @tab at cursor position, level taken from context. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4866 @end multitable |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4867 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4868 Before inserting the text into a tree, the function ensures that the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4869 text has a headline, i.e. a first line that starts with a @samp{*}. If |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4870 not, a headline is constructed from the current date and some additional |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4871 data. If you have indented the text of the note below the headline, the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4872 indentation will be adapted if inserting the note into the tree requires |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4873 demotion from level 1. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4874 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4875 @node Refiling notes, , Storing notes, Remember |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4876 @section Refiling notes |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4877 @cindex refiling notes |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4878 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4879 Remember is usually used to quickly capture notes and tasks into one or |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4880 a few capture lists. When reviewing the captured data, you may want to |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4881 refile some of the entries into a different list, for example into a |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4882 project. Cutting, finding the right location and then pasting the note |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4883 is cumbersome. To simplify this process, you can use the following |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4884 special command: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4885 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4886 @table @kbd |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4887 @kindex C-c C-w |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4888 @item C-c C-w |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4889 Refile the entry at point. This command offers possible locations for |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4890 refiling the entry and lets you select one with completion. The item is |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4891 filed below the target heading as a subitem. Depending on |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4892 @code{org-reverse-note-order}, it will be either the first of last |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4893 subitem.@* By default, all level 1 headlines in the current buffer are |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4894 considered to be targets, but you can have more complex definitions |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4895 across a number of files. See the variable @code{org-refile-targets} |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4896 for details. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4897 @kindex C-u C-c C-w |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4898 @item C-u C-c C-w |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4899 Use the refile interface to jump to a heading. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4900 @kindex C-u C-u C-c C-w |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4901 @item C-u C-u C-c C-w |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4902 Jump to the location where @code{org-refile} last moved a tree to. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4903 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4904 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4905 @node Agenda Views, Embedded LaTeX, Remember, Top |
84308 | 4906 @chapter Agenda Views |
4907 @cindex agenda views | |
4908 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4909 Due to the way Org works, TODO items, time-stamped items, and |
84308 | 4910 tagged headlines can be scattered throughout a file or even a number of |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4911 files. To get an overview of open action items, or of events that are |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4912 important for a particular date, this information must be collected, |
84308 | 4913 sorted and displayed in an organized way. |
4914 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4915 Org can select items based on various criteria, and display them |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4916 in a separate buffer. Seven different view types are provided: |
84308 | 4917 |
4918 @itemize @bullet | |
4919 @item | |
4920 an @emph{agenda} that is like a calendar and shows information | |
4921 for specific dates, | |
4922 @item | |
4923 a @emph{TODO list} that covers all unfinished | |
4924 action items, | |
4925 @item | |
4926 a @emph{tags view}, showings headlines based on | |
4927 the tags associated with them, | |
4928 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4929 a @emph{timeline view} that shows all events in a single Org file, |
84308 | 4930 in time-sorted view, |
4931 @item | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4932 a @emph{keyword search view} that shows all entries from multiple files |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4933 that contain specified keywords. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4934 @item |
84308 | 4935 a @emph{stuck projects view} showing projects that currently don't move |
4936 along, and | |
4937 @item | |
4938 @emph{custom views} that are special tag/keyword searches and | |
4939 combinations of different views. | |
4940 @end itemize | |
4941 | |
4942 @noindent | |
4943 The extracted information is displayed in a special @emph{agenda | |
4944 buffer}. This buffer is read-only, but provides commands to visit the | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4945 corresponding locations in the original Org files, and even to |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4946 edit these files remotely. |
84308 | 4947 |
4948 Two variables control how the agenda buffer is displayed and whether the | |
4949 window configuration is restored when the agenda exits: | |
4950 @code{org-agenda-window-setup} and | |
4951 @code{org-agenda-restore-windows-after-quit}. | |
4952 | |
4953 @menu | |
4954 * Agenda files:: Files being searched for agenda information | |
4955 * Agenda dispatcher:: Keyboard access to agenda views | |
4956 * Built-in agenda views:: What is available out of the box? | |
4957 * Presentation and sorting:: How agenda items are prepared for display | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4958 * Agenda commands:: Remote editing of Org trees |
84308 | 4959 * Custom agenda views:: Defining special searches and views |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4960 * Agenda column view:: Using column view for collected entries |
84308 | 4961 @end menu |
4962 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4963 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views |
84308 | 4964 @section Agenda files |
4965 @cindex agenda files | |
4966 @cindex files for agenda | |
4967 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4968 The information to be shown is normally collected from all @emph{agenda |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4969 files}, the files listed in the variable |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4970 @code{org-agenda-files}@footnote{If the value of that variable is not a |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4971 list, but a single file name, then the list of agenda files will be |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4972 maintained in that external file.}. If a directory is part of this list, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4973 all files with the extension @file{.org} in this directory will be part |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4974 of the list. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4975 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4976 Thus even if you only work with a single Org file, this file should |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4977 be put into that list@footnote{When using the dispatcher, pressing |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4978 @kbd{<} before selecting a command will actually limit the command to |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4979 the current file, and ignore @code{org-agenda-files} until the next |
84308 | 4980 dispatcher command.}. You can customize @code{org-agenda-files}, but |
4981 the easiest way to maintain it is through the following commands | |
4982 | |
4983 @cindex files, adding to agenda list | |
4984 @table @kbd | |
4985 @kindex C-c [ | |
4986 @item C-c [ | |
4987 Add current file to the list of agenda files. The file is added to | |
4988 the front of the list. If it was already in the list, it is moved to | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4989 the front. With a prefix argument, file is added/moved to the end. |
84308 | 4990 @kindex C-c ] |
4991 @item C-c ] | |
4992 Remove current file from the list of agenda files. | |
4993 @kindex C-, | |
4994 @kindex C-' | |
4995 @item C-, | |
4996 @itemx C-' | |
4997 Cycle through agenda file list, visiting one file after the other. | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4998 @kindex M-x org-iswitchb |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4999 @item M-x org-iswitchb |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5000 Command to use an @code{iswitchb}-like interface to switch to and between Org |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5001 buffers. |
84308 | 5002 @end table |
5003 | |
5004 @noindent | |
5005 The Org menu contains the current list of files and can be used | |
5006 to visit any of them. | |
5007 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5008 If you would like to focus the agenda temporarily onto a file not in |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5009 this list, or onto just one file in the list or even only a subtree in a |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5010 file, this can be done in different ways. For a single agenda command, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5011 you may press @kbd{<} once or several times in the dispatcher |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5012 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5013 extended period, use the following commands: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5014 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5015 @table @kbd |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5016 @kindex C-c C-x < |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5017 @item C-c C-x < |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5018 Permanently restrict the agenda to the current subtree. When with a |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5019 prefix argument, or with the cursor before the first headline in a file, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5020 the agenda scope is set to the entire file. This restriction remains in |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5021 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5022 or @kbd{>} in the agenda dispatcher. If there is a window displaying an |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5023 agenda view, the new restriction takes effect immediately. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5024 @kindex C-c C-x < |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5025 @item C-c C-x < |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5026 Remove the permanent restriction created by @kbd{C-c C-x <}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5027 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5028 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5029 @noindent |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5030 When working with @file{Speedbar}, you can use the following commands in |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5031 the Speedbar frame: |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5032 @table @kbd |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5033 @kindex < |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5034 @item < @r{in the speedbar frame} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5035 Permanently restrict the agenda to the item at the cursor in the |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5036 Speedbar frame, either an Org file or a subtree in such a file. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5037 If there is a window displaying an agenda view, the new restriction takes |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5038 effect immediately. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5039 @kindex < |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5040 @item > @r{in the speedbar frame} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5041 Lift the restriction again. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5042 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5043 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5044 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views |
84308 | 5045 @section The agenda dispatcher |
5046 @cindex agenda dispatcher | |
5047 @cindex dispatching agenda commands | |
5048 The views are created through a dispatcher that should be bound to a | |
5049 global key, for example @kbd{C-c a} (@pxref{Installation}). In the | |
5050 following we will assume that @kbd{C-c a} is indeed how the dispatcher | |
5051 is accessed and list keyboard access to commands accordingly. After | |
5052 pressing @kbd{C-c a}, an additional letter is required to execute a | |
5053 command. The dispatcher offers the following default commands: | |
5054 @table @kbd | |
5055 @item a | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5056 Create the calendar-like agenda (@pxref{Weekly/daily agenda}). |
84308 | 5057 @item t @r{/} T |
5058 Create a list of all TODO items (@pxref{Global TODO list}). | |
5059 @item m @r{/} M | |
5060 Create a list of headlines matching a TAGS expression (@pxref{Matching | |
5061 tags and properties}). | |
5062 @item L | |
5063 Create the timeline view for the current buffer (@pxref{Timeline}). | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5064 @item s |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5065 Create a list of entries selected by a boolean expression of keywords |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5066 and/or regular expressions that must or must not occur in the entry. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5067 @item / |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5068 Search for a regular expression in all agenda files and additionally in |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5069 the files listed in @code{org-agenda-multi-occur-extra-files}. This |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5070 uses the Emacs command @code{multi-occur}. A prefix argument can be |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5071 used to specify the number of context lines for each match, default is |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5072 1. |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5073 @item # @r{/} ! |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5074 Create a list of stuck projects (@pxref{Stuck projects}). |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5075 @item < |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5076 Restrict an agenda command to the current buffer@footnote{For backward |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5077 compatibility, you can also press @kbd{1} to restrict to the current |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5078 buffer.}. After pressing @kbd{<}, you still need to press the character |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5079 selecting the command. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5080 @item < < |
84308 | 5081 If there is an active region, restrict the following agenda command to |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5082 the region. Otherwise, restrict it to the current subtree@footnote{For |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5083 backward compatibility, you can also press @kbd{0} to restrict to the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5084 current buffer.}. After pressing @kbd{< <}, you still need to press the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5085 character selecting the command. |
84308 | 5086 @end table |
5087 | |
5088 You can also define custom commands that will be accessible through the | |
5089 dispatcher, just like the default commands. This includes the | |
5090 possibility to create extended agenda buffers that contain several | |
5091 blocks together, for example the weekly agenda, the global TODO list and | |
5092 a number of special tags matches. @xref{Custom agenda views}. | |
5093 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5094 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views |
84308 | 5095 @section The built-in agenda views |
5096 | |
5097 In this section we describe the built-in views. | |
5098 | |
5099 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5100 * Weekly/daily agenda:: The calendar page with current tasks |
84308 | 5101 * Global TODO list:: All unfinished action items |
5102 * Matching tags and properties:: Structured information with fine-tuned search | |
5103 * Timeline:: Time-sorted view for single file | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5104 * Keyword search:: Finding entries by keyword |
84308 | 5105 * Stuck projects:: Find projects you need to review |
5106 @end menu | |
5107 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5108 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views |
84308 | 5109 @subsection The weekly/daily agenda |
5110 @cindex agenda | |
5111 @cindex weekly agenda | |
5112 @cindex daily agenda | |
5113 | |
5114 The purpose of the weekly/daily @emph{agenda} is to act like a page of a | |
5115 paper agenda, showing all the tasks for the current week or day. | |
5116 | |
5117 @table @kbd | |
5118 @cindex org-agenda, command | |
5119 @kindex C-c a a | |
5120 @item C-c a a | |
5121 Compile an agenda for the current week from a list of org files. The | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5122 agenda shows the entries for each day. With a numeric |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5123 prefix@footnote{For backward compatibility, the universal prefix |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5124 @kbd{C-u} causes all TODO entries to be listed before the agenda. This |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5125 feature is deprecated, use the dedicated TODO list, or a block agenda |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5126 instead.} (like @kbd{C-u 2 1 C-c a a}) you may set the number of days |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5127 to be displayed (see also the variable @code{org-agenda-ndays}) |
84308 | 5128 @end table |
5129 | |
5130 Remote editing from the agenda buffer means, for example, that you can | |
5131 change the dates of deadlines and appointments from the agenda buffer. | |
5132 The commands available in the Agenda buffer are listed in @ref{Agenda | |
5133 commands}. | |
5134 | |
5135 @subsubheading Calendar/Diary integration | |
5136 @cindex calendar integration | |
5137 @cindex diary integration | |
5138 | |
5139 Emacs contains the calendar and diary by Edward M. Reingold. The | |
5140 calendar displays a three-month calendar with holidays from different | |
5141 countries and cultures. The diary allows you to keep track of | |
5142 anniversaries, lunar phases, sunrise/set, recurrent appointments | |
5143 (weekly, monthly) and more. In this way, it is quite complementary to | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5144 Org. It can be very useful to combine output from Org with |
84308 | 5145 the diary. |
5146 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5147 In order to include entries from the Emacs diary into Org mode's |
84308 | 5148 agenda, you only need to customize the variable |
5149 | |
5150 @lisp | |
5151 (setq org-agenda-include-diary t) | |
5152 @end lisp | |
5153 | |
5154 @noindent After that, everything will happen automatically. All diary | |
5155 entries including holidays, anniversaries etc will be included in the | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5156 agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and |
84308 | 5157 @key{RET} can be used from the agenda buffer to jump to the diary |
5158 file in order to edit existing diary entries. The @kbd{i} command to | |
5159 insert new entries for the current date works in the agenda buffer, as | |
5160 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display | |
5161 Sunrise/Sunset times, show lunar phases and to convert to other | |
5162 calendars, respectively. @kbd{c} can be used to switch back and forth | |
5163 between calendar and agenda. | |
5164 | |
5165 If you are using the diary only for sexp entries and holidays, it is | |
5166 faster to not use the above setting, but instead to copy or even move | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5167 the entries into an Org file. Org mode evaluates diary-style sexp |
84308 | 5168 entries, and does it faster because there is no overhead for first |
5169 creating the diary display. Note that the sexp entries must start at | |
5170 the left margin, no white space is allowed before them. For example, | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5171 the following segment of an Org file will be processed and entries |
84308 | 5172 will be made in the agenda: |
5173 | |
5174 @example | |
5175 * Birthdays and similar stuff | |
5176 #+CATEGORY: Holiday | |
5177 %%(org-calendar-holiday) ; special function for holiday names | |
5178 #+CATEGORY: Ann | |
5179 %%(diary-anniversary 14 5 1956) Arthur Dent is %d years old | |
5180 %%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old | |
5181 @end example | |
5182 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5183 @subsubheading Appointment reminders |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5184 @cindex @file{appt.el} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5185 @cindex appointment reminders |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5186 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5187 Org can interact with Emacs appointments notification facility. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5188 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5189 To add all the appointments of your agenda files, use the command |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5190 @code{org-agenda-to-appt}. This commands also lets you filter through |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5191 the list of your appointments and add only those belonging to a specific |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5192 category or matching a regular expression. See the docstring for |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5193 details. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5194 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5195 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views |
84308 | 5196 @subsection The global TODO list |
5197 @cindex global TODO list | |
5198 @cindex TODO list, global | |
5199 | |
5200 The global TODO list contains all unfinished TODO items, formatted and | |
5201 collected into a single place. | |
5202 | |
5203 @table @kbd | |
5204 @kindex C-c a t | |
5205 @item C-c a t | |
5206 Show the global TODO list. This collects the TODO items from all | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5207 agenda files (@pxref{Agenda Views}) into a single buffer. The buffer is in |
84308 | 5208 @code{agenda-mode}, so there are commands to examine and manipulate |
5209 the TODO entries directly from that buffer (@pxref{Agenda commands}). | |
5210 @kindex C-c a T | |
5211 @item C-c a T | |
5212 @cindex TODO keyword matching | |
5213 Like the above, but allows selection of a specific TODO keyword. You | |
5214 can also do this by specifying a prefix argument to @kbd{C-c a t}. With | |
5215 a @kbd{C-u} prefix you are prompted for a keyword, and you may also | |
5216 specify several keywords by separating them with @samp{|} as boolean OR | |
5217 operator. With a numeric prefix, the Nth keyword in | |
5218 @code{org-todo-keywords} is selected. | |
5219 @kindex r | |
5220 The @kbd{r} key in the agenda buffer regenerates it, and you can give | |
5221 a prefix argument to this command to change the selected TODO keyword, | |
5222 for example @kbd{3 r}. If you often need a search for a specific | |
5223 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@* | |
5224 Matching specific TODO keywords can also be done as part of a tags | |
5225 search (@pxref{Tag searches}). | |
5226 @end table | |
5227 | |
5228 Remote editing of TODO items means that you can change the state of a | |
5229 TODO entry with a single key press. The commands available in the | |
5230 TODO list are described in @ref{Agenda commands}. | |
5231 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5232 @cindex sublevels, inclusion into TODO list |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5233 Normally the global TODO list simply shows all headlines with TODO |
84308 | 5234 keywords. This list can become very long. There are two ways to keep |
5235 it more compact: | |
5236 @itemize @minus | |
5237 @item | |
5238 Some people view a TODO item that has been @emph{scheduled} for | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5239 execution (@pxref{Timestamps}) as no longer @emph{open}. Configure the |
84308 | 5240 variable @code{org-agenda-todo-ignore-scheduled} to exclude scheduled |
5241 items from the global TODO list. | |
5242 @item | |
5243 TODO items may have sublevels to break up the task into subtasks. In | |
5244 such cases it may be enough to list only the highest level TODO headline | |
5245 and omit the sublevels from the global list. Configure the variable | |
5246 @code{org-agenda-todo-list-sublevels} to get this behavior. | |
5247 @end itemize | |
5248 | |
5249 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5250 @subsection Matching tags and properties |
84308 | 5251 @cindex matching, of tags |
5252 @cindex matching, of properties | |
5253 @cindex tags view | |
5254 | |
5255 If headlines in the agenda files are marked with @emph{tags} | |
5256 (@pxref{Tags}), you can select headlines based on the tags that apply | |
5257 to them and collect them into an agenda buffer. | |
5258 | |
5259 @table @kbd | |
5260 @kindex C-c a m | |
5261 @item C-c a m | |
5262 Produce a list of all headlines that match a given set of tags. The | |
5263 command prompts for a selection criterion, which is a boolean logic | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5264 expression with tags, like @samp{+work+urgent-withboss} or |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5265 @samp{work|home} (@pxref{Tags}). If you often need a specific search, |
84308 | 5266 define a custom command for it (@pxref{Agenda dispatcher}). |
5267 @kindex C-c a M | |
5268 @item C-c a M | |
5269 Like @kbd{C-c a m}, but only select headlines that are also TODO items | |
5270 and force checking subitems (see variable | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5271 @code{org-tags-match-list-sublevels}). Matching specific TODO keywords |
84308 | 5272 together with a tags match is also possible, see @ref{Tag searches}. |
5273 @end table | |
5274 | |
5275 The commands available in the tags list are described in @ref{Agenda | |
5276 commands}. | |
5277 | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5278 @node Timeline, Keyword search, Matching tags and properties, Built-in agenda views |
84308 | 5279 @subsection Timeline for a single file |
5280 @cindex timeline, single file | |
5281 @cindex time-sorted view | |
5282 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5283 The timeline summarizes all time-stamped items from a single Org mode |
84308 | 5284 file in a @emph{time-sorted view}. The main purpose of this command is |
5285 to give an overview over events in a project. | |
5286 | |
5287 @table @kbd | |
5288 @kindex C-c a L | |
5289 @item C-c a L | |
5290 Show a time-sorted view of the org file, with all time-stamped items. | |
5291 When called with a @kbd{C-u} prefix, all unfinished TODO entries | |
5292 (scheduled or not) are also listed under the current date. | |
5293 @end table | |
5294 | |
5295 @noindent | |
5296 The commands available in the timeline buffer are listed in | |
5297 @ref{Agenda commands}. | |
5298 | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5299 @node Keyword search, Stuck projects, Timeline, Built-in agenda views |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5300 @subsection Keyword search |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5301 @cindex keyword search |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5302 @cindex searching, for keywords |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5303 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5304 This agenda view is a general text search facility for Org mode entries. |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5305 It is particularly useful to find notes. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5306 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5307 @table @kbd |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5308 @kindex C-c a s |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5309 @item C-c a s |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5310 This is a special search that lets you select entries by keywords or |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5311 regular expression, using a boolean logic. For example, the search |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5312 string |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5313 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5314 @example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5315 +computer +wifi -ethernet -@{8\.11[bg]@} |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5316 @end example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5317 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5318 @noindent |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5319 will search for note entries that contain the keywords @code{computer} |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5320 and @code{wifi}, but not the keyword @code{ethernet}, and which are also |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5321 not matched by the regular expression @code{8\.11[bg]}, meaning to |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5322 exclude both 8.11b and 8.11g. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5323 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5324 Note that in addition to the agenda files, this command will also search |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5325 the files listed in @code{org-agenda-text-search-extra-files}. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5326 @end table |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5327 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5328 @node Stuck projects, , Keyword search, Built-in agenda views |
84308 | 5329 @subsection Stuck projects |
5330 | |
5331 If you are following a system like David Allen's GTD to organize your | |
5332 work, one of the ``duties'' you have is a regular review to make sure | |
5333 that all projects move along. A @emph{stuck} project is a project that | |
5334 has no defined next actions, so it will never show up in the TODO lists | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5335 Org mode produces. During the review, you need to identify such |
84308 | 5336 projects and define next actions for them. |
5337 | |
5338 @table @kbd | |
5339 @kindex C-c a # | |
5340 @item C-c a # | |
5341 List projects that are stuck. | |
5342 @kindex C-c a ! | |
5343 @item C-c a ! | |
5344 Customize the variable @code{org-stuck-projects} to define what a stuck | |
5345 project is and how to find it. | |
5346 @end table | |
5347 | |
5348 You almost certainly will have to configure this view before it will | |
5349 work for you. The built-in default assumes that all your projects are | |
5350 level-2 headlines, and that a project is not stuck if it has at least | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5351 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5352 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5353 Lets assume that you, in your own way of using Org mode, identify |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5354 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to |
84308 | 5355 indicate a project that should not be considered yet. Lets further |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5356 assume that the TODO keyword DONE marks finished projects, and that NEXT |
84308 | 5357 and TODO indicate next actions. The tag @@SHOP indicates shopping and |
5358 is a next action even without the NEXT tag. Finally, if the project | |
5359 contains the special word IGNORE anywhere, it should not be listed | |
5360 either. In this case you would start by identifying eligible projects | |
5361 with a tags/todo match @samp{+PROJECT/-MAYBE-DONE}, and then check for | |
5362 TODO, NEXT, @@SHOP, and IGNORE in the subtree to identify projects that | |
5363 are not stuck. The correct customization for this is | |
5364 | |
5365 @lisp | |
5366 (setq org-stuck-projects | |
5367 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP") | |
5368 "\\<IGNORE\\>")) | |
5369 @end lisp | |
5370 | |
5371 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5372 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views |
84308 | 5373 @section Presentation and sorting |
5374 @cindex presentation, of agenda items | |
5375 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5376 Before displaying items in an agenda view, Org mode visually prepares |
84308 | 5377 the items and sorts them. Each item occupies a single line. The line |
5378 starts with a @emph{prefix} that contains the @emph{category} | |
5379 (@pxref{Categories}) of the item and other important information. You can | |
5380 customize the prefix using the option @code{org-agenda-prefix-format}. | |
5381 The prefix is followed by a cleaned-up version of the outline headline | |
5382 associated with the item. | |
5383 | |
5384 @menu | |
5385 * Categories:: Not all tasks are equal | |
5386 * Time-of-day specifications:: How the agenda knows the time | |
5387 * Sorting of agenda items:: The order of things | |
5388 @end menu | |
5389 | |
5390 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting | |
5391 @subsection Categories | |
5392 | |
5393 @cindex category | |
5394 The category is a broad label assigned to each agenda item. By default, | |
5395 the category is simply derived from the file name, but you can also | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5396 specify it with a special line in the buffer, like this@footnote{For |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5397 backward compatibility, the following also works: If there are several |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5398 such lines in a file, each specifies the category for the text below it. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5399 The first category also applies to any text before the first CATEGORY |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5400 line. However, using this method is @emph{strongly} deprecated as it is |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5401 incompatible with the outline structure of the document. The correct |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5402 method for setting multiple categories in a buffer is using a |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5403 property.}: |
84308 | 5404 |
5405 @example | |
5406 #+CATEGORY: Thesis | |
5407 @end example | |
5408 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5409 @noindent |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5410 If you would like to have a special CATEGORY for a single entry or a |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5411 (sub)tree, give the entry a @code{:CATEGORY:} property with the location |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5412 as the value (@pxref{Properties and Columns}). |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5413 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5414 @noindent |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5415 The display in the agenda buffer looks best if the category is not |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5416 longer than 10 characters. |
84308 | 5417 |
5418 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5419 @subsection Time-of-day specifications |
84308 | 5420 @cindex time-of-day specification |
5421 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5422 Org mode checks each agenda item for a time-of-day specification. The |
84308 | 5423 time can be part of the time stamp that triggered inclusion into the |
5424 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time | |
5425 ranges can be specified with two time stamps, like | |
5426 @c | |
5427 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}. | |
5428 | |
5429 In the headline of the entry itself, a time(range) may also appear as | |
5430 plain text (like @samp{12:45} or a @samp{8:30-1pm}. If the agenda | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5431 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time |
84308 | 5432 specifications in diary entries are recognized as well. |
5433 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5434 For agenda display, Org mode extracts the time and displays it in a |
84308 | 5435 standard 24 hour format as part of the prefix. The example times in |
5436 the previous paragraphs would end up in the agenda like this: | |
5437 | |
5438 @example | |
5439 8:30-13:00 Arthur Dent lies in front of the bulldozer | |
5440 12:45...... Ford Prefect arrives and takes Arthur to the pub | |
5441 19:00...... The Vogon reads his poem | |
5442 20:30-22:15 Marwin escorts the Hitchhikers to the bridge | |
5443 @end example | |
5444 | |
5445 @cindex time grid | |
5446 If the agenda is in single-day mode, or for the display of today, the | |
5447 timed entries are embedded in a time grid, like | |
5448 | |
5449 @example | |
5450 8:00...... ------------------ | |
5451 8:30-13:00 Arthur Dent lies in front of the bulldozer | |
5452 10:00...... ------------------ | |
5453 12:00...... ------------------ | |
5454 12:45...... Ford Prefect arrives and takes Arthur to the pub | |
5455 14:00...... ------------------ | |
5456 16:00...... ------------------ | |
5457 18:00...... ------------------ | |
5458 19:00...... The Vogon reads his poem | |
5459 20:00...... ------------------ | |
5460 20:30-22:15 Marwin escorts the Hitchhikers to the bridge | |
5461 @end example | |
5462 | |
5463 The time grid can be turned on and off with the variable | |
5464 @code{org-agenda-use-time-grid}, and can be configured with | |
5465 @code{org-agenda-time-grid}. | |
5466 | |
5467 @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting | |
5468 @subsection Sorting of agenda items | |
5469 @cindex sorting, of agenda items | |
5470 @cindex priorities, of agenda items | |
5471 Before being inserted into a view, the items are sorted. How this is | |
5472 done depends on the type of view. | |
5473 @itemize @bullet | |
5474 @item | |
5475 For the daily/weekly agenda, the items for each day are sorted. The | |
5476 default order is to first collect all items containing an explicit | |
5477 time-of-day specification. These entries will be shown at the beginning | |
5478 of the list, as a @emph{schedule} for the day. After that, items remain | |
5479 grouped in categories, in the sequence given by @code{org-agenda-files}. | |
5480 Within each category, items are sorted by priority (@pxref{Priorities}), | |
5481 which is composed of the base priority (2000 for priority @samp{A}, 1000 | |
5482 for @samp{B}, and 0 for @samp{C}), plus additional increments for | |
5483 overdue scheduled or deadline items. | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5484 @item |
84308 | 5485 For the TODO list, items remain in the order of categories, but within |
5486 each category, sorting takes place according to priority | |
5487 (@pxref{Priorities}). | |
5488 @item | |
5489 For tags matches, items are not sorted at all, but just appear in the | |
5490 sequence in which they are found in the agenda files. | |
5491 @end itemize | |
5492 | |
5493 Sorting can be customized using the variable | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5494 @code{org-agenda-sorting-strategy}, and may also include criteria based on |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5495 the estimated effort of an entry. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5496 @c FIXME: link!!!!!!!! |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5497 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5498 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5499 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views |
84308 | 5500 @section Commands in the agenda buffer |
5501 @cindex commands, in agenda buffer | |
5502 | |
5503 Entries in the agenda buffer are linked back to the org file or diary | |
5504 file where they originate. You are not allowed to edit the agenda | |
5505 buffer itself, but commands are provided to show and jump to the | |
5506 original entry location, and to edit the org-files ``remotely'' from | |
5507 the agenda buffer. In this way, all information is stored only once, | |
5508 removing the risk that your agenda and note files may diverge. | |
5509 | |
5510 Some commands can be executed with mouse clicks on agenda lines. For | |
5511 the other commands, the cursor needs to be in the desired line. | |
5512 | |
5513 @table @kbd | |
5514 @tsubheading{Motion} | |
5515 @cindex motion commands in agenda | |
5516 @kindex n | |
5517 @item n | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5518 Next line (same as @key{up} and @kbd{C-p}). |
84308 | 5519 @kindex p |
5520 @item p | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5521 Previous line (same as @key{down} and @kbd{C-n}). |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5522 @tsubheading{View/Go to org file} |
84308 | 5523 @kindex mouse-3 |
5524 @kindex @key{SPC} | |
5525 @item mouse-3 | |
5526 @itemx @key{SPC} | |
5527 Display the original location of the item in another window. | |
5528 @c | |
5529 @kindex L | |
5530 @item L | |
5531 Display original location and recenter that window. | |
5532 @c | |
5533 @kindex mouse-2 | |
5534 @kindex mouse-1 | |
5535 @kindex @key{TAB} | |
5536 @item mouse-2 | |
5537 @itemx mouse-1 | |
5538 @itemx @key{TAB} | |
5539 Go to the original location of the item in another window. Under Emacs | |
5540 22, @kbd{mouse-1} will also works for this. | |
5541 @c | |
5542 @kindex @key{RET} | |
5543 @itemx @key{RET} | |
5544 Go to the original location of the item and delete other windows. | |
5545 @c | |
5546 @kindex f | |
5547 @item f | |
5548 Toggle Follow mode. In Follow mode, as you move the cursor through | |
5549 the agenda buffer, the other window always shows the corresponding | |
5550 location in the org file. The initial setting for this mode in new | |
5551 agenda buffers can be set with the variable | |
5552 @code{org-agenda-start-with-follow-mode}. | |
5553 @c | |
5554 @kindex b | |
5555 @item b | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5556 Display the entire subtree of the current item in an indirect buffer. With a |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5557 numeric prefix argument N, go up to level N and then take that tree. If N is |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5558 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5559 previously used indirect buffer. |
84308 | 5560 @c |
5561 @kindex l | |
5562 @item l | |
5563 Toggle Logbook mode. In Logbook mode, entries that where marked DONE while | |
5564 logging was on (variable @code{org-log-done}) are shown in the agenda, | |
5565 as are entries that have been clocked on that day. | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5566 @c |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5567 @kindex R |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5568 @item R |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5569 Toggle Clockreport mode. In clockreport mode, the daily/weekly agenda will |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5570 always show a table with the clocked times for the timespan and file scope |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5571 covered by the current agenda view. The initial setting for this mode in new |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5572 agenda buffers can be set with the variable |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5573 @code{org-agenda-start-with-clockreport-mode}. |
84308 | 5574 |
5575 @tsubheading{Change display} | |
5576 @cindex display changing, in agenda | |
5577 @kindex o | |
5578 @item o | |
5579 Delete other windows. | |
5580 @c | |
5581 @kindex d | |
5582 @kindex w | |
5583 @kindex m | |
5584 @kindex y | |
5585 @item d w m y | |
5586 Switch to day/week/month/year view. When switching to day or week view, | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5587 this setting becomes the default for subsequent agenda commands. Since |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5588 month and year views are slow to create, they do not become the default. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5589 A numeric prefix argument may be used to jump directly to a specific day |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5590 of the year, ISO week, month, or year, respectively. For example, |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5591 @kbd{32 d} jumps to February 1st, @kbd{9 w} to ISO week number 9. When |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5592 setting day, week, or month view, a year may be encoded in the prefix |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5593 argument as well. For example, @kbd{200712 w} will jump to week 12 in |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5594 2007. If such a year specification has only one or two digits, it will |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5595 be mapped to the interval 1938-2037. |
84308 | 5596 @c |
5597 @kindex D | |
5598 @item D | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5599 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}. |
84308 | 5600 @c |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5601 @kindex G |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5602 @item G |
84308 | 5603 Toggle the time grid on and off. See also the variables |
5604 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}. | |
5605 @c | |
5606 @kindex r | |
5607 @item r | |
5608 Recreate the agenda buffer, for example to reflect the changes | |
5609 after modification of the time stamps of items with S-@key{left} and | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5610 S-@key{right}. When the buffer is the global TODO list, a prefix |
84308 | 5611 argument is interpreted to create a selective list for a specific TODO |
5612 keyword. | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5613 @kindex g |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5614 @item g |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5615 Same as @kbd{r}. |
84308 | 5616 @c |
5617 @kindex s | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5618 @kindex C-x C-s |
84308 | 5619 @item s |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5620 @itemx C-x C-s |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5621 Save all Org buffers in the current Emacs session. |
84308 | 5622 @c |
5623 @kindex @key{right} | |
5624 @item @key{right} | |
5625 Display the following @code{org-agenda-ndays} days. For example, if | |
5626 the display covers a week, switch to the following week. With prefix | |
5627 arg, go forward that many times @code{org-agenda-ndays} days. | |
5628 @c | |
5629 @kindex @key{left} | |
5630 @item @key{left} | |
5631 Display the previous dates. | |
5632 @c | |
5633 @kindex . | |
5634 @item . | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5635 Go to today. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5636 @c |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5637 @kindex C-c C-x C-c |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5638 @item C-c C-x C-c |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5639 Invoke column view (@pxref{Column view}) in the agenda buffer. The column |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5640 view format is taken from the entry at point, or (if there is no entry at |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5641 point), from the first entry in the agenda view. So whatever the format for |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5642 that entry would be in the original buffer (taken from a property, from a |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5643 @code{#+COLUMNS} line, or from the default variable |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5644 @code{org-columns-default-format}), will be used in the agenda. |
84308 | 5645 |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5646 @tsubheading{Query editing} |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5647 @cindex query editing, in agenda |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5648 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5649 @kindex [ |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5650 @kindex ] |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5651 @kindex @{ |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5652 @kindex @} |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5653 @item [ ] @{ @} |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5654 In the @i{search view} (@pxref{Keyword search}), these keys add new |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5655 search words (@kbd{[} and @kbd{]}) or new regular expressions (@kbd{@{} |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5656 and @kbd{@}}) to the query string. The opening bracket/brace will add a |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5657 positive search term prefixed by @samp{+}, indicating that this search |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5658 term @i{must} occur/match in the entry. Closing bracket/brace add a |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5659 negative search term which @i{must not} occur/match in the entry for it |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5660 to be selected. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5661 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5662 |
84308 | 5663 @tsubheading{Remote editing} |
5664 @cindex remote editing, from agenda | |
5665 | |
5666 @item 0-9 | |
5667 Digit argument. | |
5668 @c | |
5669 @cindex undoing remote-editing events | |
5670 @cindex remote editing, undo | |
5671 @kindex C-_ | |
5672 @item C-_ | |
5673 Undo a change due to a remote editing command. The change is undone | |
5674 both in the agenda buffer and in the remote buffer. | |
5675 @c | |
5676 @kindex t | |
5677 @item t | |
5678 Change the TODO state of the item, both in the agenda and in the | |
5679 original org file. | |
5680 @c | |
5681 @kindex C-k | |
5682 @item C-k | |
5683 Delete the current agenda item along with the entire subtree belonging | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5684 to it in the original Org file. If the text to be deleted remotely |
84308 | 5685 is longer than one line, the kill needs to be confirmed by the user. See |
5686 variable @code{org-agenda-confirm-kill}. | |
5687 @c | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5688 @kindex a |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5689 @item a |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5690 Toggle the ARCHIVE tag for the current headline. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5691 @c |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5692 @kindex A |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5693 @item A |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5694 Move the subtree correspoding to the current entry to its @emph{Archive |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5695 Sibling}. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5696 @c |
84308 | 5697 @kindex $ |
5698 @item $ | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5699 Archive the subtree corresponding to the current headline. This means the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5700 entry will be moved to the configured archive locatin, most likely a |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5701 different file. |
84308 | 5702 @c |
5703 @kindex T | |
5704 @item T | |
5705 Show all tags associated with the current item. Because of | |
5706 inheritance, this may be more than the tags listed in the line itself. | |
5707 @c | |
5708 @kindex : | |
5709 @item : | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5710 Set tags for the current headline. If there is an active region in the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5711 agenda, change a tag for all headings in the region. |
84308 | 5712 @c |
5713 @kindex , | |
5714 @item , | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5715 Set the priority for the current item. Org mode prompts for the |
84308 | 5716 priority character. If you reply with @key{SPC}, the priority cookie |
5717 is removed from the entry. | |
5718 @c | |
5719 @kindex P | |
5720 @item P | |
5721 Display weighted priority of current item. | |
5722 @c | |
5723 @kindex + | |
5724 @kindex S-@key{up} | |
5725 @item + | |
5726 @itemx S-@key{up} | |
5727 Increase the priority of the current item. The priority is changed in | |
5728 the original buffer, but the agenda is not resorted. Use the @kbd{r} | |
5729 key for this. | |
5730 @c | |
5731 @kindex - | |
5732 @kindex S-@key{down} | |
5733 @item - | |
5734 @itemx S-@key{down} | |
5735 Decrease the priority of the current item. | |
5736 @c | |
5737 @kindex C-c C-s | |
5738 @item C-c C-s | |
5739 Schedule this item | |
5740 @c | |
5741 @kindex C-c C-d | |
5742 @item C-c C-d | |
5743 Set a deadline for this item. | |
5744 @c | |
5745 @kindex S-@key{right} | |
5746 @item S-@key{right} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5747 Change the time stamp associated with the current line by one day into the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5748 future. With a numeric prefix argument, change it by that many days. For |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5749 example, @kbd{3 6 5 S-@key{right}} will change it by a year. The stamp is |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5750 changed in the original org file, but the change is not directly reflected in |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5751 the agenda buffer. Use the @kbd{r} key to update the buffer. |
84308 | 5752 @c |
5753 @kindex S-@key{left} | |
5754 @item S-@key{left} | |
5755 Change the time stamp associated with the current line by one day | |
5756 into the past. | |
5757 @c | |
5758 @kindex > | |
5759 @item > | |
5760 Change the time stamp associated with the current line to today. | |
5761 The key @kbd{>} has been chosen, because it is the same as @kbd{S-.} | |
5762 on my keyboard. | |
5763 @c | |
5764 @kindex I | |
5765 @item I | |
5766 Start the clock on the current item. If a clock is running already, it | |
5767 is stopped first. | |
5768 @c | |
5769 @kindex O | |
5770 @item O | |
5771 Stop the previously started clock. | |
5772 @c | |
5773 @kindex X | |
5774 @item X | |
5775 Cancel the currently running clock. | |
5776 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5777 @kindex J |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5778 @item J |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5779 Jump to the running clock in another window. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5780 |
84308 | 5781 @tsubheading{Calendar commands} |
5782 @cindex calendar commands, from agenda | |
5783 @kindex c | |
5784 @item c | |
5785 Open the Emacs calendar and move to the date at the agenda cursor. | |
5786 @c | |
5787 @item c | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5788 When in the calendar, compute and show the Org mode agenda for the |
84308 | 5789 date at the cursor. |
5790 @c | |
5791 @cindex diary entries, creating from agenda | |
5792 @kindex i | |
5793 @item i | |
5794 Insert a new entry into the diary. Prompts for the type of entry | |
5795 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new | |
5796 entry in the diary, just as @kbd{i d} etc. would do in the calendar. | |
5797 The date is taken from the cursor position. | |
5798 @c | |
5799 @kindex M | |
5800 @item M | |
5801 Show the phases of the moon for the three months around current date. | |
5802 @c | |
5803 @kindex S | |
5804 @item S | |
5805 Show sunrise and sunset times. The geographical location must be set | |
5806 with calendar variables, see documentation of the Emacs calendar. | |
5807 @c | |
5808 @kindex C | |
5809 @item C | |
5810 Convert the date at cursor into many other cultural and historic | |
5811 calendars. | |
5812 @c | |
5813 @kindex H | |
5814 @item H | |
5815 Show holidays for three month around the cursor date. | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5816 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5817 @item M-x org-export-icalendar-combine-agenda-files |
84308 | 5818 Export a single iCalendar file containing entries from all agenda files. |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5819 This is a globally available command, and also available in the agenda menu. |
84308 | 5820 |
5821 @tsubheading{Exporting to a file} | |
5822 @kindex C-x C-w | |
5823 @item C-x C-w | |
5824 @cindex exporting agenda views | |
5825 @cindex agenda views, exporting | |
5826 Write the agenda view to a file. Depending on the extension of the | |
5827 selected file name, the view will be exported as HTML (extension | |
5828 @file{.html} or @file{.htm}), Postscript (extension @file{.ps}), or | |
5829 plain text (any other extension). Use the variable | |
5830 @code{org-agenda-exporter-settings} to set options for @file{ps-print} | |
5831 and for @file{htmlize} to be used during export. | |
5832 | |
5833 @tsubheading{Quit and Exit} | |
5834 @kindex q | |
5835 @item q | |
5836 Quit agenda, remove the agenda buffer. | |
5837 @c | |
5838 @kindex x | |
5839 @cindex agenda files, removing buffers | |
5840 @item x | |
5841 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs | |
5842 for the compilation of the agenda. Buffers created by the user to | |
5843 visit org files will not be removed. | |
5844 @end table | |
5845 | |
5846 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5847 @node Custom agenda views, Agenda column view, Agenda commands, Agenda Views |
84308 | 5848 @section Custom agenda views |
5849 @cindex custom agenda views | |
5850 @cindex agenda views, custom | |
5851 | |
5852 Custom agenda commands serve two purposes: to store and quickly access | |
5853 frequently used TODO and tags searches, and to create special composite | |
5854 agenda buffers. Custom agenda commands will be accessible through the | |
5855 dispatcher (@pxref{Agenda dispatcher}), just like the default commands. | |
5856 | |
5857 @menu | |
5858 * Storing searches:: Type once, use often | |
5859 * Block agenda:: All the stuff you need in a single buffer | |
5860 * Setting Options:: Changing the rules | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5861 * Exporting Agenda Views:: Writing agendas to files |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5862 * Using the agenda elsewhere:: Using agenda information in other programs |
84308 | 5863 @end menu |
5864 | |
5865 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views | |
5866 @subsection Storing searches | |
5867 | |
5868 The first application of custom searches is the definition of keyboard | |
5869 shortcuts for frequently used searches, either creating an agenda | |
5870 buffer, or a sparse tree (the latter covering of course only the current | |
5871 buffer). | |
5872 @kindex C-c a C | |
5873 Custom commands are configured in the variable | |
5874 @code{org-agenda-custom-commands}. You can customize this variable, for | |
5875 example by pressing @kbd{C-c a C}. You can also directly set it with | |
5876 Emacs Lisp in @file{.emacs}. The following example contains all valid | |
5877 search types: | |
5878 | |
5879 @lisp | |
5880 @group | |
5881 (setq org-agenda-custom-commands | |
5882 '(("w" todo "WAITING") | |
5883 ("W" todo-tree "WAITING") | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5884 ("u" tags "+boss-urgent") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5885 ("v" tags-todo "+boss-urgent") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5886 ("U" tags-tree "+boss-urgent") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5887 ("f" occur-tree "\\<FIXME\\>") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5888 ("h" . "HOME+Name tags searches") ; description for "h" prefix |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5889 ("hl" tags "+home+Lisa") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5890 ("hp" tags "+home+Peter") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5891 ("hk" tags "+home+Kim"))) |
84308 | 5892 @end group |
5893 @end lisp | |
5894 | |
5895 @noindent | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5896 The initial string in each entry defines the keys you have to press |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5897 after the dispatcher command @kbd{C-c a} in order to access the command. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5898 Usually this will be just a single character, but if you have many |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5899 similar commands, you can also define two-letter combinations where the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5900 first character is the same in several combinations and serves as a |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5901 prefix key@footnote{You can provide a description for a prefix key by |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5902 inserting a cons cell with the prefix and the description.}. The second |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5903 parameter is the search type, followed by the string or regular |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5904 expression to be used for the matching. The example above will |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5905 therefore define: |
84308 | 5906 |
5907 @table @kbd | |
5908 @item C-c a w | |
5909 as a global search for TODO entries with @samp{WAITING} as the TODO | |
5910 keyword | |
5911 @item C-c a W | |
5912 as the same search, but only in the current buffer and displaying the | |
5913 results as a sparse tree | |
5914 @item C-c a u | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5915 as a global tags search for headlines marked @samp{:boss:} but not |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5916 @samp{:urgent:} |
84308 | 5917 @item C-c a v |
5918 as the same search as @kbd{C-c a u}, but limiting the search to | |
5919 headlines that are also TODO items | |
5920 @item C-c a U | |
5921 as the same search as @kbd{C-c a u}, but only in the current buffer and | |
5922 displaying the result as a sparse tree | |
5923 @item C-c a f | |
5924 to create a sparse tree (again: current buffer only) with all entries | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5925 containing the word @samp{FIXME} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5926 @item C-c a h |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5927 as a prefix command for a HOME tags search where you have to press an |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5928 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5929 Peter, or Kim) as additional tag to match. |
84308 | 5930 @end table |
5931 | |
5932 @node Block agenda, Setting Options, Storing searches, Custom agenda views | |
5933 @subsection Block agenda | |
5934 @cindex block agenda | |
5935 @cindex agenda, with block views | |
5936 | |
5937 Another possibility is the construction of agenda views that comprise | |
5938 the results of @emph{several} commands, each of which creates a block in | |
5939 the agenda buffer. The available commands include @code{agenda} for the | |
5940 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5941 for the global TODO list (as constructed with @kbd{C-c a t}), and the |
84308 | 5942 matching commands discussed above: @code{todo}, @code{tags}, and |
5943 @code{tags-todo}. Here are two examples: | |
5944 | |
5945 @lisp | |
5946 @group | |
5947 (setq org-agenda-custom-commands | |
5948 '(("h" "Agenda and Home-related tasks" | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5949 ((agenda "") |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5950 (tags-todo "home") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5951 (tags "garden"))) |
84308 | 5952 ("o" "Agenda and Office-related tasks" |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5953 ((agenda "") |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5954 (tags-todo "work") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5955 (tags "office"))))) |
84308 | 5956 @end group |
5957 @end lisp | |
5958 | |
5959 @noindent | |
5960 This will define @kbd{C-c a h} to create a multi-block view for stuff | |
5961 you need to attend to at home. The resulting agenda buffer will contain | |
5962 your agenda for the current week, all TODO items that carry the tag | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5963 @samp{home}, and also all lines tagged with @samp{garden}. Finally the |
84308 | 5964 command @kbd{C-c a o} provides a similar view for office tasks. |
5965 | |
5966 @node Setting Options, Exporting Agenda Views, Block agenda, Custom agenda views | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5967 @subsection Setting options for custom commands |
84308 | 5968 @cindex options, for custom agenda views |
5969 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5970 Org mode contains a number of variables regulating agenda construction |
84308 | 5971 and display. The global variables define the behavior for all agenda |
5972 commands, including the custom commands. However, if you want to change | |
5973 some settings just for a single custom view, you can do so. Setting | |
5974 options requires inserting a list of variable names and values at the | |
5975 right spot in @code{org-agenda-custom-commands}. For example: | |
5976 | |
5977 @lisp | |
5978 @group | |
5979 (setq org-agenda-custom-commands | |
5980 '(("w" todo "WAITING" | |
5981 ((org-agenda-sorting-strategy '(priority-down)) | |
5982 (org-agenda-prefix-format " Mixed: "))) | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5983 ("U" tags-tree "+boss-urgent" |
84308 | 5984 ((org-show-following-heading nil) |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5985 (org-show-hierarchy-above nil))) |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5986 ("N" search "" |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5987 ((org-agenda-files '("~org/notes.org")) |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5988 (org-agenda-text-search-extra-files nil))))) |
84308 | 5989 @end group |
5990 @end lisp | |
5991 | |
5992 @noindent | |
5993 Now the @kbd{C-c a w} command will sort the collected entries only by | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5994 priority, and the prefix format is modified to just say @samp{ Mixed: } |
84308 | 5995 instead of giving the category of the entry. The sparse tags tree of |
5996 @kbd{C-c a U} will now turn out ultra-compact, because neither the | |
5997 headline hierarchy above the match, nor the headline following the match | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5998 will be shown. The command @kbd{C-c a N} will do a text search limited |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5999 to only a single file. |
84308 | 6000 |
6001 For command sets creating a block agenda, | |
6002 @code{org-agenda-custom-commands} has two separate spots for setting | |
6003 options. You can add options that should be valid for just a single | |
6004 command in the set, and options that should be valid for all commands in | |
6005 the set. The former are just added to the command entry, the latter | |
6006 must come after the list of command entries. Going back to the block | |
6007 agenda example (@pxref{Block agenda}), let's change the sorting strategy | |
6008 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort | |
6009 the results for GARDEN tags query in the opposite order, | |
6010 @code{priority-up}. This would look like this: | |
6011 | |
6012 @lisp | |
6013 @group | |
6014 (setq org-agenda-custom-commands | |
6015 '(("h" "Agenda and Home-related tasks" | |
6016 ((agenda) | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6017 (tags-todo "home") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6018 (tags "garden" |
84308 | 6019 ((org-agenda-sorting-strategy '(priority-up))))) |
6020 ((org-agenda-sorting-strategy '(priority-down)))) | |
6021 ("o" "Agenda and Office-related tasks" | |
6022 ((agenda) | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6023 (tags-todo "work") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6024 (tags "office"))))) |
84308 | 6025 @end group |
6026 @end lisp | |
6027 | |
6028 As you see, the values and parenthesis setting is a little complex. | |
6029 When in doubt, use the customize interface to set this variable - it | |
6030 fully supports its structure. Just one caveat: When setting options in | |
6031 this interface, the @emph{values} are just lisp expressions. So if the | |
6032 value is a string, you need to add the double quotes around the value | |
6033 yourself. | |
6034 | |
6035 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6036 @node Exporting Agenda Views, Using the agenda elsewhere, Setting Options, Custom agenda views |
84308 | 6037 @subsection Exporting Agenda Views |
6038 @cindex agenda views, exporting | |
6039 | |
6040 If you are away from your computer, it can be very useful to have a | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6041 printed version of some agenda views to carry around. Org mode can |
84308 | 6042 export custom agenda views as plain text, HTML@footnote{You need to |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6043 install Hrvoje Niksic' @file{htmlize.el}.} postscript, and iCalendar |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6044 files. If you want to do this only occasionally, use the command |
84308 | 6045 |
6046 @table @kbd | |
6047 @kindex C-x C-w | |
6048 @item C-x C-w | |
6049 @cindex exporting agenda views | |
6050 @cindex agenda views, exporting | |
6051 Write the agenda view to a file. Depending on the extension of the | |
6052 selected file name, the view will be exported as HTML (extension | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6053 @file{.html} or @file{.htm}), Postscript (extension @file{.ps}), |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6054 iCalendar (extension @file{.ics}), or plain text (any other extension). |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6055 Use the variable @code{org-agenda-exporter-settings} to |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6056 set options for @file{ps-print} and for @file{htmlize} to be used during |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6057 export, for example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6058 |
84308 | 6059 @lisp |
6060 (setq org-agenda-exporter-settings | |
6061 '((ps-number-of-columns 2) | |
6062 (ps-landscape-mode t) | |
6063 (htmlize-output-type 'css))) | |
6064 @end lisp | |
6065 @end table | |
6066 | |
6067 If you need to export certain agenda views frequently, you can associate | |
6068 any custom agenda command with a list of output file names | |
6069 @footnote{If you want to store standard views like the weekly agenda | |
6070 or the global TODO list as well, you need to define custom commands for | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6071 them in order to be able to specify file names.}. Here is an example |
84308 | 6072 that first does define custom commands for the agenda and the global |
6073 todo list, together with a number of files to which to export them. | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6074 Then we define two block agenda commands and specify file names for them |
84308 | 6075 as well. File names can be relative to the current working directory, |
6076 or absolute. | |
6077 | |
6078 @lisp | |
6079 @group | |
6080 (setq org-agenda-custom-commands | |
6081 '(("X" agenda "" nil ("agenda.html" "agenda.ps")) | |
6082 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps")) | |
6083 ("h" "Agenda and Home-related tasks" | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6084 ((agenda "") |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6085 (tags-todo "home") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6086 (tags "garden")) |
84308 | 6087 nil |
6088 ("~/views/home.html")) | |
6089 ("o" "Agenda and Office-related tasks" | |
6090 ((agenda) | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6091 (tags-todo "work") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6092 (tags "office")) |
84308 | 6093 nil |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6094 ("~/views/office.ps" "~/calendars/office.ics")))) |
84308 | 6095 @end group |
6096 @end lisp | |
6097 | |
6098 The extension of the file name determines the type of export. If it is | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6099 @file{.html}, Org mode will use the @file{htmlize.el} package to convert |
84308 | 6100 the buffer to HTML and save it to this file name. If the extension is |
6101 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6102 postscript output. If the extension is @file{.ics}, iCalendar export is |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6103 run export over all files that were used to construct the agenda, and |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6104 limit the export to entries listed in the agenda now. Any other |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6105 extension produces a plain ASCII file. |
84308 | 6106 |
6107 The export files are @emph{not} created when you use one of those | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6108 commands interactively because this might use too much overhead. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6109 Instead, there is a special command to produce @emph{all} specified |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6110 files in one step: |
84308 | 6111 |
6112 @table @kbd | |
6113 @kindex C-c a e | |
6114 @item C-c a e | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6115 Export all agenda views that have export file names associated with |
84308 | 6116 them. |
6117 @end table | |
6118 | |
6119 You can use the options section of the custom agenda commands to also | |
6120 set options for the export commands. For example: | |
6121 | |
6122 @lisp | |
6123 (setq org-agenda-custom-commands | |
6124 '(("X" agenda "" | |
6125 ((ps-number-of-columns 2) | |
6126 (ps-landscape-mode t) | |
6127 (org-agenda-prefix-format " [ ] ") | |
6128 (org-agenda-with-colors nil) | |
6129 (org-agenda-remove-tags t)) | |
6130 ("theagenda.ps")))) | |
6131 @end lisp | |
6132 | |
6133 @noindent | |
6134 This command sets two options for the postscript exporter, to make it | |
6135 print in two columns in landscape format - the resulting page can be cut | |
6136 in two and then used in a paper agenda. The remaining settings modify | |
6137 the agenda prefix to omit category and scheduling information, and | |
6138 instead include a checkbox to check off items. We also remove the tags | |
6139 to make the lines compact, and we don't want to use colors for the | |
6140 black-and-white printer. Settings specified in | |
6141 @code{org-agenda-exporter-settings} will also apply, but the settings | |
6142 in @code{org-agenda-custom-commands} take precedence. | |
6143 | |
6144 @noindent | |
6145 From the command line you may also use | |
6146 @example | |
6147 emacs -f org-batch-store-agenda-views -kill | |
6148 @end example | |
6149 @noindent | |
6150 or, if you need to modify some parameters | |
6151 @example | |
6152 emacs -eval '(org-batch-store-agenda-views \ | |
6153 org-agenda-ndays 30 \ | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6154 org-agenda-start-day "2007-11-01" \ |
84308 | 6155 org-agenda-include-diary nil \ |
6156 org-agenda-files (quote ("~/org/project.org")))' \ | |
6157 -kill | |
6158 @end example | |
6159 @noindent | |
6160 which will create the agenda views restricted to the file | |
6161 @file{~/org/project.org}, without diary entries and with 30 days | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6162 extent. |
84308 | 6163 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6164 @node Using the agenda elsewhere, , Exporting Agenda Views, Custom agenda views |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6165 @subsection Using agenda information outside of Org |
84308 | 6166 @cindex agenda, pipe |
6167 @cindex Scripts, for agenda processing | |
6168 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6169 Org provides commands to access agenda information for the command |
84308 | 6170 line in emacs batch mode. This extracted information can be sent |
6171 directly to a printer, or it can be read by a program that does further | |
6172 processing of the data. The first of these commands is the function | |
6173 @code{org-batch-agenda}, that produces an agenda view and sends it as | |
6174 ASCII text to STDOUT. The command takes a single string as parameter. | |
6175 If the string has length 1, it is used as a key to one of the commands | |
6176 you have configured in @code{org-agenda-custom-commands}, basically any | |
6177 key you can use after @kbd{C-c a}. For example, to directly print the | |
6178 current TODO list, you could use | |
6179 | |
6180 @example | |
6181 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr | |
6182 @end example | |
6183 | |
6184 If the parameter is a string with 2 or more characters, it is used as a | |
6185 tags/todo match string. For example, to print your local shopping list | |
6186 (all items with the tag @samp{shop}, but excluding the tag | |
6187 @samp{NewYork}), you could use | |
6188 | |
6189 @example | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6190 emacs -batch -l ~/.emacs \ |
84308 | 6191 -eval '(org-batch-agenda "+shop-NewYork")' | lpr |
6192 @end example | |
6193 | |
6194 @noindent | |
6195 You may also modify parameters on the fly like this: | |
6196 | |
6197 @example | |
6198 emacs -batch -l ~/.emacs \ | |
6199 -eval '(org-batch-agenda "a" \ | |
6200 org-agenda-ndays 30 \ | |
6201 org-agenda-include-diary nil \ | |
6202 org-agenda-files (quote ("~/org/project.org")))' \ | |
6203 | lpr | |
6204 @end example | |
6205 | |
6206 @noindent | |
6207 which will produce a 30 day agenda, fully restricted to the Org file | |
6208 @file{~/org/projects.org}, not even including the diary. | |
6209 | |
6210 If you want to process the agenda data in more sophisticated ways, you | |
6211 can use the command @code{org-batch-agenda-csv} to get a comma-separated | |
6212 list of values for each agenda item. Each line in the output will | |
6213 contain a number of fields separated by commas. The fields in a line | |
6214 are: | |
6215 | |
6216 @example | |
6217 category @r{The category of the item} | |
6218 head @r{The headline, without TODO kwd, TAGS and PRIORITY} | |
6219 type @r{The type of the agenda entry, can be} | |
6220 todo @r{selected in TODO match} | |
6221 tagsmatch @r{selected in tags match} | |
6222 diary @r{imported from diary} | |
6223 deadline @r{a deadline} | |
6224 scheduled @r{scheduled} | |
6225 timestamp @r{appointment, selected by timestamp} | |
6226 closed @r{entry was closed on date} | |
6227 upcoming-deadline @r{warning about nearing deadline} | |
6228 past-scheduled @r{forwarded scheduled item} | |
6229 block @r{entry has date block including date} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6230 todo @r{The TODO keyword, if any} |
84308 | 6231 tags @r{All tags including inherited ones, separated by colons} |
6232 date @r{The relevant date, like 2007-2-14} | |
6233 time @r{The time, like 15:00-16:50} | |
6234 extra @r{String with extra planning info} | |
6235 priority-l @r{The priority letter if any was given} | |
6236 priority-n @r{The computed numerical priority} | |
6237 @end example | |
6238 | |
6239 @noindent | |
6240 Time and date will only be given if a timestamp (or deadline/scheduled) | |
6241 lead to the selection of the item. | |
6242 | |
6243 A CSV list like this is very easy to use in a post processing script. | |
6244 For example, here is a Perl program that gets the TODO list from | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6245 Emacs/Org and prints all the items, preceded by a checkbox: |
84308 | 6246 |
6247 @example | |
6248 @group | |
6249 #!/usr/bin/perl | |
6250 | |
6251 # define the Emacs command to run | |
6252 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'"; | |
6253 | |
6254 # run it and capture the output | |
6255 $agenda = qx@{$cmd 2>/dev/null@}; | |
6256 | |
6257 # loop over all lines | |
6258 foreach $line (split(/\n/,$agenda)) @{ | |
6259 | |
6260 # get the individual values | |
6261 ($category,$head,$type,$todo,$tags,$date,$time,$extra, | |
6262 $priority_l,$priority_n) = split(/,/,$line); | |
6263 | |
6264 # proccess and print | |
6265 print "[ ] $head\n"; | |
6266 @} | |
6267 @end group | |
6268 @end example | |
6269 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6270 @node Agenda column view, , Custom agenda views, Agenda Views |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6271 @section Using column view in the agenda |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6272 @cindex column view, in agenda |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6273 @cindex agenda, column view |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6274 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6275 Column view (@pxref{Column view}) is normally used to view and edit |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6276 properties embedded in the hierarchical structure of an Org file. It can be |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6277 quite useful to use column view also from the agenda, where entries are |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6278 collected by certain criteria. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6279 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6280 @table @kbd |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6281 @kindex C-c C-x C-c |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6282 @item C-c C-x C-c |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6283 Turn on column view in the agenda. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6284 @end table |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6285 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6286 To understand how to use this properly, it is important to realize that the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6287 entries in the agenda are no longer in their proper outline environment. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6288 This causes the following issues: |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6289 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6290 @enumerate |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6291 @item |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6292 Org needs to make a decision which @code{COLUMNS} format to use. Since the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6293 entries in the agenda are collected from different files, and different files |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6294 may have different @code{COLUMNS} formats, this is a non-trivial problem. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6295 Org first checks if the variable @code{org-overriding-columns-format} is |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6296 currently set, and if yes takes the format from there. Otherwise it takes |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6297 the format associated with the first item in the agenda, or, if that item |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6298 does not have a specific format (defined in a property, or in it's file), it |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6299 uses @code{org-columns-default-format}. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6300 @item |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6301 If any of the columns has a summary type defined (@pxref{Column attributes}), |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6302 turning on column view in the agenda will visit all relevant agenda files and |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6303 make sure that the computations of this property are up to date. This is |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6304 also true for the special @code{CLOCKSUM} property. Org will then sum the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6305 values displayed in the agenda. In the daily/weekly agenda, the sums will |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6306 cover a single day, in all other views they cover the entire block. It is |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6307 vital to realize that the agenda may show the same entry @emph{twice} (for |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6308 example as scheduled and as a deadline), and it may show two entries from the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6309 same hierarchy (for example a @emph{parent} and it's @emph{child}). In these |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6310 cases, the summation in the agenda will lead to incorrect results because |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6311 some values will count double. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6312 @item |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6313 When the column view in the agenda shows the @code{CLOCKSUM}, that is always |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6314 the entire clocked time for this item. So even in the daily/weekly agenda, |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6315 the clocksum listed in column view may originate from times outside the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6316 current view. This has the advantage that you can compare these values with |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6317 a column listing the planned total effort for a task - one of the major |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6318 applications for column view in the agenda. If you want information about |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6319 clocked time in the displayed period use clock table mode (press @kbd{R} in |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6320 the agenda). |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6321 @end enumerate |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6322 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6323 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6324 @node Embedded LaTeX, Exporting, Agenda Views, Top |
84308 | 6325 @chapter Embedded LaTeX |
6326 @cindex @TeX{} interpretation | |
6327 @cindex La@TeX{} interpretation | |
6328 | |
6329 Plain ASCII is normally sufficient for almost all note taking. One | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6330 exception, however, are scientific notes which need to be able to contain |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6331 mathematical symbols and the occasional formula. La@TeX{}@footnote{La@TeX{} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6332 is a macro system based on Donald E. Knuth's @TeX{} system. Many of the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6333 features described here as ``La@TeX{}'' are really from @TeX{}, but for |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6334 simplicity I am blurring this distinction.} is widely used to typeset |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6335 scientific documents. Org mode supports embedding La@TeX{} code into its |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6336 files, because many academics are used to reading La@TeX{} source code, and |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6337 because it can be readily processed into images for HTML production. |
84308 | 6338 |
6339 It is not necessary to mark La@TeX{} macros and code in any special way. | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6340 If you observe a few conventions, Org mode knows how to find it and what |
84308 | 6341 to do with it. |
6342 | |
6343 @menu | |
6344 * Math symbols:: TeX macros for symbols and Greek letters | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6345 * Subscripts and superscripts:: Simple syntax for raising/lowering text |
84308 | 6346 * LaTeX fragments:: Complex formulas made easy |
6347 * Processing LaTeX fragments:: Previewing LaTeX processing | |
6348 * CDLaTeX mode:: Speed up entering of formulas | |
6349 @end menu | |
6350 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6351 @node Math symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX |
84308 | 6352 @section Math symbols |
6353 @cindex math symbols | |
6354 @cindex TeX macros | |
6355 | |
6356 You can use La@TeX{} macros to insert special symbols like @samp{\alpha} | |
6357 to indicate the Greek letter, or @samp{\to} to indicate an arrow. | |
6358 Completion for these macros is available, just type @samp{\} and maybe a | |
6359 few letters, and press @kbd{M-@key{TAB}} to see possible completions. | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6360 Unlike La@TeX{} code, Org mode allows these macros to be present |
84308 | 6361 without surrounding math delimiters, for example: |
6362 | |
6363 @example | |
6364 Angles are written as Greek letters \alpha, \beta and \gamma. | |
6365 @end example | |
6366 | |
6367 During HTML export (@pxref{HTML export}), these symbols are translated | |
6368 into the proper syntax for HTML, for the above examples this is | |
6369 @samp{α} and @samp{→}, respectively. | |
6370 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6371 @node Subscripts and superscripts, LaTeX fragments, Math symbols, Embedded LaTeX |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6372 @section Subscripts and superscripts |
84308 | 6373 @cindex subscript |
6374 @cindex superscript | |
6375 | |
6376 Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super- | |
6377 and subscripts. Again, these can be used without embedding them in | |
6378 math-mode delimiters. To increase the readability of ASCII text, it is | |
6379 not necessary (but OK) to surround multi-character sub- and superscripts | |
6380 with curly braces. For example | |
6381 | |
6382 @example | |
6383 The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of | |
6384 the sun is R_@{sun@} = 6.96 x 10^8 m. | |
6385 @end example | |
6386 | |
6387 To avoid interpretation as raised or lowered text, you can quote | |
6388 @samp{^} and @samp{_} with a backslash: @samp{\_} and @samp{\^}. | |
6389 | |
6390 During HTML export (@pxref{HTML export}), subscript and superscripts | |
6391 are surrounded with @code{<sub>} and @code{<sup>} tags, respectively. | |
6392 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6393 @node LaTeX fragments, Processing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX |
84308 | 6394 @section LaTeX fragments |
6395 @cindex LaTeX fragments | |
6396 | |
6397 With symbols, sub- and superscripts, HTML is pretty much at its end when | |
6398 it comes to representing mathematical formulas@footnote{Yes, there is | |
6399 MathML, but that is not yet fully supported by many browsers, and there | |
6400 is no decent converter for turning La@TeX{} or ASCII representations of | |
6401 formulas into MathML. So for the time being, converting formulas into | |
6402 images seems the way to go.}. More complex expressions need a dedicated | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6403 formula processor. To this end, Org mode can contain arbitrary La@TeX{} |
84308 | 6404 fragments. It provides commands to preview the typeset result of these |
6405 fragments, and upon export to HTML, all fragments will be converted to | |
6406 images and inlined into the HTML document@footnote{The La@TeX{} export | |
6407 will not use images for displaying La@TeX{} fragments but include these | |
6408 fragments directly into the La@TeX{} code.}. For this to work you | |
6409 need to be on a system with a working La@TeX{} installation. You also | |
6410 need the @file{dvipng} program, available at | |
6411 @url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that | |
6412 will be used when processing a fragment can be configured with the | |
6413 variable @code{org-format-latex-header}. | |
6414 | |
6415 La@TeX{} fragments don't need any special marking at all. The following | |
6416 snippets will be identified as La@TeX{} source code: | |
6417 @itemize @bullet | |
6418 @item | |
6419 Environments of any kind. The only requirement is that the | |
6420 @code{\begin} statement appears on a new line, preceded by only | |
6421 whitespace. | |
6422 @item | |
6423 Text within the usual La@TeX{} math delimiters. To avoid conflicts with | |
6424 currency specifications, single @samp{$} characters are only recognized | |
6425 as math delimiters if the enclosed text contains at most two line breaks, | |
6426 is directly attached to the @samp{$} characters with no whitespace in | |
6427 between, and if the closing @samp{$} is followed by whitespace or | |
6428 punctuation. For the other delimiters, there is no such restriction, so | |
6429 when in doubt, use @samp{\(...\)} as inline math delimiters. | |
6430 @end itemize | |
6431 | |
6432 @noindent For example: | |
6433 | |
6434 @example | |
6435 \begin@{equation@} % arbitrary environments, | |
6436 x=\sqrt@{b@} % even tables, figures | |
6437 \end@{equation@} % etc | |
6438 | |
6439 If $a^2=b$ and \( b=2 \), then the solution must be | |
6440 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \]. | |
6441 @end example | |
6442 | |
6443 @noindent | |
6444 If you need any of the delimiter ASCII sequences for other purposes, you | |
6445 can configure the option @code{org-format-latex-options} to deselect the | |
6446 ones you do not wish to have interpreted by the La@TeX{} converter. | |
6447 | |
6448 @node Processing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX | |
6449 @section Processing LaTeX fragments | |
6450 @cindex LaTeX fragments, preview | |
6451 | |
6452 La@TeX{} fragments can be processed to produce a preview images of the | |
6453 typeset expressions: | |
6454 | |
6455 @table @kbd | |
6456 @kindex C-c C-x C-l | |
6457 @item C-c C-x C-l | |
6458 Produce a preview image of the La@TeX{} fragment at point and overlay it | |
6459 over the source code. If there is no fragment at point, process all | |
6460 fragments in the current entry (between two headlines). When called | |
6461 with a prefix argument, process the entire subtree. When called with | |
6462 two prefix arguments, or when the cursor is before the first headline, | |
6463 process the entire buffer. | |
6464 @kindex C-c C-c | |
6465 @item C-c C-c | |
6466 Remove the overlay preview images. | |
6467 @end table | |
6468 | |
6469 During HTML export (@pxref{HTML export}), all La@TeX{} fragments are | |
6470 converted into images and inlined into the document if the following | |
6471 setting is active: | |
6472 | |
6473 @lisp | |
6474 (setq org-export-with-LaTeX-fragments t) | |
6475 @end lisp | |
6476 | |
6477 @node CDLaTeX mode, , Processing LaTeX fragments, Embedded LaTeX | |
6478 @section Using CDLaTeX to enter math | |
6479 @cindex CDLaTeX | |
6480 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6481 CDLaTeX mode is a minor mode that is normally used in combination with a |
84308 | 6482 major La@TeX{} mode like AUCTeX in order to speed-up insertion of |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6483 environments and math templates. Inside Org mode, you can make use of |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6484 some of the features of CDLaTeX mode. You need to install |
84308 | 6485 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with |
6486 AUCTeX) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}. | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6487 Don't use CDLaTeX mode itself under Org mode, but use the light |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6488 version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it |
84308 | 6489 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6490 Org files with |
84308 | 6491 |
6492 @lisp | |
6493 (add-hook 'org-mode-hook 'turn-on-org-cdlatex) | |
6494 @end lisp | |
6495 | |
6496 When this mode is enabled, the following features are present (for more | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6497 details see the documentation of CDLaTeX mode): |
84308 | 6498 @itemize @bullet |
6499 @kindex C-c @{ | |
6500 @item | |
6501 Environment templates can be inserted with @kbd{C-c @{}. | |
6502 @item | |
6503 @kindex @key{TAB} | |
6504 The @key{TAB} key will do template expansion if the cursor is inside a | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6505 La@TeX{} fragment@footnote{Org mode has a method to test if the cursor is |
84308 | 6506 inside such a fragment, see the documentation of the function |
6507 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will | |
6508 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor | |
6509 correctly inside the first brace. Another @key{TAB} will get you into | |
6510 the second brace. Even outside fragments, @key{TAB} will expand | |
6511 environment abbreviations at the beginning of a line. For example, if | |
6512 you write @samp{equ} at the beginning of a line and press @key{TAB}, | |
6513 this abbreviation will be expanded to an @code{equation} environment. | |
6514 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}. | |
6515 @item | |
6516 @kindex _ | |
6517 @kindex ^ | |
6518 Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these | |
6519 characters together with a pair of braces. If you use @key{TAB} to move | |
6520 out of the braces, and if the braces surround only a single character or | |
6521 macro, they are removed again (depending on the variable | |
6522 @code{cdlatex-simplify-sub-super-scripts}). | |
6523 @item | |
6524 @kindex ` | |
6525 Pressing the backquote @kbd{`} followed by a character inserts math | |
6526 macros, also outside La@TeX{} fragments. If you wait more than 1.5 seconds | |
6527 after the backquote, a help window will pop up. | |
6528 @item | |
6529 @kindex ' | |
6530 Pressing the normal quote @kbd{'} followed by another character modifies | |
6531 the symbol before point with an accent or a font. If you wait more than | |
6532 1.5 seconds after the backquote, a help window will pop up. Character | |
6533 modification will work only inside La@TeX{} fragments, outside the quote | |
6534 is normal. | |
6535 @end itemize | |
6536 | |
6537 @node Exporting, Publishing, Embedded LaTeX, Top | |
6538 @chapter Exporting | |
6539 @cindex exporting | |
6540 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6541 Org mode documents can be exported into a variety of other formats. For |
84308 | 6542 printing and sharing of notes, ASCII export produces a readable and |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6543 simple version of an Org file. HTML export allows you to publish a |
84308 | 6544 notes file on the web, while the XOXO format provides a solid base for |
6545 exchange with a broad range of other applications. La@TeX{} export lets | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6546 you use Org mode and its structured editing functions to easily create |
84308 | 6547 La@TeX{} files. To incorporate entries with associated times like |
6548 deadlines or appointments into a desktop calendar program like iCal, | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6549 Org mode can also produce extracts in the iCalendar format. Currently |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6550 Org mode only supports export, not import of these different formats. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6551 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6552 When exporting, Org mode uses special conventions to enrich the output |
84308 | 6553 produced. @xref{Text interpretation}, for more details. |
6554 | |
6555 @table @kbd | |
6556 @kindex C-c C-e | |
6557 @item C-c C-e | |
6558 Dispatcher for export and publishing commands. Displays a help-window | |
6559 listing the additional key(s) needed to launch an export or publishing | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6560 command. The prefix arg is passed through to the exporter. If the option |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6561 @code{org-export-run-in-background} is set, Org will run the command in the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6562 background if that seems useful for the specific command (i.e. commands that |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6563 write to a file). |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6564 @kindex C-u C-u C-c C-e |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6565 @item C-u C-u C-c C-e |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6566 Call an the exporter, but reverse the setting of |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6567 @code{org-export-run-in-background}, i.e. request background processing if |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6568 not set, or force processing in the current Emacs process if st. |
84308 | 6569 @end table |
6570 | |
6571 @menu | |
6572 * ASCII export:: Exporting to plain ASCII | |
6573 * HTML export:: Exporting to HTML | |
6574 * LaTeX export:: Exporting to LaTeX | |
6575 * XOXO export:: Exporting to XOXO | |
6576 * iCalendar export:: Exporting in iCalendar format | |
6577 * Text interpretation:: How the exporter looks at the file | |
6578 @end menu | |
6579 | |
6580 @node ASCII export, HTML export, Exporting, Exporting | |
6581 @section ASCII export | |
6582 @cindex ASCII export | |
6583 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6584 ASCII export produces a simple and very readable version of an Org mode |
84308 | 6585 file. |
6586 | |
6587 @cindex region, active | |
6588 @cindex active region | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6589 @cindex Transient mark mode |
84308 | 6590 @table @kbd |
6591 @kindex C-c C-e a | |
6592 @item C-c C-e a | |
6593 Export as ASCII file. For an org file @file{myfile.org}, the ASCII file | |
6594 will be @file{myfile.txt}. The file will be overwritten without | |
6595 warning. If there is an active region, only the region will be | |
6596 exported. If the selected region is a single tree, the tree head will | |
6597 become the document title. If the tree head entry has or inherits an | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6598 @code{:EXPORT_FILE_NAME:} property, that name will be used for the |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6599 export. |
84308 | 6600 @kindex C-c C-e v a |
6601 @item C-c C-e v a | |
6602 Export only the visible part of the document. | |
6603 @end table | |
6604 | |
6605 @cindex headline levels, for exporting | |
6606 In the exported version, the first 3 outline levels will become | |
6607 headlines, defining a general document structure. Additional levels | |
6608 will be exported as itemized lists. If you want that transition to occur | |
6609 at a different level, specify it with a prefix argument. For example, | |
6610 | |
6611 @example | |
6612 @kbd{C-1 C-c C-e a} | |
6613 @end example | |
6614 | |
6615 @noindent | |
6616 creates only top level headlines and does the rest as items. When | |
6617 headlines are converted to items, the indentation of the text following | |
6618 the headline is changed to fit nicely under the item. This is done with | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6619 the assumption that the first body line indicates the base indentation of |
84308 | 6620 the body text. Any indentation larger than this is adjusted to preserve |
6621 the layout relative to the first line. Should there be lines with less | |
6622 indentation than the first, these are left alone. | |
6623 | |
6624 @node HTML export, LaTeX export, ASCII export, Exporting | |
6625 @section HTML export | |
6626 @cindex HTML export | |
6627 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6628 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive |
84308 | 6629 HTML formatting, in ways similar to John Grubers @emph{markdown} |
6630 language, but with additional support for tables. | |
6631 | |
6632 @menu | |
6633 * HTML Export commands:: How to invoke LaTeX export | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6634 * Quoting HTML tags:: Using direct HTML in Org mode |
84308 | 6635 * Links:: Transformation of links for HTML |
6636 * Images:: How to include images | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6637 * CSS support:: Changing the appearance of the output |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6638 * Javascript support:: Info and Folding in a web browser |
84308 | 6639 @end menu |
6640 | |
6641 @node HTML Export commands, Quoting HTML tags, HTML export, HTML export | |
6642 @subsection HTML export commands | |
6643 | |
6644 @cindex region, active | |
6645 @cindex active region | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6646 @cindex Transient mark mode |
84308 | 6647 @table @kbd |
6648 @kindex C-c C-e h | |
6649 @item C-c C-e h | |
6650 Export as HTML file @file{myfile.html}. For an org file | |
6651 @file{myfile.org}, the ASCII file will be @file{myfile.html}. The file | |
6652 will be overwritten without warning. If there is an active region, only | |
6653 the region will be exported. If the selected region is a single tree, | |
6654 the tree head will become the document title. If the tree head entry | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6655 has or inherits an @code{:EXPORT_FILE_NAME:} property, that name will be |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6656 used for the export. |
84308 | 6657 @kindex C-c C-e b |
6658 @item C-c C-e b | |
6659 Export as HTML file and immediately open it with a browser. | |
6660 @kindex C-c C-e H | |
6661 @item C-c C-e H | |
6662 Export to a temporary buffer, do not create a file. | |
6663 @kindex C-c C-e R | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6664 @item C-c C-e R |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6665 Export the active region to a temporary buffer. With a prefix argument, do |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6666 not produce the file header and footer, but just the plain HTML section for |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6667 the region. This is good for cut-and-paste operations. |
84308 | 6668 @kindex C-c C-e v h |
6669 @kindex C-c C-e v b | |
6670 @kindex C-c C-e v H | |
6671 @kindex C-c C-e v R | |
6672 @item C-c C-e v h | |
6673 @item C-c C-e v b | |
6674 @item C-c C-e v H | |
6675 @item C-c C-e v R | |
6676 Export only the visible part of the document. | |
6677 @item M-x org-export-region-as-html | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6678 Convert the region to HTML under the assumption that it was Org mode |
84308 | 6679 syntax before. This is a global command that can be invoked in any |
6680 buffer. | |
6681 @item M-x org-replace-region-by-HTML | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6682 Replace the active region (assumed to be in Org mode syntax) by HTML |
84308 | 6683 code. |
6684 @end table | |
6685 | |
6686 @cindex headline levels, for exporting | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6687 In the exported version, the first 3 outline levels will become headlines, |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6688 defining a general document structure. Additional levels will be exported as |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6689 itemized lists. If you want that transition to occur at a different level, |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6690 specify it with a numeric prefix argument. For example, |
84308 | 6691 |
6692 @example | |
6693 @kbd{C-2 C-c C-e b} | |
6694 @end example | |
6695 | |
6696 @noindent | |
6697 creates two levels of headings and does the rest as items. | |
6698 | |
6699 @node Quoting HTML tags, Links, HTML Export commands, HTML export | |
6700 @subsection Quoting HTML tags | |
6701 | |
6702 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and | |
6703 @samp{>} in HTML export. If you want to include simple HTML tags | |
6704 which should be interpreted as such, mark them with @samp{@@} as in | |
6705 @samp{@@<b>bold text@@</b>}. Note that this really works only for | |
6706 simple tags. For more extensive HTML that should be copied verbatim to | |
6707 the exported file use either | |
6708 | |
6709 @example | |
6710 #+HTML: Literal HTML code for export | |
6711 @end example | |
6712 | |
6713 @noindent or | |
6714 | |
6715 @example | |
6716 #+BEGIN_HTML | |
6717 All lines between these markers are exported literally | |
6718 #+END_HTML | |
6719 @end example | |
6720 | |
6721 | |
6722 @node Links, Images, Quoting HTML tags, HTML export | |
6723 @subsection Links | |
6724 | |
6725 @cindex links, in HTML export | |
6726 @cindex internal links, in HTML export | |
6727 @cindex external links, in HTML export | |
6728 Internal links (@pxref{Internal links}) will continue to work in HTML | |
6729 files only if they match a dedicated @samp{<<target>>}. Automatic links | |
6730 created by radio targets (@pxref{Radio targets}) will also work in the | |
6731 HTML file. Links to external files will still work if the HTML file is | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6732 in the same directory as the Org file. Links to other @file{.org} |
84308 | 6733 files will be translated into HTML links under the assumption that an |
6734 HTML version also exists of the linked file. For information related to | |
6735 linking files while publishing them to a publishing directory see | |
6736 @ref{Publishing links}. | |
6737 | |
6738 @node Images, CSS support, Links, HTML export | |
6739 @subsection Images | |
6740 | |
6741 @cindex images, inline in HTML | |
6742 @cindex inlining images in HTML | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6743 HTML export can inline images given as links in the Org file, and |
84308 | 6744 it can make an image the clickable part of a link. By |
6745 default@footnote{but see the variable | |
6746 @code{org-export-html-inline-images}}, images are inlined if a link does | |
6747 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined, | |
6748 while @samp{[[file:myimg.jpg][the image]]} will just produce a link | |
6749 @samp{the image} that points to the image. If the description part | |
6750 itself is a @code{file:} link or a @code{http:} URL pointing to an | |
6751 image, this image will be inlined and activated so that clicking on the | |
6752 image will activate the link. For example, to include a thumbnail that | |
6753 will link to a high resolution version of the image, you could use: | |
6754 | |
6755 @example | |
6756 [[file:highres.jpg][file:thumb.jpg]] | |
6757 @end example | |
6758 | |
6759 @noindent | |
6760 and you could use @code{http} addresses just as well. | |
6761 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6762 @node CSS support, Javascript support, Images, HTML export |
84308 | 6763 @subsection CSS support |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6764 @cindex CSS, for HTML export |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6765 @cindex HTML export, CSS |
84308 | 6766 |
6767 You can also give style information for the exported file. The HTML | |
6768 exporter assigns the following CSS classes to appropriate parts of the | |
6769 document - your style specifications may change these: | |
6770 @example | |
6771 .todo @r{TODO keywords} | |
6772 .done @r{the DONE keyword} | |
6773 .timestamp @r{time stamp} | |
6774 .timestamp-kwd @r{keyword associated with a time stamp, like SCHEDULED} | |
6775 .tag @r{tag in a headline} | |
6776 .target @r{target for links} | |
6777 @end example | |
6778 | |
6779 The default style specification can be configured through the option | |
6780 @code{org-export-html-style}. If you want to use a file-local style, | |
6781 you may use file variables, best wrapped into a COMMENT section at the | |
6782 end of the outline tree. For example@footnote{Under Emacs 21, the | |
6783 continuation lines for a variable value should have no @samp{#} at the | |
6784 start of the line.}: | |
6785 | |
6786 @example | |
6787 * COMMENT html style specifications | |
6788 | |
6789 # Local Variables: | |
6790 # org-export-html-style: " <style type=\"text/css\"> | |
6791 # p @{font-weight: normal; color: gray; @} | |
6792 # h1 @{color: black; @} | |
6793 # </style>" | |
6794 # End: | |
6795 @end example | |
6796 | |
6797 Remember to execute @kbd{M-x normal-mode} after changing this to make | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6798 the new style visible to Emacs. This command restarts Org mode for the |
84308 | 6799 current buffer and forces Emacs to re-evaluate the local variables |
6800 section in the buffer. | |
6801 | |
6802 @c FIXME: More about header and footer styles | |
6803 @c FIXME: Talk about links and targets. | |
6804 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6805 @node Javascript support, , CSS support, HTML export |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6806 @subsection Javascript supported display of web pages |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6807 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6808 @emph{Sebastian Rose} has written a JavaScript program especially designed to |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6809 enhance the web viewing experience of HTML files created with Org. This |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6810 program allows to view large files in two different ways. The first one is |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6811 an @emph{Info}-like mode where each section is displayed separately and |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6812 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6813 as well, press @kbd{?} for an overview of the available keys). The second |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6814 view type is a @emph{folding} view much like Org provides it inside Emacs. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6815 The script is available at @url{http://orgmode.org/org-info.js} and you can |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6816 find the documentation for it at @url{http://orgmode.org/org-infojs.html}. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6817 We are serving the script from our site, but if you use it a lot, you might |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6818 not want to be dependent on @url{orgmode.org} and prefer to install a local |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6819 copy on your own web server. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6820 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6821 To use the script, you need to make sure that the @file{org-infojs.el} module |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6822 gets loaded. It should be loaded by default, try @kbd{M-x customize-variable |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6823 @key{RET} org-modules @key{RET}} to convince yourself that this is indeed the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6824 case. All it then takes to make use of the program is adding a single line |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6825 to the Org file: |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6826 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6827 @example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6828 #+INFOSJ_OPT: view:info toc:nil |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6829 @end example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6830 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6831 @noindent |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6832 If this line is found, the HTML header will automatically contain the code |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6833 needed to invoke the script. Using the line above, you can set the following |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6834 viewing options: |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6835 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6836 @example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6837 path: @r{The path to the script. The default is to grab the script from} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6838 @r{@url{http://orgmode.org/org-info.js}, but you might want to have} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6839 @r{a local copy and use a path like @samp{../scripts/org-info.js}.} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6840 view: @r{Initial view when website is first shown. Possible values are} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6841 info @r{Info-like interface with one section per page.} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6842 overview @r{Folding interface, initially showing only top-level.} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6843 content @r{Folding interface, starting with all headlines visible.} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6844 showall @r{Folding interface, all headlines and text visible.} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6845 sdepth: @r{Maximum headline level that will still become an independent} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6846 @r{section for info and folding modes. The default is taken from} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6847 @r{@code{org-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6848 @r{If this is smaller than in @code{org-headline-levels}, each} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6849 @r{info/folding section can still contain children headlines.} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6850 toc: @r{Should the table of content @emph{initially} be visible?} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6851 @r{Even when @code{nil}, you can always get to the toc with @kbd{i}.} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6852 tdepth: @r{The depth of the table of contents. The defaults are taken from} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6853 @r{the variables @code{org-headline-levels} and @code{org-export-with-toc}.} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6854 ltoc: @r{Should there be short contents (children) in each section?} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6855 mouse: @r{Headings are highlighted when the mouse is over them. Should be} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6856 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6857 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6858 @r{default), only one such button will be present.} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6859 @end example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6860 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6861 You can choose default values for these options by customizing the variable |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6862 @code{org-infojs-options}. If you always want to apply the script to your |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6863 pages, configure the variable @code{org-export-html-use-infojs}. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6864 |
84308 | 6865 @node LaTeX export, XOXO export, HTML export, Exporting |
6866 @section LaTeX export | |
6867 @cindex LaTeX export | |
6868 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6869 Org mode contains a La@TeX{} exporter written by Bastien Guerry. |
84308 | 6870 |
6871 @menu | |
6872 * LaTeX export commands:: How to invoke LaTeX export | |
6873 * Quoting LaTeX code:: Incorporating literal LaTeX code | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6874 * Sectioning structure:: Changing sectioning in LaTeX output |
84308 | 6875 @end menu |
6876 | |
6877 @node LaTeX export commands, Quoting LaTeX code, LaTeX export, LaTeX export | |
6878 @subsection LaTeX export commands | |
6879 | |
6880 @table @kbd | |
6881 @kindex C-c C-e l | |
6882 @item C-c C-e l | |
6883 Export as La@TeX{} file @file{myfile.tex}. | |
6884 @kindex C-c C-e L | |
6885 @item C-c C-e L | |
6886 Export to a temporary buffer, do not create a file. | |
6887 @kindex C-c C-e v l | |
6888 @kindex C-c C-e v L | |
6889 @item C-c C-e v l | |
6890 @item C-c C-e v L | |
6891 Export only the visible part of the document. | |
6892 @item M-x org-export-region-as-latex | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6893 Convert the region to La@TeX{} under the assumption that it was Org mode |
84308 | 6894 syntax before. This is a global command that can be invoked in any |
6895 buffer. | |
6896 @item M-x org-replace-region-by-latex | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6897 Replace the active region (assumed to be in Org mode syntax) by La@TeX{} |
84308 | 6898 code. |
6899 @end table | |
6900 | |
6901 @cindex headline levels, for exporting | |
6902 In the exported version, the first 3 outline levels will become | |
6903 headlines, defining a general document structure. Additional levels | |
6904 will be exported as description lists. The exporter can ignore them or | |
6905 convert them to a custom string depending on | |
6906 @code{org-latex-low-levels}. | |
6907 | |
6908 If you want that transition to occur at a different level, specify it | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6909 with a numeric prefix argument. For example, |
84308 | 6910 |
6911 @example | |
6912 @kbd{C-2 C-c C-e l} | |
6913 @end example | |
6914 | |
6915 @noindent | |
6916 creates two levels of headings and does the rest as items. | |
6917 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6918 @node Quoting LaTeX code, Sectioning structure, LaTeX export commands, LaTeX export |
84308 | 6919 @subsection Quoting LaTeX code |
6920 | |
6921 Embedded La@TeX{} as described in @ref{Embedded LaTeX} will be correctly | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6922 inserted into the La@TeX{} file. Furthermore, you can add special code |
84308 | 6923 that should only be present in La@TeX{} export with the following |
6924 constructs: | |
6925 | |
6926 @example | |
6927 #+LaTeX: Literal LaTeX code for export | |
6928 @end example | |
6929 | |
6930 @noindent or | |
6931 | |
6932 @example | |
6933 #+BEGIN_LaTeX | |
6934 All lines between these markers are exported literally | |
6935 #+END_LaTeX | |
6936 @end example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6937 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6938 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6939 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6940 @node Sectioning structure, , Quoting LaTeX code, LaTeX export |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6941 @subsection Sectioning structure |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6942 @cindex LaTeX class |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6943 @cindex LaTeX sectioning structure |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6944 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6945 By default, the La@TeX{} output uses the class @code{article}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6946 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6947 You can change this globally by setting a different value for |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6948 @code{org-export-latex-default-class} or locally by adding an option |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6949 like @code{#+LaTeX_CLASS: myclass} in your file. The class should be |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6950 listed in @code{org-export-latex-classes}, where you can also define the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6951 sectioning structure for each class. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6952 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6953 |
84308 | 6954 @node XOXO export, iCalendar export, LaTeX export, Exporting |
6955 @section XOXO export | |
6956 @cindex XOXO export | |
6957 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6958 Org mode contains an exporter that produces XOXO-style output. |
84308 | 6959 Currently, this exporter only handles the general outline structure and |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6960 does not interpret any additional Org mode features. |
84308 | 6961 |
6962 @table @kbd | |
6963 @kindex C-c C-e x | |
6964 @item C-c C-e x | |
6965 Export as XOXO file @file{myfile.html}. | |
6966 @kindex C-c C-e v | |
6967 @item C-c C-e v x | |
6968 Export only the visible part of the document. | |
6969 @end table | |
6970 | |
6971 @node iCalendar export, Text interpretation, XOXO export, Exporting | |
6972 @section iCalendar export | |
6973 @cindex iCalendar export | |
6974 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6975 Some people like to use Org mode for keeping track of projects, but |
84308 | 6976 still prefer a standard calendar application for anniversaries and |
6977 appointments. In this case it can be useful to have deadlines and | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6978 other time-stamped items in Org files show up in the calendar |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6979 application. Org mode can export calendar information in the standard |
84308 | 6980 iCalendar format. If you also want to have TODO entries included in the |
6981 export, configure the variable @code{org-icalendar-include-todo}. | |
6982 | |
6983 @table @kbd | |
6984 @kindex C-c C-e i | |
6985 @item C-c C-e i | |
6986 Create iCalendar entries for the current file and store them in the same | |
6987 directory, using a file extension @file{.ics}. | |
6988 @kindex C-c C-e I | |
6989 @item C-c C-e I | |
6990 Like @kbd{C-c C-e i}, but do this for all files in | |
6991 @code{org-agenda-files}. For each of these files, a separate iCalendar | |
6992 file will be written. | |
6993 @kindex C-c C-e c | |
6994 @item C-c C-e c | |
6995 Create a single large iCalendar file from all files in | |
6996 @code{org-agenda-files} and write it to the file given by | |
6997 @code{org-combined-agenda-icalendar-file}. | |
6998 @end table | |
6999 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7000 The export will honor SUMMARY, DESCRIPTION and LOCATION properties if |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7001 the selected entries have them. If not, the summary will be derived |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7002 from the headline, and the description from the body (limited to |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7003 @code{org-icalendar-include-body} characters). |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7004 |
84308 | 7005 How this calendar is best read and updated, depends on the application |
7006 you are using. The FAQ covers this issue. | |
7007 | |
7008 | |
7009 @node Text interpretation, , iCalendar export, Exporting | |
7010 @section Text interpretation by the exporter | |
7011 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7012 The exporter backends interpret additional structure in the Org file |
84308 | 7013 in order to produce better output. |
7014 | |
7015 @menu | |
7016 * Comment lines:: Some lines will not be exported | |
7017 * Initial text:: Text before the first headline | |
7018 * Footnotes:: Numbers like [1] | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7019 * Quoted examples:: Inserting quoted chunks of text |
84308 | 7020 * Enhancing text:: Subscripts, symbols and more |
7021 * Export options:: How to influence the export settings | |
7022 @end menu | |
7023 | |
7024 @node Comment lines, Initial text, Text interpretation, Text interpretation | |
7025 @subsection Comment lines | |
7026 @cindex comment lines | |
7027 @cindex exporting, not | |
7028 | |
7029 Lines starting with @samp{#} in column zero are treated as comments | |
7030 and will never be exported. Also entire subtrees starting with the | |
7031 word @samp{COMMENT} will never be exported. | |
7032 | |
7033 @table @kbd | |
7034 @kindex C-c ; | |
7035 @item C-c ; | |
7036 Toggle the COMMENT keyword at the beginning of an entry. | |
7037 @end table | |
7038 | |
7039 @node Initial text, Footnotes, Comment lines, Text interpretation | |
7040 @subsection Text before the first headline | |
7041 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7042 Org mode normally ignores any text before the first headline when |
84308 | 7043 exporting, leaving this region for internal links to speed up navigation |
7044 etc. However, in publishing-oriented files, you might want to have some | |
7045 text before the first headline, like a small introduction, special HTML | |
7046 code with a navigation bar, etc. You can ask to have this part of the | |
7047 file exported as well by setting the variable | |
7048 @code{org-export-skip-text-before-1st-heading} to @code{nil}. On a | |
7049 per-file basis, you can get the same effect with | |
7050 | |
7051 @example | |
7052 #+OPTIONS: skip:nil | |
7053 @end example | |
7054 | |
7055 The text before the first headline will be fully processed | |
7056 (@pxref{Enhancing text}), and the first non-comment line becomes the | |
7057 title of the exported document. If you need to include literal HTML, | |
7058 use the special constructs described in @ref{Quoting HTML tags}. The | |
7059 table of contents is normally inserted directly before the first | |
7060 headline of the file. If you would like to get it to a different | |
7061 location, insert the string @code{[TABLE-OF-CONTENTS]} on a line by | |
7062 itself at the desired location. | |
7063 | |
7064 Finally, if you want to use the space before the first headline for | |
7065 internal purposes, but @emph{still} want to place something before the | |
7066 first headline when exporting the file, you can use the @code{#+TEXT} | |
7067 construct: | |
7068 | |
7069 @example | |
7070 #+OPTIONS: skip:t | |
7071 #+TEXT: This text will go before the *first* headline. | |
7072 #+TEXT: We place the table of contents here: | |
7073 #+TEXT: [TABLE-OF-CONTENTS] | |
7074 #+TEXT: This goes between the table of contents and the first headline | |
7075 @end example | |
7076 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7077 @node Footnotes, Quoted examples, Initial text, Text interpretation |
84308 | 7078 @subsection Footnotes |
7079 @cindex footnotes | |
7080 @cindex @file{footnote.el} | |
7081 | |
7082 Numbers in square brackets are treated as footnotes, so that you can use | |
7083 the Emacs package @file{footnote.el} to create footnotes. For example: | |
7084 | |
7085 @example | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7086 The Org homepage[1] clearly needs help from |
84308 | 7087 a good web designer. |
7088 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7089 [1] The link is: http://orgmode.org |
84308 | 7090 @end example |
7091 | |
7092 @noindent | |
7093 @kindex C-c ! | |
7094 Note that the @file{footnote} package uses @kbd{C-c !} to invoke its | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7095 commands. This binding conflicts with the Org mode command for |
84308 | 7096 inserting inactive time stamps. You could use the variable |
7097 @code{footnote-prefix} to switch footnotes commands to another key. Or, | |
7098 if you are too used to this binding, you could use | |
7099 @code{org-replace-disputed-keys} and @code{org-disputed-keys} to change | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7100 the settings in Org. |
84308 | 7101 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7102 @node Quoted examples, Enhancing text, Footnotes, Text interpretation |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7103 @subsection Quoted examples |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7104 @cindex quoted examples |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7105 @cindex examples, quoted |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7106 @cindex text, fixed width |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7107 @cindex fixed width text |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7108 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7109 When writing technical documents, you often need to insert examples that |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7110 are not further interpreted by Org mode. For historical reasons, there |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7111 are several ways to do this: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7112 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7113 @itemize @bullet |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7114 @item |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7115 If a headline starts with the word @samp{QUOTE}, the text below the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7116 headline will be typeset as fixed-width, to allow quoting of computer |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7117 codes etc. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7118 @item |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7119 Lines starting with @samp{:} are also typeset in fixed-width font. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7120 @table @kbd |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7121 @kindex C-c : |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7122 @item C-c : |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7123 Toggle fixed-width for entry (QUOTE) or region, see below. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7124 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7125 @item |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7126 Finally, text between |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7127 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7128 #+BEGIN_EXAMPLE |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7129 quoted text |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7130 #+END_EXAMPLE |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7131 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7132 will also be exported in this way. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7133 @end itemize |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7134 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7135 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7136 @node Enhancing text, Export options, Quoted examples, Text interpretation |
84308 | 7137 @subsection Enhancing text for export |
7138 @cindex enhancing text | |
7139 @cindex richer text | |
7140 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7141 Some of the export backends of Org mode allow for sophisticated text |
84308 | 7142 formatting, this is true in particular for the HTML and La@TeX{} |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7143 backends. Org mode has a number of typing conventions that allow to |
84308 | 7144 produce a richly formatted output. |
7145 | |
7146 @itemize @bullet | |
7147 | |
7148 @cindex hand-formatted lists | |
7149 @cindex lists, hand-formatted | |
7150 @item | |
7151 Plain lists @samp{-}, @samp{*} or @samp{+} as bullet, or with @samp{1.} | |
7152 or @samp{2)} as enumerator will be recognized and transformed if the | |
7153 backend supports lists. See @xref{Plain lists}. | |
7154 | |
7155 @cindex underlined text | |
7156 @cindex bold text | |
7157 @cindex italic text | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7158 @cindex verbatim text |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7159 @item |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7160 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7161 and @code{~verbatim~}, and, if you must, @samp{+strikethrough+}. Text |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7162 in the code and verbatim string is not processed for Org mode specific |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7163 syntax, it is exported verbatim. |
84308 | 7164 |
7165 @cindex horizontal rules, in exported files | |
7166 @item | |
7167 A line consisting of only dashes, and at least 5 of them, will be | |
7168 exported as a horizontal line (@samp{<hr/>} in HTML). | |
7169 | |
7170 @cindex LaTeX fragments, export | |
7171 @cindex TeX macros, export | |
7172 @item | |
7173 Many @TeX{} macros and entire La@TeX{} fragments are converted into HTML | |
7174 entities or images (@pxref{Embedded LaTeX}). | |
7175 | |
7176 @cindex tables, export | |
7177 @item | |
7178 Tables are transformed into native tables under the exporter, if the | |
7179 export backend supports this. Data fields before the first horizontal | |
7180 separator line will be formatted as table header fields. | |
7181 | |
7182 @cindex fixed width | |
7183 @item | |
7184 If a headline starts with the word @samp{QUOTE}, the text below the | |
7185 headline will be typeset as fixed-width, to allow quoting of computer | |
7186 codes etc. Lines starting with @samp{:} are also typeset in fixed-width | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7187 font. |
84308 | 7188 @table @kbd |
7189 @kindex C-c : | |
7190 @item C-c : | |
7191 Toggle fixed-width for entry (QUOTE) or region, see below. | |
7192 @end table | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7193 Finally, text between |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7194 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7195 #+BEGIN_EXAMPLE |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7196 quoted text |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7197 #+END_EXAMPLE |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7198 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7199 will also be exported in this way. |
84308 | 7200 |
7201 @cindex linebreak, forced | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7202 @item |
84308 | 7203 A double backslash @emph{at the end of a line} enforces a line break at |
7204 this position. | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7205 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7206 @cindex HTML entities, LaTeX entities |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7207 @item |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7208 Strings like @code{\alpha} will be exported as @code{α}, in the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7209 HTML output. These strings are exported as @code{$\alpha$} in the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7210 La@TeX{} output. Similarly, @code{\nbsp} will become @code{ } in |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7211 HTML and in La@TeX{}. This applies for a long list of entities, see |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7212 the variable @code{org-html-entities} for the complete list. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7213 @c FIXME |
84308 | 7214 @end itemize |
7215 | |
7216 If these conversions conflict with your habits of typing ASCII text, | |
7217 they can all be turned off with corresponding variables. See the | |
7218 customization group @code{org-export-general}, and the following section | |
7219 which explains how to set export options with special lines in a | |
7220 buffer. | |
7221 | |
7222 | |
7223 @node Export options, , Enhancing text, Text interpretation | |
7224 @subsection Export options | |
7225 @cindex options, for export | |
7226 | |
7227 @cindex completion, of option keywords | |
7228 The exporter recognizes special lines in the buffer which provide | |
7229 additional information. These lines may be put anywhere in the file. | |
7230 The whole set of lines can be inserted into the buffer with @kbd{C-c | |
7231 C-e t}. For individual lines, a good way to make sure the keyword is | |
7232 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion | |
7233 (@pxref{Completion}). | |
7234 | |
7235 @table @kbd | |
7236 @kindex C-c C-e t | |
7237 @item C-c C-e t | |
7238 Insert template with export options, see example below. | |
7239 @end table | |
7240 | |
7241 @example | |
7242 #+TITLE: the title to be shown (default is the buffer name) | |
7243 #+AUTHOR: the author (default taken from @code{user-full-name}) | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7244 #+DATE: A date, fixed, of a format string for @code{format-time-string} |
84308 | 7245 #+EMAIL: his/her email address (default from @code{user-mail-address}) |
7246 #+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language}) | |
7247 #+TEXT: Some descriptive text to be inserted at the beginning. | |
7248 #+TEXT: Several lines may be given. | |
7249 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ... | |
7250 @end example | |
7251 | |
7252 @noindent | |
7253 The OPTIONS line is a compact form to specify export settings. Here | |
7254 you can: | |
7255 @cindex headline levels | |
7256 @cindex section-numbers | |
7257 @cindex table of contents | |
7258 @cindex linebreak preservation | |
7259 @cindex quoted HTML tags | |
7260 @cindex fixed-width sections | |
7261 @cindex tables | |
7262 @cindex @TeX{}-like syntax for sub- and superscripts | |
7263 @cindex footnotes | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7264 @cindex special strings |
84308 | 7265 @cindex emphasized text |
7266 @cindex @TeX{} macros | |
7267 @cindex La@TeX{} fragments | |
7268 @cindex author info, in export | |
7269 @cindex time info, in export | |
7270 @example | |
7271 H: @r{set the number of headline levels for export} | |
7272 num: @r{turn on/off section-numbers} | |
7273 toc: @r{turn on/off table of contents, or set level limit (integer)} | |
7274 \n: @r{turn on/off linebreak-preservation} | |
7275 @@: @r{turn on/off quoted HTML tags} | |
7276 :: @r{turn on/off fixed-width sections} | |
7277 |: @r{turn on/off tables} | |
7278 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If} | |
7279 @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but} | |
7280 @r{the simple @code{a_b} will be left as it is.} | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7281 -: @r{turn on/off conversion of special strings.} |
84308 | 7282 f: @r{turn on/off foototes like this[1].} |
7283 *: @r{turn on/off emphasized text (bold, italic, underlined)} | |
7284 TeX: @r{turn on/off simple @TeX{} macros in plain text} | |
7285 LaTeX: @r{turn on/off La@TeX{} fragments} | |
7286 skip: @r{turn on/off skipping the text before the first heading} | |
7287 author: @r{turn on/off inclusion of author name/email into exported file} | |
7288 timestamp: @r{turn on/off inclusion creation time into exported file} | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7289 d: @r{turn on/off inclusion of drawers} |
84308 | 7290 @end example |
7291 | |
7292 These options take effect in both the HTML and La@TeX{} export, except | |
7293 for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and | |
7294 @code{nil} for the La@TeX{} export. | |
7295 | |
7296 @node Publishing, Miscellaneous, Exporting, Top | |
7297 @chapter Publishing | |
7298 @cindex publishing | |
7299 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7300 Org includes@footnote{@file{org-publish.el} is not distributed with |
84308 | 7301 Emacs 21, if you are still using Emacs 21, you need you need to download |
7302 this file separately.} a publishing management system that allows you to | |
7303 configure automatic HTML conversion of @emph{projects} composed of | |
7304 interlinked org files. This system is called @emph{org-publish}. You can | |
7305 also configure org-publish to automatically upload your exported HTML | |
7306 pages and related attachments, such as images and source code files, to | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7307 a web server. Org-publish turns Org into a web-site authoring tool. |
84308 | 7308 |
7309 You can also use Org-publish to convert files into La@TeX{}, or even | |
7310 combine HTML and La@TeX{} conversion so that files are available in both | |
7311 formats on the server@footnote{Since La@TeX{} files on a server are not | |
7312 that helpful, you surely want to perform further conversion on them -- | |
7313 e.g. convert them to @code{PDF} format.}. | |
7314 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7315 Org-publish has been contributed to Org by David O'Toole. |
84308 | 7316 |
7317 @menu | |
7318 * Configuration:: Defining projects | |
7319 * Sample configuration:: Example projects | |
7320 * Triggering publication:: Publication commands | |
7321 @end menu | |
7322 | |
7323 @node Configuration, Sample configuration, Publishing, Publishing | |
7324 @section Configuration | |
7325 | |
7326 Publishing needs significant configuration to specify files, destination | |
7327 and many other properties of a project. | |
7328 | |
7329 @menu | |
7330 * Project alist:: The central configuration variable | |
7331 * Sources and destinations:: From here to there | |
7332 * Selecting files:: What files are part of the project? | |
7333 * Publishing action:: Setting the function doing the publishing | |
7334 * Publishing options:: Tweaking HTML export | |
7335 * Publishing links:: Which links keep working after publishing? | |
7336 * Project page index:: Publishing a list of project files | |
7337 @end menu | |
7338 | |
7339 @node Project alist, Sources and destinations, Configuration, Configuration | |
7340 @subsection The variable @code{org-publish-project-alist} | |
7341 @cindex org-publish-project-alist | |
7342 @cindex projects, for publishing | |
7343 | |
7344 Org-publish is configured almost entirely through setting the value of | |
7345 one variable, called @code{org-publish-project-alist}. | |
7346 Each element of the list configures one project, and may be in one of | |
7347 the two following forms: | |
7348 | |
7349 @lisp | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7350 ("project-name" :property value :property value ...) |
84308 | 7351 |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7352 @r{or} |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7353 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7354 ("project-name" :components ("project-name" "project-name" ...)) |
84308 | 7355 |
7356 @end lisp | |
7357 | |
7358 In both cases, projects are configured by specifying property values. | |
7359 A project defines the set of files that will be published, as well as | |
7360 the publishing configuration to use when publishing those files. When | |
7361 a project takes the second form listed above, the individual members | |
7362 of the ``components'' property are taken to be components of the | |
7363 project, which group together files requiring different publishing | |
7364 options. When you publish such a ``meta-project'' all the components | |
7365 will also publish. | |
7366 | |
7367 @node Sources and destinations, Selecting files, Project alist, Configuration | |
7368 @subsection Sources and destinations for files | |
7369 @cindex directories, for publishing | |
7370 | |
7371 Most properties are optional, but some should always be set. In | |
7372 particular, org-publish needs to know where to look for source files, | |
7373 and where to put published files. | |
7374 | |
7375 @multitable @columnfractions 0.3 0.7 | |
7376 @item @code{:base-directory} | |
7377 @tab Directory containing publishing source files | |
7378 @item @code{:publishing-directory} | |
7379 @tab Directory (possibly remote) where output files will be published. | |
7380 @item @code{:preparation-function} | |
7381 @tab Function called before starting publishing process, for example to | |
7382 run @code{make} for updating files to be published. | |
7383 @end multitable | |
7384 @noindent | |
7385 | |
7386 @node Selecting files, Publishing action, Sources and destinations, Configuration | |
7387 @subsection Selecting files | |
7388 @cindex files, selecting for publishing | |
7389 | |
7390 By default, all files with extension @file{.org} in the base directory | |
7391 are considered part of the project. This can be modified by setting the | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7392 properties |
84308 | 7393 @multitable @columnfractions 0.25 0.75 |
7394 @item @code{:base-extension} | |
7395 @tab Extension (without the dot!) of source files. This actually is a | |
7396 regular expression. | |
7397 | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7398 @item @code{:exclude} |
84308 | 7399 @tab Regular expression to match file names that should not be |
7400 published, even though they have been selected on the basis of their | |
7401 extension. | |
7402 | |
7403 @item @code{:include} | |
7404 @tab List of files to be included regardless of @code{:base-extension} | |
7405 and @code{:exclude}. | |
7406 @end multitable | |
7407 | |
7408 @node Publishing action, Publishing options, Selecting files, Configuration | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7409 @subsection Publishing action |
84308 | 7410 @cindex action, for publishing |
7411 | |
7412 Publishing means that a file is copied to the destination directory and | |
7413 possibly transformed in the process. The default transformation is to | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7414 export Org files as HTML files, and this is done by the function |
84308 | 7415 @code{org-publish-org-to-html} which calls the HTML exporter |
7416 (@pxref{HTML export}). But you also can publish your files in La@TeX{} by | |
7417 using the function @code{org-publish-org-to-latex} instead. Other files | |
7418 like images only need to be copied to the publishing destination. For | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7419 non-Org files, you need to specify the publishing function. |
84308 | 7420 |
7421 | |
7422 @multitable @columnfractions 0.3 0.7 | |
7423 @item @code{:publishing-function} | |
7424 @tab Function executing the publication of a file. This may also be a | |
7425 list of functions, which will all be called in turn. | |
7426 @end multitable | |
7427 | |
7428 The function must accept two arguments: a property list containing at | |
7429 least a @code{:publishing-directory} property, and the name of the file | |
7430 to be published. It should take the specified file, make the necessary | |
7431 transformation (if any) and place the result into the destination folder. | |
7432 You can write your own publishing function, but @code{org-publish} | |
7433 provides one for attachments (files that only need to be copied): | |
7434 @code{org-publish-attachment}. | |
7435 | |
7436 @node Publishing options, Publishing links, Publishing action, Configuration | |
7437 @subsection Options for the HTML/LaTeX exporters | |
7438 @cindex options, for publishing | |
7439 | |
7440 The property list can be used to set many export options for the HTML | |
7441 and La@TeX{} exporters. In most cases, these properties correspond to user | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7442 variables in Org. The table below lists these properties along |
84308 | 7443 with the variable they belong to. See the documentation string for the |
7444 respective variable for details. | |
7445 | |
7446 @multitable @columnfractions 0.3 0.7 | |
7447 @item @code{:language} @tab @code{org-export-default-language} | |
7448 @item @code{:headline-levels} @tab @code{org-export-headline-levels} | |
7449 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers} | |
7450 @item @code{:table-of-contents} @tab @code{org-export-with-toc} | |
7451 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees} | |
7452 @item @code{:emphasize} @tab @code{org-export-with-emphasize} | |
7453 @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts} | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7454 @item @code{:special-strings} @tab @code{org-export-with-special-strings} |
84308 | 7455 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros} |
7456 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments} | |
7457 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width} | |
7458 @item @code{:timestamps} .@tab @code{org-export-with-timestamps} | |
7459 @item @code{:tags} .@tab @code{org-export-with-tags} | |
7460 @item @code{:tables} @tab @code{org-export-with-tables} | |
7461 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line} | |
7462 @item @code{:style} @tab @code{org-export-html-style} | |
7463 @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html} | |
7464 @item @code{:inline-images} @tab @code{org-export-html-inline-images} | |
7465 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand} | |
7466 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp} | |
7467 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory} | |
7468 @item @code{:preamble} @tab @code{org-export-html-preamble} | |
7469 @item @code{:postamble} @tab @code{org-export-html-postamble} | |
7470 @item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble} | |
7471 @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble} | |
7472 @item @code{:author} @tab @code{user-full-name} | |
7473 @item @code{:email} @tab @code{user-mail-address} | |
7474 @end multitable | |
7475 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7476 If you use several email addresses, separate them by a semi-column. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7477 |
84308 | 7478 Most of the @code{org-export-with-*} variables have the same effect in |
7479 both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and | |
7480 @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the | |
7481 La@TeX{} export. | |
7482 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7483 When a property is given a value in @code{org-publish-project-alist}, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7484 its setting overrides the value of the corresponding user variable (if |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7485 any) during publishing. Options set within a file (@pxref{Export |
84308 | 7486 options}), however, override everything. |
7487 | |
7488 @node Publishing links, Project page index, Publishing options, Configuration | |
7489 @subsection Links between published files | |
7490 @cindex links, publishing | |
7491 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7492 To create a link from one Org file to another, you would use |
84308 | 7493 something like @samp{[[file:foo.org][The foo]]} or simply |
7494 @samp{file:foo.org.} (@pxref{Hyperlinks}). Upon publishing this link | |
7495 becomes a link to @file{foo.html}. In this way, you can interlink the | |
7496 pages of your "org web" project and the links will work as expected when | |
7497 you publish them to HTML. | |
7498 | |
7499 You may also link to related files, such as images. Provided you are | |
7500 careful with relative pathnames, and provided you have also configured | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7501 @code{org-publish} to upload the related files, these links will work |
84308 | 7502 too. @ref{Complex example} for an example of this usage. |
7503 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7504 Sometime an Org file to be published may contain links that are |
84308 | 7505 only valid in your production environment, but not in the publishing |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7506 location. In this case, use the property |
84308 | 7507 |
7508 @multitable @columnfractions 0.4 0.6 | |
7509 @item @code{:link-validation-function} | |
7510 @tab Function to validate links | |
7511 @end multitable | |
7512 | |
7513 @noindent | |
7514 to define a function for checking link validity. This function must | |
7515 accept two arguments, the file name and a directory relative to which | |
7516 the file name is interpreted in the production environment. If this | |
7517 function returns @code{nil}, then the HTML generator will only insert a | |
7518 description into the HTML file, but no link. One option for this | |
7519 function is @code{org-publish-validate-link} which checks if the given | |
7520 file is part of any project in @code{org-publish-project-alist}. | |
7521 | |
7522 @node Project page index, , Publishing links, Configuration | |
7523 @subsection Project page index | |
7524 @cindex index, of published pages | |
7525 | |
7526 The following properties may be used to control publishing of an | |
7527 index of files or summary page for a given project. | |
7528 | |
7529 @multitable @columnfractions 0.25 0.75 | |
7530 @item @code{:auto-index} | |
7531 @tab When non-nil, publish an index during org-publish-current-project or | |
7532 org-publish-all. | |
7533 | |
7534 @item @code{:index-filename} | |
7535 @tab Filename for output of index. Defaults to @file{index.org} (which | |
7536 becomes @file{index.html}). | |
7537 | |
7538 @item @code{:index-title} | |
7539 @tab Title of index page. Defaults to name of file. | |
7540 | |
7541 @item @code{:index-function} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7542 @tab Plug-in function to use for generation of index. |
84308 | 7543 Defaults to @code{org-publish-org-index}, which generates a plain list |
7544 of links to all files in the project. | |
7545 @end multitable | |
7546 | |
7547 @node Sample configuration, Triggering publication, Configuration, Publishing | |
7548 @section Sample configuration | |
7549 | |
7550 Below we provide two example configurations. The first one is a simple | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7551 project publishing only a set of Org files. The second example is |
84308 | 7552 more complex, with a multi-component project. |
7553 | |
7554 @menu | |
7555 * Simple example:: One-component publishing | |
7556 * Complex example:: A multi-component publishing example | |
7557 @end menu | |
7558 | |
7559 @node Simple example, Complex example, Sample configuration, Sample configuration | |
7560 @subsection Example: simple publishing configuration | |
7561 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7562 This example publishes a set of Org files to the @file{public_html} |
84308 | 7563 directory on the local machine. |
7564 | |
7565 @lisp | |
7566 (setq org-publish-project-alist | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7567 '(("org" |
84308 | 7568 :base-directory "~/org/" |
7569 :publishing-directory "~/public_html" | |
7570 :section-numbers nil | |
7571 :table-of-contents nil | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7572 :style "<link rel=stylesheet |
84308 | 7573 href=\"../other/mystyle.css\" |
7574 type=\"text/css\">"))) | |
7575 @end lisp | |
7576 | |
7577 @node Complex example, , Simple example, Sample configuration | |
7578 @subsection Example: complex publishing configuration | |
7579 | |
7580 This more complicated example publishes an entire website, including | |
7581 org files converted to HTML, image files, emacs lisp source code, and | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7582 style sheets. The publishing-directory is remote and private files are |
84308 | 7583 excluded. |
7584 | |
7585 To ensure that links are preserved, care should be taken to replicate | |
7586 your directory structure on the web server, and to use relative file | |
7587 paths. For example, if your org files are kept in @file{~/org} and your | |
7588 publishable images in @file{~/images}, you'd link to an image with | |
7589 @c | |
7590 @example | |
7591 file:../images/myimage.png | |
7592 @end example | |
7593 @c | |
7594 On the web server, the relative path to the image should be the | |
7595 same. You can accomplish this by setting up an "images" folder in the | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7596 right place on the web server, and publishing images to it. |
84308 | 7597 |
7598 @lisp | |
7599 (setq org-publish-project-alist | |
7600 '(("orgfiles" | |
7601 :base-directory "~/org/" | |
7602 :base-extension "org" | |
7603 :publishing-directory "/ssh:user@@host:~/html/notebook/" | |
7604 :publishing-function org-publish-org-to-html | |
7605 :exclude "PrivatePage.org" ;; regexp | |
7606 :headline-levels 3 | |
7607 :section-numbers nil | |
7608 :table-of-contents nil | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7609 :style "<link rel=stylesheet |
84308 | 7610 href=\"../other/mystyle.css\" type=\"text/css\">" |
7611 :auto-preamble t | |
7612 :auto-postamble nil) | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7613 |
84308 | 7614 ("images" |
7615 :base-directory "~/images/" | |
7616 :base-extension "jpg\\|gif\\|png" | |
7617 :publishing-directory "/ssh:user@@host:~/html/images/" | |
7618 :publishing-function org-publish-attachment) | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7619 |
84308 | 7620 ("other" |
7621 :base-directory "~/other/" | |
7622 :base-extension "css\\|el" | |
7623 :publishing-directory "/ssh:user@@host:~/html/other/" | |
7624 :publishing-function org-publish-attachment) | |
7625 ("website" :components ("orgfiles" "images" "other")))) | |
7626 @end lisp | |
7627 | |
7628 @node Triggering publication, , Sample configuration, Publishing | |
7629 @section Triggering publication | |
7630 | |
7631 Once org-publish is properly configured, you can publish with the | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7632 following functions: |
84308 | 7633 |
7634 @table @kbd | |
7635 @item C-c C-e C | |
7636 Prompt for a specific project and publish all files that belong to it. | |
7637 @item C-c C-e P | |
7638 Publish the project containing the current file. | |
7639 @item C-c C-e F | |
7640 Publish only the current file. | |
7641 @item C-c C-e A | |
7642 Publish all projects. | |
7643 @end table | |
7644 | |
7645 Org uses timestamps to track when a file has changed. The above | |
7646 functions normally only publish changed files. You can override this and | |
7647 force publishing of all files by giving a prefix argument. | |
7648 | |
7649 @node Miscellaneous, Extensions and Hacking, Publishing, Top | |
7650 @chapter Miscellaneous | |
7651 | |
7652 @menu | |
7653 * Completion:: M-TAB knows what you need | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7654 * Customization:: Adapting Org to your taste |
84308 | 7655 * In-buffer settings:: Overview of the #+KEYWORDS |
7656 * The very busy C-c C-c key:: When in doubt, press C-c C-c | |
7657 * Clean view:: Getting rid of leading stars in the outline | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7658 * TTY keys:: Using Org on a tty |
84308 | 7659 * Interaction:: Other Emacs packages |
7660 * Bugs:: Things which do not work perfectly | |
7661 @end menu | |
7662 | |
7663 @node Completion, Customization, Miscellaneous, Miscellaneous | |
7664 @section Completion | |
7665 @cindex completion, of @TeX{} symbols | |
7666 @cindex completion, of TODO keywords | |
7667 @cindex completion, of dictionary words | |
7668 @cindex completion, of option keywords | |
7669 @cindex completion, of tags | |
7670 @cindex completion, of property keys | |
7671 @cindex completion, of link abbreviations | |
7672 @cindex @TeX{} symbol completion | |
7673 @cindex TODO keywords completion | |
7674 @cindex dictionary word completion | |
7675 @cindex option keyword completion | |
7676 @cindex tag completion | |
7677 @cindex link abbreviations, completion of | |
7678 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7679 Org supports in-buffer completion. This type of completion does |
84308 | 7680 not make use of the minibuffer. You simply type a few letters into |
7681 the buffer and use the key to complete text right there. | |
7682 | |
7683 @table @kbd | |
7684 @kindex M-@key{TAB} | |
7685 @item M-@key{TAB} | |
7686 Complete word at point | |
7687 @itemize @bullet | |
7688 @item | |
7689 At the beginning of a headline, complete TODO keywords. | |
7690 @item | |
7691 After @samp{\}, complete @TeX{} symbols supported by the exporter. | |
7692 @item | |
7693 After @samp{*}, complete headlines in the current buffer so that they | |
7694 can be used in search links like @samp{[[*find this headline]]}. | |
7695 @item | |
7696 After @samp{:} in a headline, complete tags. The list of tags is taken | |
7697 from the variable @code{org-tag-alist} (possibly set through the | |
7698 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created | |
7699 dynamically from all tags used in the current buffer. | |
7700 @item | |
7701 After @samp{:} and not in a headline, complete property keys. The list | |
7702 of keys is constructed dynamically from all keys used in the current | |
7703 buffer. | |
7704 @item | |
7705 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}). | |
7706 @item | |
7707 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7708 @samp{OPTIONS} which set file-specific options for Org mode. When the |
84308 | 7709 option keyword is already complete, pressing @kbd{M-@key{TAB}} again |
7710 will insert example settings for this keyword. | |
7711 @item | |
7712 In the line after @samp{#+STARTUP: }, complete startup keywords, | |
7713 i.e. valid keys for this line. | |
7714 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7715 Elsewhere, complete dictionary words using Ispell. |
84308 | 7716 @end itemize |
7717 @end table | |
7718 | |
7719 @node Customization, In-buffer settings, Completion, Miscellaneous | |
7720 @section Customization | |
7721 @cindex customization | |
7722 @cindex options, for customization | |
7723 @cindex variables, for customization | |
7724 | |
7725 There are more than 180 variables that can be used to customize | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7726 Org. For the sake of compactness of the manual, I am not |
84308 | 7727 describing the variables here. A structured overview of customization |
7728 variables is available with @kbd{M-x org-customize}. Or select | |
7729 @code{Browse Org Group} from the @code{Org->Customization} menu. Many | |
7730 settings can also be activated on a per-file basis, by putting special | |
7731 lines into the buffer (@pxref{In-buffer settings}). | |
7732 | |
7733 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous | |
7734 @section Summary of in-buffer settings | |
7735 @cindex in-buffer settings | |
7736 @cindex special keywords | |
7737 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7738 Org mode uses special lines in the buffer to define settings on a |
84308 | 7739 per-file basis. These lines start with a @samp{#+} followed by a |
7740 keyword, a colon, and then individual words defining a setting. Several | |
7741 setting words can be in the same line, but you can also have multiple | |
7742 lines for the keyword. While these settings are described throughout | |
7743 the manual, here is a summary. After changing any of those lines in the | |
7744 buffer, press @kbd{C-c C-c} with the cursor still in the line to | |
7745 activate the changes immediately. Otherwise they become effective only | |
7746 when the file is visited again in a new Emacs session. | |
7747 | |
7748 @table @kbd | |
7749 @item #+ARCHIVE: %s_done:: | |
7750 This line sets the archive location for the agenda file. It applies for | |
7751 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end | |
7752 of the file. The first such line also applies to any entries before it. | |
7753 The corresponding variable is @code{org-archive-location}. | |
7754 @item #+CATEGORY: | |
7755 This line sets the category for the agenda file. The category applies | |
7756 for all subsequent lines until the next @samp{#+CATEGORY} line, or the | |
7757 end of the file. The first such line also applies to any entries before it. | |
7758 @item #+COLUMNS: %25ITEM ..... | |
7759 Set the default format for columns view. This format applies when | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7760 columns view is invoked in location where no @code{COLUMNS} property |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7761 applies. |
84308 | 7762 @item #+CONSTANTS: name1=value1 ... |
7763 Set file-local values for constants to be used in table formulas. This | |
7764 line set the local variable @code{org-table-formula-constants-local}. | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7765 The global version of this variable is |
84308 | 7766 @code{org-table-formula-constants}. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7767 @item #+DRAWERS: NAME1 ..... |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7768 Set the file-local set of drawers. The corresponding global variable is |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7769 @code{org-drawers}. |
84308 | 7770 @item #+LINK: linkword replace |
7771 These lines (several are allowed) specify link abbreviations. | |
7772 @xref{Link abbreviations}. The corresponding variable is | |
7773 @code{org-link-abbrev-alist}. | |
7774 @item #+PRIORITIES: highest lowest default | |
7775 This line sets the limits and the default for the priorities. All three | |
7776 must be either letters A-Z or numbers 0-9. The highest priority must | |
7777 have a lower ASCII number that the lowest priority. | |
7778 @item #+PROPERTY: Property_Name Value | |
7779 This line sets a default inheritance value for entries in the current | |
7780 buffer, most useful for specifying the allowed values of a property. | |
7781 @item #+STARTUP: | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7782 This line sets options to be used at startup of Org mode, when an |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7783 Org file is being visited. The first set of options deals with the |
84308 | 7784 initial visibility of the outline tree. The corresponding variable for |
7785 global default settings is @code{org-startup-folded}, with a default | |
7786 value @code{t}, which means @code{overview}. | |
7787 @cindex @code{overview}, STARTUP keyword | |
7788 @cindex @code{content}, STARTUP keyword | |
7789 @cindex @code{showall}, STARTUP keyword | |
7790 @example | |
7791 overview @r{top-level headlines only} | |
7792 content @r{all headlines} | |
7793 showall @r{no folding at all, show everything} | |
7794 @end example | |
7795 Then there are options for aligning tables upon visiting a file. This | |
7796 is useful in files containing narrowed table columns. The corresponding | |
7797 variable is @code{org-startup-align-all-tables}, with a default value | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7798 @code{nil}. |
84308 | 7799 @cindex @code{align}, STARTUP keyword |
7800 @cindex @code{noalign}, STARTUP keyword | |
7801 @example | |
7802 align @r{align all tables} | |
7803 noalign @r{don't align tables on startup} | |
7804 @end example | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7805 Logging closing and reinstating TODO items, and clock intervals |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7806 (variables @code{org-log-done}, @code{org-log-note-clock-out}, and |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7807 @code{org-log-repeat}) can be configured using these options. |
84308 | 7808 @cindex @code{logdone}, STARTUP keyword |
7809 @cindex @code{lognotedone}, STARTUP keyword | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7810 @cindex @code{nologdone}, STARTUP keyword |
84308 | 7811 @cindex @code{lognoteclock-out}, STARTUP keyword |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7812 @cindex @code{nolognoteclock-out}, STARTUP keyword |
84308 | 7813 @cindex @code{logrepeat}, STARTUP keyword |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7814 @cindex @code{lognoterepeat}, STARTUP keyword |
84308 | 7815 @cindex @code{nologrepeat}, STARTUP keyword |
7816 @example | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7817 logdone @r{record a timestamp when an item is marked DONE} |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7818 lognotedone @r{record timestamp and a note when DONE} |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7819 nologdone @r{don't record when items are marked DONE} |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7820 logrepeat @r{record a time when reinstating a repeating item} |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7821 lognoterepeat @r{record a note when reinstating a repeating item} |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7822 nologrepeat @r{do not record when reinstating repeating item} |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7823 lognoteclock-out @r{record a note when clocking out} |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7824 nolognoteclock-out @r{don't record a note when clocking out} |
84308 | 7825 @end example |
7826 Here are the options for hiding leading stars in outline headings. The | |
7827 corresponding variables are @code{org-hide-leading-stars} and | |
7828 @code{org-odd-levels-only}, both with a default setting @code{nil} | |
7829 (meaning @code{showstars} and @code{oddeven}). | |
7830 @cindex @code{hidestars}, STARTUP keyword | |
7831 @cindex @code{showstars}, STARTUP keyword | |
7832 @cindex @code{odd}, STARTUP keyword | |
7833 @cindex @code{even}, STARTUP keyword | |
7834 @example | |
7835 hidestars @r{make all but one of the stars starting a headline invisible.} | |
7836 showstars @r{show all stars starting a headline} | |
7837 odd @r{allow only odd outline levels (1,3,...)} | |
7838 oddeven @r{allow all outline levels} | |
7839 @end example | |
7840 To turn on custom format overlays over time stamps (variables | |
7841 @code{org-put-time-stamp-overlays} and | |
7842 @code{org-time-stamp-overlay-formats}), use | |
7843 @cindex @code{customtime}, STARTUP keyword | |
7844 @example | |
7845 customtime @r{overlay custom time format} | |
7846 @end example | |
7847 The following options influence the table spreadsheet (variable | |
7848 @code{constants-unit-system}). | |
7849 @cindex @code{constcgs}, STARTUP keyword | |
7850 @cindex @code{constSI}, STARTUP keyword | |
7851 @example | |
7852 constcgs @r{@file{constants.el} should use the c-g-s unit system} | |
7853 constSI @r{@file{constants.el} should use the SI unit system} | |
7854 @end example | |
7855 @item #+TAGS: TAG1(c1) TAG2(c2) | |
92148 | 7856 These lines (several such lines are allowed) specify the valid tags in |
84308 | 7857 this file, and (potentially) the corresponding @emph{fast tag selection} |
7858 keys. The corresponding variable is @code{org-tag-alist}. | |
7859 @item #+TBLFM: | |
7860 This line contains the formulas for the table directly above the line. | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7861 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS, #+DATE: |
84308 | 7862 These lines provide settings for exporting files. For more details see |
7863 @ref{Export options}. | |
7864 @item #+SEQ_TODO: #+TYP_TODO: | |
7865 These lines set the TODO keywords and their interpretation in the | |
7866 current file. The corresponding variables are @code{org-todo-keywords} | |
7867 and @code{org-todo-interpretation}. | |
7868 @end table | |
7869 | |
7870 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous | |
7871 @section The very busy C-c C-c key | |
7872 @kindex C-c C-c | |
7873 @cindex C-c C-c, overview | |
7874 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7875 The key @kbd{C-c C-c} has many purposes in Org, which are all |
84308 | 7876 mentioned scattered throughout this manual. One specific function of |
7877 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7878 other circumstances it means something like @emph{Hey Org, look |
84308 | 7879 here and update according to what you see here}. Here is a summary of |
7880 what this means in different contexts. | |
7881 | |
7882 @itemize @minus | |
7883 @item | |
7884 If there are highlights in the buffer from the creation of a sparse | |
7885 tree, or from clock display, remove these highlights. | |
7886 @item | |
7887 If the cursor is in one of the special @code{#+KEYWORD} lines, this | |
7888 triggers scanning the buffer for these lines and updating the | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7889 information. |
84308 | 7890 @item |
7891 If the cursor is inside a table, realign the table. This command | |
7892 works even if the automatic table editor has been turned off. | |
7893 @item | |
7894 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to | |
7895 the entire table. | |
7896 @item | |
7897 If the cursor is inside a table created by the @file{table.el} package, | |
7898 activate that table. | |
7899 @item | |
7900 If the current buffer is a remember buffer, close the note and file it. | |
7901 With a prefix argument, file it, without further interaction, to the | |
7902 default location. | |
7903 @item | |
7904 If the cursor is on a @code{<<<target>>>}, update radio targets and | |
7905 corresponding links in this buffer. | |
7906 @item | |
7907 If the cursor is in a property line or at the start or end of a property | |
7908 drawer, offer property commands. | |
7909 @item | |
7910 If the cursor is in a plain list item with a checkbox, toggle the status | |
7911 of the checkbox. | |
7912 @item | |
7913 If the cursor is on a numbered item in a plain list, renumber the | |
7914 ordered list. | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7915 @item |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7916 If the cursor is on the @code{#+BEGIN} line of a dynamical block, the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7917 block is updated. |
84308 | 7918 @end itemize |
7919 | |
7920 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous | |
7921 @section A cleaner outline view | |
7922 @cindex hiding leading stars | |
7923 @cindex clean outline view | |
7924 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7925 Some people find it noisy and distracting that the Org headlines |
84308 | 7926 are starting with a potentially large number of stars. For example |
7927 the tree from @ref{Headlines}: | |
7928 | |
7929 @example | |
7930 * Top level headline | |
7931 ** Second level | |
7932 *** 3rd level | |
7933 some text | |
7934 *** 3rd level | |
7935 more text | |
7936 * Another top level headline | |
7937 @end example | |
7938 | |
7939 @noindent | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7940 Unfortunately this is deeply ingrained into the code of Org and |
84308 | 7941 cannot be easily changed. You can, however, modify the display in such |
7942 a way that all leading stars become invisible and the outline more easy | |
7943 to read. To do this, customize the variable | |
7944 @code{org-hide-leading-stars} like this: | |
7945 | |
7946 @lisp | |
7947 (setq org-hide-leading-stars t) | |
7948 @end lisp | |
7949 | |
7950 @noindent | |
7951 or change this on a per-file basis with one of the lines (anywhere in | |
7952 the buffer) | |
7953 | |
7954 @example | |
7955 #+STARTUP: showstars | |
7956 #+STARTUP: hidestars | |
7957 @end example | |
7958 | |
7959 @noindent | |
7960 Press @kbd{C-c C-c} with the cursor in a @samp{STARTUP} line to activate | |
7961 the modifications. | |
7962 | |
7963 With stars hidden, the tree becomes: | |
7964 | |
7965 @example | |
7966 * Top level headline | |
7967 * Second level | |
7968 * 3rd level | |
7969 some text | |
7970 * 3rd level | |
7971 more text | |
7972 * Another top level headline | |
7973 @end example | |
7974 | |
7975 @noindent | |
7976 Note that the leading stars are not truly replaced by whitespace, they | |
7977 are only fontified with the face @code{org-hide} that uses the | |
7978 background color as font color. If you are not using either white or | |
7979 black background, you may have to customize this face to get the wanted | |
7980 effect. Another possibility is to set this font such that the extra | |
7981 stars are @i{almost} invisible, for example using the color | |
7982 @code{grey90} on a white background. | |
7983 | |
7984 Things become cleaner still if you skip all the even levels and use only | |
7985 odd levels 1, 3, 5..., effectively adding two stars to go from one | |
7986 outline level to the next: | |
7987 | |
7988 @example | |
7989 * Top level headline | |
7990 * Second level | |
7991 * 3rd level | |
7992 some text | |
7993 * 3rd level | |
7994 more text | |
7995 * Another top level headline | |
7996 @end example | |
7997 | |
7998 @noindent | |
7999 In order to make the structure editing and export commands handle this | |
8000 convention correctly, use | |
8001 | |
8002 @lisp | |
8003 (setq org-odd-levels-only t) | |
8004 @end lisp | |
8005 | |
8006 @noindent | |
8007 or set this on a per-file basis with one of the following lines (don't | |
8008 forget to press @kbd{C-c C-c} with the cursor in the startup line to | |
8009 activate changes immediately). | |
8010 | |
8011 @example | |
8012 #+STARTUP: odd | |
8013 #+STARTUP: oddeven | |
8014 @end example | |
8015 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8016 You can convert an Org file from single-star-per-level to the |
84308 | 8017 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels |
8018 RET} in that file. The reverse operation is @kbd{M-x | |
8019 org-convert-to-oddeven-levels}. | |
8020 | |
8021 @node TTY keys, Interaction, Clean view, Miscellaneous | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8022 @section Using Org on a tty |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8023 @cindex tty key bindings |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8024 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8025 Because Org contains a large number of commands, by default much of |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8026 Org's core commands are bound to keys that are generally not |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8027 accessible on a tty, such as the cursor keys (@key{left}, @key{right}, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8028 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8029 together with modifiers like @key{Meta} and/or @key{Shift}. To access |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8030 these commands on a tty when special keys are unavailable, the following |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8031 alternative bindings can be used. The tty bindings below will likely be |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8032 more cumbersome; you may find for some of the bindings below that a |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8033 customized work-around suits you better. For example, changing a time |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8034 stamp is really only fun with @kbd{S-@key{cursor}} keys, whereas on a |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8035 tty you would rather use @kbd{C-c .} to re-insert the timestamp. |
84308 | 8036 |
8037 @multitable @columnfractions 0.15 0.2 0.2 | |
8038 @item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2} | |
8039 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab | |
8040 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{@key{Esc} @key{left}} | |
8041 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab | |
8042 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{@key{Esc} @key{right}} | |
8043 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab | |
8044 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{@key{Esc} @key{up}} | |
8045 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab | |
8046 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{@key{Esc} @key{down}} | |
8047 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab | |
8048 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab | |
8049 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{@key{Esc} @key{RET}} | |
8050 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab | |
8051 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab | |
8052 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab | |
8053 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab | |
8054 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab | |
8055 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab | |
8056 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab | |
8057 @end multitable | |
8058 | |
8059 @node Interaction, Bugs, TTY keys, Miscellaneous | |
8060 @section Interaction with other packages | |
8061 @cindex packages, interaction with other | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8062 Org lives in the world of GNU Emacs and interacts in various ways |
84308 | 8063 with other code out there. |
8064 | |
8065 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8066 * Cooperation:: Packages Org cooperates with |
84308 | 8067 * Conflicts:: Packages that lead to conflicts |
8068 @end menu | |
8069 | |
8070 @node Cooperation, Conflicts, Interaction, Interaction | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8071 @subsection Packages that Org cooperates with |
84308 | 8072 |
8073 @table @asis | |
8074 @cindex @file{calc.el} | |
8075 @item @file{calc.el} by Dave Gillespie | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8076 Org uses the Calc package for implementing spreadsheet |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8077 functionality in its tables (@pxref{The spreadsheet}). Org |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8078 checks for the availability of Calc by looking for the function |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8079 @code{calc-eval} which should be autoloaded in your setup if Calc has |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8080 been installed properly. As of Emacs 22, Calc is part of the Emacs |
84308 | 8081 distribution. Another possibility for interaction between the two |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8082 packages is using Calc for embedded calculations. @xref{Embedded Mode, |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8083 , Embedded Mode, Calc, GNU Emacs Calc Manual}. |
84308 | 8084 @cindex @file{constants.el} |
8085 @item @file{constants.el} by Carsten Dominik | |
8086 In a table formula (@pxref{The spreadsheet}), it is possible to use | |
8087 names for natural constants or units. Instead of defining your own | |
8088 constants in the variable @code{org-table-formula-constants}, install | |
8089 the @file{constants} package which defines a large number of constants | |
8090 and units, and lets you use unit prefixes like @samp{M} for | |
8091 @samp{Mega} etc. You will need version 2.0 of this package, available | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8092 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for |
84308 | 8093 the function @code{constants-get}, which has to be autoloaded in your |
8094 setup. See the installation instructions in the file | |
8095 @file{constants.el}. | |
8096 @item @file{cdlatex.el} by Carsten Dominik | |
8097 @cindex @file{cdlatex.el} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8098 Org mode can make use of the CDLaTeX package to efficiently enter |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8099 La@TeX{} fragments into Org files. See @ref{CDLaTeX mode}. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8100 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8101 @cindex @file{imenu.el} |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8102 Imenu allows menu access to an index of items in a file. Org mode |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8103 supports Imenu - all you need to do to get the index is the following: |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8104 @lisp |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
8105 (add-hook 'org-mode-hook |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8106 (lambda () (imenu-add-to-menubar "Imenu"))) |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8107 @end lisp |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8108 By default the index is two levels deep - you can modify the depth using |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8109 the option @code{org-imenu-depth}. |
84308 | 8110 @item @file{remember.el} by John Wiegley |
8111 @cindex @file{remember.el} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8112 Org cooperates with remember, see @ref{Remember}. |
84308 | 8113 @file{Remember.el} is not part of Emacs, find it on the web. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8114 @item @file{speedbar.el} by Eric M. Ludlam |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8115 @cindex @file{speedbar.el} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8116 Speedbar is a package that creates a special frame displaying files and |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8117 index items in files. Org mode supports Speedbar and allows you to |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8118 drill into Org files directly from the Speedbar. It also allows to |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8119 restrict the scope of agenda commands to a file or a subtree by using |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8120 the command @kbd{<} in the Speedbar frame. |
84308 | 8121 @cindex @file{table.el} |
8122 @item @file{table.el} by Takaaki Ota | |
8123 @kindex C-c C-c | |
8124 @cindex table editor, @file{table.el} | |
8125 @cindex @file{table.el} | |
8126 | |
8127 Complex ASCII tables with automatic line wrapping, column- and | |
8128 row-spanning, and alignment can be created using the Emacs table | |
8129 package by Takaaki Ota (@uref{http://sourceforge.net/projects/table}, | |
8130 and also part of Emacs 22). | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8131 When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org mode |
84308 | 8132 will call @command{table-recognize-table} and move the cursor into the |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8133 table. Inside a table, the keymap of Org mode is inactive. In order |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8134 to execute Org mode-related commands, leave the table. |
84308 | 8135 |
8136 @table @kbd | |
8137 @kindex C-c C-c | |
8138 @item C-c C-c | |
8139 Recognize @file{table.el} table. Works when the cursor is in a | |
8140 table.el table. | |
8141 @c | |
8142 @kindex C-c ~ | |
8143 @item C-c ~ | |
8144 Insert a table.el table. If there is already a table at point, this | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8145 command converts it between the table.el format and the Org mode |
84308 | 8146 format. See the documentation string of the command |
8147 @code{org-convert-table} for the restrictions under which this is | |
8148 possible. | |
8149 @end table | |
8150 @file{table.el} is part of Emacs 22. | |
8151 @cindex @file{footnote.el} | |
8152 @item @file{footnote.el} by Steven L. Baur | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8153 Org mode recognizes numerical footnotes as provided by this package |
84308 | 8154 (@pxref{Footnotes}). |
8155 @end table | |
8156 | |
8157 @node Conflicts, , Cooperation, Interaction | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8158 @subsection Packages that lead to conflicts with Org mode |
84308 | 8159 |
8160 @table @asis | |
8161 | |
8162 @cindex @file{allout.el} | |
8163 @item @file{allout.el} by Ken Manheimer | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8164 Startup of Org may fail with the error message |
84308 | 8165 @code{(wrong-type-argument keymapp nil)} when there is an outdated |
8166 version @file{allout.el} on the load path, for example the version | |
8167 distributed with Emacs 21.x. Upgrade to Emacs 22 and this problem will | |
8168 disappear. If for some reason you cannot do this, make sure that org.el | |
8169 is loaded @emph{before} @file{allout.el}, for example by putting | |
8170 @code{(require 'org)} early enough into your @file{.emacs} file. | |
8171 | |
8172 @cindex @file{CUA.el} | |
8173 @item @file{CUA.el} by Kim. F. Storm | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8174 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8175 CUA mode (as well as pc-select-mode and s-region-mode) to select and |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8176 extend the region. If you want to use one of these packages along with |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8177 Org, configure the variable @code{org-replace-disputed-keys}. When |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8178 set, Org will move the following key bindings in Org files, and |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8179 in the agenda buffer (but not during date selection). |
84308 | 8180 |
8181 @example | |
8182 S-UP -> M-p S-DOWN -> M-n | |
8183 S-LEFT -> M-- S-RIGHT -> M-+ | |
8184 @end example | |
8185 | |
8186 Yes, these are unfortunately more difficult to remember. If you want | |
8187 to have other replacement keys, look at the variable | |
8188 @code{org-disputed-keys}. | |
8189 @item @file{windmove.el} by Hovav Shacham | |
8190 @cindex @file{windmove.el} | |
8191 Also this package uses the @kbd{S-<cursor>} keys, so everything written | |
8192 in the paragraph above about CUA mode also applies here. | |
8193 | |
8194 @cindex @file{footnote.el} | |
8195 @item @file{footnote.el} by Steven L. Baur | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8196 Org supports the syntax of the footnote package, but only the |
84308 | 8197 numerical footnote markers. Also, the default key for footnote |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8198 commands, @kbd{C-c !} is already used by Org. You could use the |
84308 | 8199 variable @code{footnote-prefix} to switch footnotes commands to another |
8200 key. Or, you could use @code{org-replace-disputed-keys} and | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8201 @code{org-disputed-keys} to change the settings in Org. |
84308 | 8202 |
8203 @end table | |
8204 | |
8205 | |
8206 @node Bugs, , Interaction, Miscellaneous | |
8207 @section Bugs | |
8208 @cindex bugs | |
8209 | |
8210 Here is a list of things that should work differently, but which I | |
8211 have found too hard to fix. | |
8212 | |
8213 @itemize @bullet | |
8214 @item | |
8215 If a table field starts with a link, and if the corresponding table | |
8216 column is narrowed (@pxref{Narrow columns}) to a width too small to | |
8217 display the link, the field would look entirely empty even though it is | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8218 not. To prevent this, Org throws an error. The work-around is to |
84308 | 8219 make the column wide enough to fit the link, or to add some text (at |
8220 least 2 characters) before the link in the same field. | |
8221 @item | |
8222 Narrowing table columns does not work on XEmacs, because the | |
8223 @code{format} function does not transport text properties. | |
8224 @item | |
8225 Text in an entry protected with the @samp{QUOTE} keyword should not | |
8226 autowrap. | |
8227 @item | |
8228 When the application called by @kbd{C-c C-o} to open a file link fails | |
8229 (for example because the application does not exist or refuses to open | |
8230 the file), it does so silently. No error message is displayed. | |
8231 @item | |
8232 Recalculating a table line applies the formulas from left to right. | |
8233 If a formula uses @emph{calculated} fields further down the row, | |
8234 multiple recalculation may be needed to get all fields consistent. You | |
8235 may use the command @code{org-table-iterate} (@kbd{C-u C-c *}) to | |
8236 recalculate until convergence. | |
8237 @item | |
8238 A single letter cannot be made bold, for example @samp{*a*}. | |
8239 @item | |
8240 The exporters work well, but could be made more efficient. | |
8241 @end itemize | |
8242 | |
8243 | |
8244 @node Extensions and Hacking, History and Acknowledgments, Miscellaneous, Top | |
8245 @appendix Extensions, Hooks and Hacking | |
8246 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8247 This appendix lists extensions for Org written by other authors. |
84308 | 8248 It also covers some aspects where users can extend the functionality of |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8249 Org. |
84308 | 8250 |
8251 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8252 * Extensions:: Existing 3rd-party extensions |
84308 | 8253 * Adding hyperlink types:: New custom link types |
8254 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs | |
8255 * Dynamic blocks:: Automatically filled blocks | |
8256 * Special agenda views:: Customized views | |
8257 * Using the property API:: Writing programs that use entry properties | |
8258 @end menu | |
8259 | |
8260 @node Extensions, Adding hyperlink types, Extensions and Hacking, Extensions and Hacking | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8261 @section Third-party extensions for Org |
84308 | 8262 @cindex extension, third-party |
8263 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8264 There are lots of extensions that have been written by other people. Most of |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8265 them have either been integrated into Org by now, or they can be found in the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8266 Org distribution, in the @file{contrib} directory. The list has gotten too |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8267 long to cover in any detail here, but there is a seaparate manual for these |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8268 extensions. |
84308 | 8269 |
8270 @node Adding hyperlink types, Tables in arbitrary syntax, Extensions, Extensions and Hacking | |
8271 @section Adding hyperlink types | |
8272 @cindex hyperlinks, adding new types | |
8273 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8274 Org has a large number of hyperlink types built-in |
84308 | 8275 (@pxref{Hyperlinks}). If you would like to add new link types, it |
8276 provides an interface for doing so. Lets look at an example file | |
8277 @file{org-man.el} that will add support for creating links like | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8278 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside |
84308 | 8279 emacs: |
8280 | |
8281 @lisp | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8282 ;;; org-man.el - Support for links to manpages in Org |
84308 | 8283 |
8284 (require 'org) | |
8285 | |
8286 (org-add-link-type "man" 'org-man-open) | |
8287 (add-hook 'org-store-link-functions 'org-man-store-link) | |
8288 | |
8289 (defcustom org-man-command 'man | |
8290 "The Emacs command to be used to display a man page." | |
8291 :group 'org-link | |
8292 :type '(choice (const man) (const woman))) | |
8293 | |
8294 (defun org-man-open (path) | |
8295 "Visit the manpage on PATH. | |
8296 PATH should be a topic that can be thrown at the man command." | |
8297 (funcall org-man-command path)) | |
8298 | |
8299 (defun org-man-store-link () | |
8300 "Store a link to a manpage." | |
8301 (when (memq major-mode '(Man-mode woman-mode)) | |
8302 ;; This is a man page, we do make this link | |
8303 (let* ((page (org-man-get-page-name)) | |
8304 (link (concat "man:" page)) | |
8305 (description (format "Manpage for %s" page))) | |
8306 (org-store-link-props | |
8307 :type "man" | |
8308 :link link | |
8309 :description description)))) | |
8310 | |
8311 (defun org-man-get-page-name () | |
8312 "Extract the page name from the buffer name." | |
8313 ;; This works for both `Man-mode' and `woman-mode'. | |
8314 (if (string-match " \\(\\S-+\\)\\*" (buffer-name)) | |
8315 (match-string 1 (buffer-name)) | |
8316 (error "Cannot create link to this man page"))) | |
8317 | |
8318 (provide 'org-man) | |
8319 | |
8320 ;;; org-man.el ends here | |
8321 @end lisp | |
8322 | |
8323 @noindent | |
8324 You would activate this new link type in @file{.emacs} with | |
8325 | |
8326 @lisp | |
8327 (require 'org-man) | |
8328 @end lisp | |
8329 | |
8330 @noindent | |
8331 Lets go through the file and see what it does. | |
8332 @enumerate | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
8333 @item |
84308 | 8334 It does @code{(require 'org)} to make sure that @file{org.el} has been |
8335 loaded. | |
8336 @item | |
8337 The next line calls @code{org-add-link-type} to define a new link type | |
8338 with prefix @samp{man}. The call also contains the name of a function | |
8339 that will be called to follow such a link. | |
8340 @item | |
8341 The next line adds a function to @code{org-store-link-functions}, in | |
8342 order to allow the command @kbd{C-c l} to record a useful link in a | |
8343 buffer displaying a man page. | |
8344 @end enumerate | |
8345 | |
8346 The rest of the file defines the necessary variables and functions. | |
8347 First there is a customization variable that determines which emacs | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8348 command should be used to display man pages. There are two options, |
84308 | 8349 @code{man} and @code{woman}. Then the function to follow a link is |
8350 defined. It gets the link path as an argument - in this case the link | |
8351 path is just a topic for the manual command. The function calls the | |
8352 value of @code{org-man-command} to display the man page. | |
8353 | |
8354 Finally the function @code{org-man-store-link} is defined. When you try | |
8355 to store a link with @kbd{C-c l}, also this function will be called to | |
8356 try to make a link. The function must first decide if it is supposed to | |
8357 create the link for this buffer type, we do this by checking the value | |
8358 of the variable @code{major-mode}. If not, the function must exit and | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8359 return the value @code{nil}. If yes, the link is created by getting the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8360 manual topic from the buffer name and prefixing it with the string |
84308 | 8361 @samp{man:}. Then it must call the command @code{org-store-link-props} |
8362 and set the @code{:type} and @code{:link} properties. Optionally you | |
8363 can also set the @code{:description} property to provide a default for | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8364 the link description when the link is later inserted into an Org |
84308 | 8365 buffer with @kbd{C-c C-l}. |
8366 | |
8367 @node Tables in arbitrary syntax, Dynamic blocks, Adding hyperlink types, Extensions and Hacking | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8368 @section Tables and lists in arbitrary syntax |
84308 | 8369 @cindex tables, in other modes |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8370 @cindex lists, in other modes |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8371 @cindex Orgtbl mode |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8372 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8373 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a |
84308 | 8374 frequent feature request has been to make it work with native tables in |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8375 specific languages, for example La@TeX{}. However, this is extremely |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8376 hard to do in a general way, would lead to a customization nightmare, |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8377 and would take away much of the simplicity of the Orgtbl mode table |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8378 editor. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8379 |
84308 | 8380 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8381 This appendix describes a different approach. We keep the Orgtbl mode |
84308 | 8382 table in its native format (the @i{source table}), and use a custom |
8383 function to @i{translate} the table to the correct syntax, and to | |
8384 @i{install} it in the right location (the @i{target table}). This puts | |
8385 the burden of writing conversion functions on the user, but it allows | |
8386 for a very flexible system. | |
8387 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8388 Bastien added the ability to do the same with lists. You can use Org's |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8389 facilities to edit and structure lists by turning @code{orgstruct-mode} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8390 on, then locally exporting such lists in another format (HTML, La@TeX{} |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8391 or Texinfo.) |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8392 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8393 |
84308 | 8394 @menu |
8395 * Radio tables:: Sending and receiving | |
8396 * A LaTeX example:: Step by step, almost a tutorial | |
8397 * Translator functions:: Copy and modify | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8398 * Radio lists:: Doing the same for lists |
84308 | 8399 @end menu |
8400 | |
8401 @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax | |
8402 @subsection Radio tables | |
8403 @cindex radio tables | |
8404 | |
8405 To define the location of the target table, you first need to create two | |
8406 lines that are comments in the current mode, but contain magic words for | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8407 Orgtbl mode to find. Orgtbl mode will insert the translated table |
84308 | 8408 between these lines, replacing whatever was there before. For example: |
8409 | |
8410 @example | |
8411 /* BEGIN RECEIVE ORGTBL table_name */ | |
8412 /* END RECEIVE ORGTBL table_name */ | |
8413 @end example | |
8414 | |
8415 @noindent | |
8416 Just above the source table, we put a special line that tells | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8417 Orgtbl mode how to translate this table and where to install it. For |
84308 | 8418 example: |
8419 @example | |
8420 #+ORGTBL: SEND table_name translation_function arguments.... | |
8421 @end example | |
8422 | |
8423 @noindent | |
8424 @code{table_name} is the reference name for the table that is also used | |
8425 in the receiver lines. @code{translation_function} is the Lisp function | |
8426 that does the translation. Furthermore, the line can contain a list of | |
8427 arguments (alternating key and value) at the end. The arguments will be | |
8428 passed as a property list to the translation function for | |
8429 interpretation. A few standard parameters are already recognized and | |
8430 acted upon before the translation function is called: | |
8431 | |
8432 @table @code | |
8433 @item :skip N | |
8434 Skip the first N lines of the table. Hlines do count! | |
8435 @item :skipcols (n1 n2 ...) | |
8436 List of columns that should be skipped. If the table has a column with | |
8437 calculation marks, that column is automatically discarded as well. | |
8438 Please note that the translator function sees the table @emph{after} the | |
8439 removal of these columns, the function never knows that there have been | |
8440 additional columns. | |
8441 @end table | |
8442 | |
8443 @noindent | |
8444 The one problem remaining is how to keep the source table in the buffer | |
8445 without disturbing the normal workings of the file, for example during | |
8446 compilation of a C file or processing of a La@TeX{} file. There are a | |
8447 number of different solutions: | |
8448 | |
8449 @itemize @bullet | |
8450 @item | |
8451 The table could be placed in a block comment if that is supported by the | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8452 language. For example, in C mode you could wrap the table between |
84308 | 8453 @samp{/*} and @samp{*/} lines. |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
8454 @item |
84308 | 8455 Sometimes it is possible to put the table after some kind of @i{END} |
8456 statement, for example @samp{\bye} in TeX and @samp{\end@{document@}} | |
8457 in La@TeX{}. | |
8458 @item | |
8459 You can just comment the table line by line whenever you want to process | |
8460 the file, and uncomment it whenever you need to edit the table. This | |
8461 only sounds tedious - the command @kbd{M-x orgtbl-toggle-comment} does | |
8462 make this comment-toggling very easy, in particular if you bind it to a | |
8463 key. | |
8464 @end itemize | |
8465 | |
8466 @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8467 @subsection A LaTeX example of radio tables |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8468 @cindex LaTeX, and Orgtbl mode |
84308 | 8469 |
8470 The best way to wrap the source table in La@TeX{} is to use the | |
8471 @code{comment} environment provided by @file{comment.sty}. It has to be | |
8472 activated by placing @code{\usepackage@{comment@}} into the document | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8473 header. Orgtbl mode can insert a radio table skeleton@footnote{By |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8474 default this works only for La@TeX{}, HTML, and Texinfo. Configure the |
84308 | 8475 variable @code{orgtbl-radio-tables} to install templates for other |
8476 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will | |
8477 be prompted for a table name, lets say we use @samp{salesfigures}. You | |
8478 will then get the following template: | |
8479 | |
8480 @example | |
8481 % BEGIN RECEIVE ORGTBL salesfigures | |
8482 % END RECEIVE ORGTBL salesfigures | |
8483 \begin@{comment@} | |
8484 #+ORGTBL: SEND salesfigures orgtbl-to-latex | |
8485 | | | | |
8486 \end@{comment@} | |
8487 @end example | |
8488 | |
8489 @noindent | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8490 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function |
84308 | 8491 @code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it |
8492 into the receiver location with name @code{salesfigures}. You may now | |
8493 fill in the table, feel free to use the spreadsheet features@footnote{If | |
8494 the @samp{#+TBLFM} line contains an odd number of dollar characters, | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8495 this may cause problems with font-lock in LaTeX mode. As shown in the |
84308 | 8496 example you can fix this by adding an extra line inside the |
8497 @code{comment} environment that is used to balance the dollar | |
8498 expressions. If you are using AUCTeX with the font-latex library, a | |
8499 much better solution is to add the @code{comment} environment to the | |
8500 variable @code{LaTeX-verbatim-environments}.}: | |
8501 | |
8502 @example | |
8503 % BEGIN RECEIVE ORGTBL salesfigures | |
8504 % END RECEIVE ORGTBL salesfigures | |
8505 \begin@{comment@} | |
8506 #+ORGTBL: SEND salesfigures orgtbl-to-latex | |
8507 | Month | Days | Nr sold | per day | | |
8508 |-------+------+---------+---------| | |
8509 | Jan | 23 | 55 | 2.4 | | |
8510 | Feb | 21 | 16 | 0.8 | | |
8511 | March | 22 | 278 | 12.6 | | |
8512 #+TBLFM: $4=$3/$2;%.1f | |
8513 % $ (optional extra dollar to keep font-lock happy, see footnote) | |
8514 \end@{comment@} | |
8515 @end example | |
8516 | |
8517 @noindent | |
8518 When you are done, press @kbd{C-c C-c} in the table to get the converted | |
8519 table inserted between the two marker lines. | |
8520 | |
8521 Now lets assume you want to make the table header by hand, because you | |
8522 want to control how columns are aligned etc. In this case we make sure | |
8523 that the table translator does skip the first 2 lines of the source | |
8524 table, and tell the command to work as a @i{splice}, i.e. to not produce | |
8525 header and footer commands of the target table: | |
8526 | |
8527 @example | |
8528 \begin@{tabular@}@{lrrr@} | |
8529 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\ | |
8530 % BEGIN RECEIVE ORGTBL salesfigures | |
8531 % END RECEIVE ORGTBL salesfigures | |
8532 \end@{tabular@} | |
8533 % | |
8534 \begin@{comment@} | |
8535 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2 | |
8536 | Month | Days | Nr sold | per day | | |
8537 |-------+------+---------+---------| | |
8538 | Jan | 23 | 55 | 2.4 | | |
8539 | Feb | 21 | 16 | 0.8 | | |
8540 | March | 22 | 278 | 12.6 | | |
8541 #+TBLFM: $4=$3/$2;%.1f | |
8542 \end@{comment@} | |
8543 @end example | |
8544 | |
8545 The La@TeX{} translator function @code{orgtbl-to-latex} is already part of | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8546 Orgtbl mode. It uses a @code{tabular} environment to typeset the table |
84308 | 8547 and marks horizontal lines with @code{\hline}. Furthermore, it |
8548 interprets the following parameters: | |
8549 | |
8550 @table @code | |
8551 @item :splice nil/t | |
8552 When set to t, return only table body lines, don't wrap them into a | |
8553 tabular environment. Default is nil. | |
8554 | |
8555 @item :fmt fmt | |
8556 A format to be used to wrap each field, should contain @code{%s} for the | |
8557 original field value. For example, to wrap each field value in dollars, | |
8558 you could use @code{:fmt "$%s$"}. This may also be a property list with | |
8559 column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}. | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8560 A function of one argument can be used in place of the strings; the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8561 function must return a formatted string. |
84308 | 8562 |
8563 @item :efmt efmt | |
8564 Use this format to print numbers with exponentials. The format should | |
8565 have @code{%s} twice for inserting mantissa and exponent, for example | |
8566 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This | |
8567 may also be a property list with column numbers and formats, for example | |
8568 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After | |
8569 @code{efmt} has been applied to a value, @code{fmt} will also be | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8570 applied. Similar to @code{fmt}, functions of two arguments can be |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8571 supplied instead of strings. |
84308 | 8572 @end table |
8573 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8574 @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax |
84308 | 8575 @subsection Translator functions |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8576 @cindex HTML, and Orgtbl mode |
84308 | 8577 @cindex translator function |
8578 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8579 Orgtbl mode has several translator functions built-in: |
84308 | 8580 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and |
8581 @code{orgtbl-to-texinfo}. Except for @code{orgtbl-to-html}@footnote{The | |
8582 HTML translator uses the same code that produces tables during HTML | |
8583 export.}, these all use a generic translator, @code{orgtbl-to-generic}. | |
8584 For example, @code{orgtbl-to-latex} itself is a very short function that | |
8585 computes the column definitions for the @code{tabular} environment, | |
8586 defines a few field and line separators and then hands over to the | |
8587 generic translator. Here is the entire code: | |
8588 | |
8589 @lisp | |
8590 @group | |
8591 (defun orgtbl-to-latex (table params) | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8592 "Convert the Orgtbl mode TABLE to LaTeX." |
84308 | 8593 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l")) |
8594 org-table-last-alignment "")) | |
8595 (params2 | |
8596 (list | |
8597 :tstart (concat "\\begin@{tabular@}@{" alignment "@}") | |
8598 :tend "\\end@{tabular@}" | |
8599 :lstart "" :lend " \\\\" :sep " & " | |
8600 :efmt "%s\\,(%s)" :hline "\\hline"))) | |
8601 (orgtbl-to-generic table (org-combine-plists params2 params)))) | |
8602 @end group | |
8603 @end lisp | |
8604 | |
8605 As you can see, the properties passed into the function (variable | |
8606 @var{PARAMS}) are combined with the ones newly defined in the function | |
8607 (variable @var{PARAMS2}). The ones passed into the function (i.e. the | |
8608 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you | |
8609 would like to use the La@TeX{} translator, but wanted the line endings to | |
8610 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just | |
8611 overrule the default with | |
8612 | |
8613 @example | |
8614 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]" | |
8615 @end example | |
8616 | |
8617 For a new language, you can either write your own converter function in | |
8618 analogy with the La@TeX{} translator, or you can use the generic function | |
8619 directly. For example, if you have a language where a table is started | |
8620 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are | |
8621 started with @samp{!BL!}, ended with @samp{!EL!} and where the field | |
8622 separator is a TAB, you could call the generic translator like this (on | |
8623 a single line!): | |
8624 | |
8625 @example | |
8626 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!" | |
8627 :lstart "!BL! " :lend " !EL!" :sep "\t" | |
8628 @end example | |
8629 | |
8630 @noindent | |
8631 Please check the documentation string of the function | |
8632 @code{orgtbl-to-generic} for a full list of parameters understood by | |
8633 that function and remember that you can pass each of them into | |
8634 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function | |
8635 using the generic function. | |
8636 | |
8637 Of course you can also write a completely new function doing complicated | |
8638 things the generic translator cannot do. A translator function takes | |
8639 two arguments. The first argument is the table, a list of lines, each | |
8640 line either the symbol @code{hline} or a list of fields. The second | |
8641 argument is the property list containing all parameters specified in the | |
8642 @samp{#+ORGTBL: SEND} line. The function must return a single string | |
8643 containing the formatted table. If you write a generally useful | |
8644 translator, please post it on @code{emacs-orgmode@@gnu.org} so that | |
8645 others can benefit from your work. | |
8646 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8647 @node Radio lists, , Translator functions, Tables in arbitrary syntax |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8648 @subsection Radio lists |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8649 @cindex radio lists |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8650 @cindex org-list-insert-radio-list |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8651 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8652 Sending and receiving radio lists works exactly the same way than |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8653 sending and receiving radio tables (@pxref{Radio tables}) @footnote{You |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8654 need to load the @code{org-export-latex.el} package to use radio lists |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8655 since the relevant code is there for now.}. As for radio tables, you |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8656 can insert radio lists templates in HTML, La@TeX{} and Texinfo modes by |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8657 calling @code{org-list-insert-radio-list}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8658 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8659 Here are the differences with radio tables: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8660 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8661 @itemize @minus |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8662 @item |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8663 Use @code{ORGLST} instead of @code{ORGTBL}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8664 @item |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8665 The available translation functions for radio lists don't take |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8666 parameters. |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
8667 @item |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8668 `C-c C-c' will work when pressed on the first item of the list. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8669 @end itemize |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8670 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8671 Here is a La@TeX{} example. Let's say that you have this in your |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8672 La@TeX{} file: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8673 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8674 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8675 % BEGIN RECEIVE ORGLST to-buy |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8676 % END RECEIVE ORGLST to-buy |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8677 \begin@{comment@} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8678 #+ORGLIST: SEND to-buy orgtbl-to-latex |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8679 - a new house |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8680 - a new computer |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8681 + a new keyboard |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8682 + a new mouse |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8683 - a new life |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8684 \end@{comment@} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8685 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8686 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8687 Pressing `C-c C-c' on @code{a new house} and will insert the converted |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8688 La@TeX{} list between the two marker lines. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8689 |
84308 | 8690 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Extensions and Hacking |
8691 @section Dynamic blocks | |
8692 @cindex dynamic blocks | |
8693 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8694 Org documents can contain @emph{dynamic blocks}. These are |
84308 | 8695 specially marked regions that are updated by some user-written function. |
8696 A good example for such a block is the clock table inserted by the | |
8697 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}). | |
8698 | |
8699 Dynamic block are enclosed by a BEGIN-END structure that assigns a name | |
8700 to the block and can also specify parameters for the function producing | |
8701 the content of the block. | |
8702 | |
8703 @example | |
8704 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ... | |
8705 | |
8706 #+END: | |
8707 @end example | |
8708 | |
8709 Dynamic blocks are updated with the following commands | |
8710 | |
8711 @table @kbd | |
8712 @kindex C-c C-x C-u | |
8713 @item C-c C-x C-u | |
8714 Update dynamic block at point. | |
8715 @kindex C-u C-c C-x C-u | |
8716 @item C-u C-c C-x C-u | |
8717 Update all dynamic blocks in the current file. | |
8718 @end table | |
8719 | |
8720 Updating a dynamic block means to remove all the text between BEGIN and | |
8721 END, parse the BEGIN line for parameters and then call the specific | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
8722 writer function for this block to insert the new content. If you want |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
8723 to use the original content in the writer function, you can use the |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
8724 extra parameter @code{:content}. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
8725 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
8726 For a block with name @code{myblock}, the writer function is |
84308 | 8727 @code{org-dblock-write:myblock} with as only parameter a property list |
8728 with the parameters given in the begin line. Here is a trivial example | |
8729 of a block that keeps track of when the block update function was last | |
8730 run: | |
8731 | |
8732 @example | |
8733 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M" | |
8734 | |
8735 #+END: | |
8736 @end example | |
8737 | |
8738 @noindent | |
8739 The corresponding block writer function could look like this: | |
8740 | |
8741 @lisp | |
8742 (defun org-dblock-write:block-update-time (params) | |
8743 (let ((fmt (or (plist-get params :format) "%d. %m. %Y"))) | |
8744 (insert "Last block update at: " | |
8745 (format-time-string fmt (current-time))))) | |
8746 @end lisp | |
8747 | |
8748 If you want to make sure that all dynamic blocks are always up-to-date, | |
8749 you could add the function @code{org-update-all-dblocks} to a hook, for | |
8750 example @code{before-save-hook}. @code{org-update-all-dblocks} is | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8751 written in a way that is does nothing in buffers that are not in |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8752 @code{org-mode}. |
84308 | 8753 |
8754 @node Special agenda views, Using the property API, Dynamic blocks, Extensions and Hacking | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8755 @section Special agenda views |
84308 | 8756 @cindex agenda views, user-defined |
8757 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8758 Org provides a special hook that can be used to narrow down the |
84308 | 8759 selection made by any of the agenda views. You may specify a function |
8760 that is used at each match to verify if the match should indeed be part | |
8761 of the agenda view, and if not, how much should be skipped. | |
8762 | |
8763 Let's say you want to produce a list of projects that contain a WAITING | |
8764 tag anywhere in the project tree. Let's further assume that you have | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8765 marked all tree headings that define a project with the TODO keyword |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8766 PROJECT. In this case you would run a TODO search for the keyword |
84308 | 8767 PROJECT, but skip the match unless there is a WAITING tag anywhere in |
8768 the subtree belonging to the project line. | |
8769 | |
8770 To achieve this, you must write a function that searches the subtree for | |
8771 the tag. If the tag is found, the function must return @code{nil} to | |
8772 indicate that this match should not be skipped. If there is no such | |
8773 tag, return the location of the end of the subtree, to indicate that | |
8774 search should continue from there. | |
8775 | |
8776 @lisp | |
8777 (defun my-skip-unless-waiting () | |
8778 "Skip trees that are not waiting" | |
8779 (let ((subtree-end (save-excursion (org-end-of-subtree t)))) | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8780 (if (re-search-forward ":waiting:" subtree-end t) |
84308 | 8781 nil ; tag found, do not skip |
8782 subtree-end))) ; tag not found, continue after end of subtree | |
8783 @end lisp | |
8784 | |
8785 Now you may use this function in an agenda custom command, for example | |
8786 like this: | |
8787 | |
8788 @lisp | |
8789 (org-add-agenda-custom-command | |
8790 '("b" todo "PROJECT" | |
8791 ((org-agenda-skip-function 'my-org-waiting-projects) | |
8792 (org-agenda-overriding-header "Projects waiting for something: ")))) | |
8793 @end lisp | |
8794 | |
8795 Note that this also binds @code{org-agenda-overriding-header} to get a | |
8796 meaningful header in the agenda view. | |
8797 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8798 A general way to create custom searches is to base them on a search for |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8799 entries with a certain level limit. If you want to study all entries with |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8800 your custom search function, simply do a search for @samp{LEVEL>0}, and then |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8801 use @code{org-agenda-skip-function} to select the entries you really want to |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8802 have. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8803 |
84308 | 8804 You may also put a Lisp form into @code{org-agenda-skip-function}. In |
8805 particular, you may use the functions @code{org-agenda-skip-entry-if} | |
8806 and @code{org-agenda-skip-subtree-if} in this form, for example: | |
8807 | |
8808 @table @code | |
8809 @item '(org-agenda-skip-entry-if 'scheduled) | |
8810 Skip current entry if it has been scheduled. | |
8811 @item '(org-agenda-skip-entry-if 'notscheduled) | |
8812 Skip current entry if it has not been scheduled. | |
8813 @item '(org-agenda-skip-entry-if 'deadline) | |
8814 Skip current entry if it has a deadline. | |
8815 @item '(org-agenda-skip-entry-if 'scheduled 'deadline) | |
8816 Skip current entry if it has a deadline, or if it is scheduled. | |
8817 @item '(org-agenda-skip-entry 'regexp "regular expression") | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8818 Skip current entry if the regular expression matches in the entry. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8819 @item '(org-agenda-skip-entry 'notregexp "regular expression") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8820 Skip current entry unless the regular expression matches. |
84308 | 8821 @item '(org-agenda-skip-subtree-if 'regexp "regular expression") |
8822 Same as above, but check and skip the entire subtree. | |
8823 @end table | |
8824 | |
8825 Therefore we could also have written the search for WAITING projects | |
8826 like this, even without defining a special function: | |
8827 | |
8828 @lisp | |
8829 (org-add-agenda-custom-command | |
8830 '("b" todo "PROJECT" | |
8831 ((org-agenda-skip-function '(org-agenda-skip-subtree-if | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8832 'regexp ":waiting:")) |
84308 | 8833 (org-agenda-overriding-header "Projects waiting for something: ")))) |
8834 @end lisp | |
8835 | |
8836 @node Using the property API, , Special agenda views, Extensions and Hacking | |
8837 @section Using the property API | |
8838 @cindex API, for properties | |
8839 @cindex properties, API | |
8840 | |
8841 Here is a description of the functions that can be used to work with | |
8842 properties. | |
8843 | |
8844 @defun org-entry-properties &optional pom which | |
8845 Get all properties of the entry at point-or-marker POM. | |
8846 This includes the TODO keyword, the tags, time strings for deadline, | |
8847 scheduled, and clocking, and any additional properties defined in the | |
8848 entry. The return value is an alist, keys may occur multiple times | |
8849 if the property key was used several times. | |
8850 POM may also be nil, in which case the current entry is used. | |
8851 If WHICH is nil or `all', get all properties. If WHICH is | |
8852 `special' or `standard', only get that subclass. | |
8853 @end defun | |
8854 @defun org-entry-get pom property &optional inherit | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8855 Get value of PROPERTY for entry at point-or-marker POM. By default, |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8856 this only looks at properties defined locally in the entry. If INHERIT |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8857 is non-nil and the entry does not have the property, then also check |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8858 higher levels of the hierarchy. If INHERIT is the symbol |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8859 @code{selective}, use inheritance if and only if the setting of |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8860 @code{org-use-property-inheritance} selects PROPERTY for inheritance. |
84308 | 8861 @end defun |
8862 | |
8863 @defun org-entry-delete pom property | |
8864 Delete the property PROPERTY from entry at point-or-marker POM. | |
8865 @end defun | |
8866 | |
8867 @defun org-entry-put pom property value | |
8868 Set PROPERTY to VALUE for entry at point-or-marker POM. | |
8869 @end defun | |
8870 | |
8871 @defun org-buffer-property-keys &optional include-specials | |
8872 Get all property keys in the current buffer. | |
8873 @end defun | |
8874 | |
8875 @defun org-insert-property-drawer | |
8876 Insert a property drawer at point. | |
8877 @end defun | |
8878 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8879 @defun org-entry-add-to-multivalued-property pom property value |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8880 Treat the value of the property PROPERTY as a whitespace-separated list of |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8881 values and make sure that VALUE is in this list. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8882 @end defun |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8883 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8884 @defun org-entry-remove-from-multivalued-property pom property value |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8885 Treat the value of the property PROPERTY as a whitespace-separated list of |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8886 values and make sure that VALUE is @emph{not} in this list. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8887 @end defun |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8888 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8889 @defun org-entry-member-in-multivalued-property pom property value |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8890 Treat the value of the property PROPERTY as a whitespace-separated list of |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8891 values and check if VALUE is in this list. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8892 @end defun |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8893 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8894 @node History and Acknowledgments, Main Index, Extensions and Hacking, Top |
84308 | 8895 @appendix History and Acknowledgments |
8896 @cindex acknowledgments | |
8897 @cindex history | |
8898 @cindex thanks | |
8899 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8900 Org was borne in 2003, out of frustration over the user interface |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8901 of the Emacs Outline mode. I was trying to organize my notes and |
84308 | 8902 projects, and using Emacs seemed to be the natural way to go. However, |
8903 having to remember eleven different commands with two or three keys per | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8904 command, only to hide and show parts of the outline tree, that seemed |
84308 | 8905 entirely unacceptable to me. Also, when using outlines to take notes, I |
8906 constantly want to restructure the tree, organizing it parallel to my | |
8907 thoughts and plans. @emph{Visibility cycling} and @emph{structure | |
8908 editing} were originally implemented in the package | |
8909 @file{outline-magic.el}, but quickly moved to the more general | |
8910 @file{org.el}. As this environment became comfortable for project | |
8911 planning, the next step was adding @emph{TODO entries}, basic @emph{time | |
8912 stamps}, and @emph{table support}. These areas highlight the two main | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8913 goals that Org still has today: To create a new, outline-based, |
84308 | 8914 plain text mode with innovative and intuitive editing features, and to |
8915 incorporate project planning functionality directly into a notes file. | |
8916 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8917 A special thanks goes to @i{Bastien Guerry} who has not only writen a large |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8918 number of extensions to Org (most of them integrated into the core by now), |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8919 but has also helped the development and maintenance of Org so much that he |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8920 should be considered co-author of this package. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8921 |
84308 | 8922 Since the first release, literally thousands of emails to me or on |
8923 @code{emacs-orgmode@@gnu.org} have provided a constant stream of bug | |
8924 reports, feedback, new ideas, and sometimes patches and add-on code. | |
8925 Many thanks to everyone who has helped to improve this package. I am | |
8926 trying to keep here a list of the people who had significant influence | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8927 in shaping one or more aspects of Org. The list may not be |
84308 | 8928 complete, if I have forgotten someone, please accept my apologies and |
8929 let me know. | |
8930 | |
8931 @itemize @bullet | |
8932 | |
8933 @item | |
8934 @i{Russel Adams} came up with the idea for drawers. | |
8935 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8936 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}. |
84308 | 8937 @item |
8938 @i{Alex Bochannek} provided a patch for rounding time stamps. | |
8939 @item | |
8940 @i{Charles Cave}'s suggestion sparked the implementation of templates | |
8941 for Remember. | |
8942 @item | |
8943 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with | |
8944 specified time. | |
8945 @item | |
8946 @i{Gregory Chernov} patched support for lisp forms into table | |
8947 calculations and improved XEmacs compatibility, in particular by porting | |
8948 @file{nouline.el} to XEmacs. | |
8949 @item | |
8950 @i{Sacha Chua} suggested to copy some linking code from Planner. | |
8951 @item | |
8952 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also | |
8953 came up with the idea of properties, and that there should be an API for | |
8954 them. | |
8955 @item | |
8956 @i{Kees Dullemond} used to edit projects lists directly in HTML and so | |
8957 inspired some of the early development, including HTML export. He also | |
8958 asked for a way to narrow wide table columns. | |
8959 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8960 @i{Christian Egli} converted the documentation into Texinfo format, |
84308 | 8961 patched CSS formatting into the HTML exporter, and inspired the agenda. |
8962 @item | |
8963 @i{David Emery} provided a patch for custom CSS support in exported | |
8964 HTML agendas. | |
8965 @item | |
8966 @i{Nic Ferrier} contributed mailcap and XOXO support. | |
8967 @item | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
8968 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
8969 @item |
84308 | 8970 @i{John Foerch} figured out how to make incremental search show context |
8971 around a match in a hidden outline tree. | |
8972 @item | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8973 @i{Niels Giesen} had the idea to automatically archive DONE trees. |
84308 | 8974 @item |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8975 @i{Bastien Guerry} wrote the La@TeX{} exporter and @file{org-bibtex.el}, and |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8976 has been prolific with patches, ideas, and bug reports. |
84308 | 8977 @item |
8978 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages. | |
8979 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8980 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks, |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8981 task state change logging, and the clocktable. His clear explanations have |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8982 been critical when we started to adopt the GIT version control system. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8983 @item |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8984 @i{Phil Jackson} wrote @file{org-irc.el}. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8985 @item |
84308 | 8986 @i{Scott Jaderholm} proposed footnotes, control over whitespace between |
8987 folded entries, and column view for properties. | |
8988 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8989 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8990 @item |
84308 | 8991 @i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also |
8992 provided frequent feedback and some patches. | |
8993 @item | |
8994 @i{Jason F. McBrayer} suggested agenda export to CSV format. | |
8995 @item | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8996 @i{Max Mikhanosha} came up with the idea of refiling. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8997 @item |
84308 | 8998 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file |
8999 basis. | |
9000 @item | |
9001 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler | |
9002 happy. | |
9003 @item | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9004 @i{Rick Moynihan} proposed to allow multiple TODO sequences in a file |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9005 and to be able to quickly restrict the agenda to a subtree. |
84308 | 9006 @item |
9007 @i{Todd Neal} provided patches for links to Info files and elisp forms. | |
9008 @item | |
9009 @i{Tim O'Callaghan} suggested in-file links, search options for general | |
9010 file links, and TAGS. | |
9011 @item | |
9012 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial | |
9013 into Japanese. | |
9014 @item | |
9015 @i{Oliver Oppitz} suggested multi-state TODO items. | |
9016 @item | |
9017 @i{Scott Otterson} sparked the introduction of descriptive text for | |
9018 links, among other things. | |
9019 @item | |
9020 @i{Pete Phillips} helped during the development of the TAGS feature, and | |
9021 provided frequent feedback. | |
9022 @item | |
9023 @i{T.V. Raman} reported bugs and suggested improvements. | |
9024 @item | |
9025 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality | |
9026 control. | |
9027 @item | |
9028 @i{Kevin Rogers} contributed code to access VM files on remote hosts. | |
9029 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9030 @i{Sebastian Rose} wrote @file{org-info.js}, a Java script for displaying |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9031 webpages derived from Org using an Info-like, or a folding interface with |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9032 single key navigation. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9033 @item |
84308 | 9034 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a |
9035 conflict with @file{allout.el}. | |
9036 @item | |
9037 @i{Jason Riedy} sent a patch to fix a bug with export of TODO keywords. | |
9038 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9039 @i{Philip Rooke} created the Org reference card and provided lots |
84308 | 9040 of feedback. |
9041 @item | |
9042 @i{Christian Schlauer} proposed angular brackets around links, among | |
9043 other things. | |
9044 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9045 Linking to VM/BBDB/Gnus was inspired by @i{Tom Shannon}'s |
84308 | 9046 @file{organizer-mode.el}. |
9047 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9048 @i{Ilya Shlyakhter} proposed the Archive Sibling. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9049 @item |
84308 | 9050 @i{Daniel Sinder} came up with the idea of internal archiving by locking |
9051 subtrees. | |
9052 @item | |
9053 @i{Dale Smith} proposed link abbreviations. | |
9054 @item | |
9055 @i{Adam Spiers} asked for global linking commands and inspired the link | |
9056 extension system. support mairix. | |
9057 @item | |
9058 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual | |
9059 chapter about publishing. | |
9060 @item | |
9061 @i{J@"urgen Vollmer} contributed code generating the table of contents | |
9062 in HTML output. | |
9063 @item | |
9064 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE} | |
9065 keyword. | |
9066 @item | |
9067 @i{David Wainberg} suggested archiving, and improvements to the linking | |
9068 system. | |
9069 @item | |
9070 @i{John Wiegley} wrote @file{emacs-wiki.el} and @file{planner.el}. The | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9071 development of Org was fully independent, and both systems are really |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9072 different beasts in their basic ideas and implementation details. I later |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9073 looked at John's code, however, and learned from his implementation of (i) |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9074 links where the link itself is hidden and only a description is shown, and |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9075 (ii) popping up a calendar to select a date. John has also contributed a |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9076 number of great ideas and patches directly to Org, including the file |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9077 @code{org-mac-message.el}' |
84308 | 9078 @item |
9079 @i{Carsten Wimmer} suggested some changes and helped fix a bug in | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9080 linking to Gnus. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9081 @item |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9082 @i{Roland Winkler} requested additional key bindings to make Org |
84308 | 9083 work on a tty. |
9084 @item | |
9085 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks | |
9086 and contributed various ideas and code snippets. | |
9087 @end itemize | |
9088 | |
9089 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9090 @node Main Index, Key Index, History and Acknowledgments, Top |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9091 @unnumbered The Main Index |
84308 | 9092 |
9093 @printindex cp | |
9094 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9095 @node Key Index, , Main Index, Top |
84308 | 9096 @unnumbered Key Index |
9097 | |
9098 @printindex ky | |
9099 | |
9100 @bye | |
9101 | |
9102 @ignore | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9103 arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac |
84308 | 9104 @end ignore |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9105 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9106 @c Local variables: |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9107 @c ispell-local-dictionary: "en_US-w_accents" |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9108 @c ispell-local-pdict: "./.aspell.org.pws" |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9109 @c fill-column: 77 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9110 @c End: |