Mercurial > emacs
annotate doc/misc/org.texi @ 100858:676cda349ee9
*** empty log message ***
author | Michael Albinus <michael.albinus@gmx.de> |
---|---|
date | Sat, 03 Jan 2009 15:00:35 +0000 |
parents | 87dcbbf4f5fa |
children | cb5d2387102c |
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 |
100607
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
6 @set VERSION 6.16 |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
7 @set DATE December 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 | |
99868
404f28130174
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
99851
diff
changeset
|
42 under the terms of the GNU Free Documentation License, Version 1.3 or |
84308 | 43 any later version published by the Free Software Foundation; with no |
44 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' | |
97382
30b815491c74
Revert trivial license formatting changes from previous change.
Glenn Morris <rgm@gnu.org>
parents:
97028
diff
changeset
|
45 and with the Back-Cover Texts as in (a) below. A copy of the license |
30b815491c74
Revert trivial license formatting changes from previous change.
Glenn Morris <rgm@gnu.org>
parents:
97028
diff
changeset
|
46 is included in the section entitled ``GNU Free Documentation License.'' |
84308 | 47 |
95874
eafbd7a5c9be
Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents:
94550
diff
changeset
|
48 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and |
eafbd7a5c9be
Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents:
94550
diff
changeset
|
49 modify this GNU manual. Buying copies from the FSF supports it in |
eafbd7a5c9be
Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents:
94550
diff
changeset
|
50 developing GNU and promoting software freedom.'' |
95933
b5e79026c857
Change to GFDL 1.2. Refer to license in Emacs manual.
Glenn Morris <rgm@gnu.org>
parents:
95874
diff
changeset
|
51 |
b5e79026c857
Change to GFDL 1.2. Refer to license in Emacs manual.
Glenn Morris <rgm@gnu.org>
parents:
95874
diff
changeset
|
52 This document is part of a collection distributed under the GNU Free |
b5e79026c857
Change to GFDL 1.2. Refer to license in Emacs manual.
Glenn Morris <rgm@gnu.org>
parents:
95874
diff
changeset
|
53 Documentation License. If you want to distribute this document |
b5e79026c857
Change to GFDL 1.2. Refer to license in Emacs manual.
Glenn Morris <rgm@gnu.org>
parents:
95874
diff
changeset
|
54 separately from the collection, you can do so by adding a copy of the |
b5e79026c857
Change to GFDL 1.2. Refer to license in Emacs manual.
Glenn Morris <rgm@gnu.org>
parents:
95874
diff
changeset
|
55 license to the document, as described in section 6 of the license. |
84308 | 56 @end quotation |
57 @end copying | |
58 | |
59 @titlepage | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
60 @title The Org Manual |
84308 | 61 |
62 @subtitle Release @value{VERSION} | |
63 @author by Carsten Dominik | |
64 | |
65 @c The following two commands start the copyright page. | |
66 @page | |
67 @vskip 0pt plus 1filll | |
68 @insertcopying | |
69 @end titlepage | |
70 | |
71 @c Output the table of contents at the beginning. | |
72 @contents | |
73 | |
74 @ifnottex | |
75 @node Top, Introduction, (dir), (dir) | |
76 @top Org Mode Manual | |
77 | |
78 @insertcopying | |
79 @end ifnottex | |
80 | |
81 @menu | |
82 * Introduction:: Getting started | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
83 * Document Structure:: A tree works like your brain |
84308 | 84 * Tables:: Pure magic for quick formatting |
85 * Hyperlinks:: Notes in context | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
86 * TODO Items:: Every tree branch can be a TODO item |
84308 | 87 * 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
|
88 * 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
|
89 * Dates and Times:: Making items useful for planning |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
90 * Capture:: Creating tasks and attaching files |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
91 * Agenda Views:: Collecting information into views |
84308 | 92 * Embedded LaTeX:: LaTeX fragments and formulas |
93 * 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
|
94 * Publishing:: Create a web site of linked Org files |
84308 | 95 * Miscellaneous:: All the rest which did not fit elsewhere |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
96 * Extensions:: Add-ons for Org mode |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
97 * Hacking:: How hack your way around |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
98 * 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
|
99 * Main Index:: An index of Org's concepts and features |
84308 | 100 * Key Index:: Key bindings and where they are described |
101 | |
102 @detailmenu | |
103 --- The Detailed Node Listing --- | |
104 | |
105 Introduction | |
106 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
107 * 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
|
108 * 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
|
109 * Activation:: How to activate Org for certain buffers |
84308 | 110 * Feedback:: Bug reports, ideas, patches etc. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
111 * Conventions:: Type-setting conventions in the manual |
84308 | 112 |
113 Document Structure | |
114 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
115 * 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
|
116 * Headlines:: How to typeset Org tree headlines |
84308 | 117 * Visibility cycling:: Show and hide, much simplified |
118 * Motion:: Jumping to other headlines | |
119 * Structure editing:: Changing sequence and level of headlines | |
120 * Archiving:: Move done task trees to a different place | |
121 * Sparse trees:: Matches embedded in context | |
122 * Plain lists:: Additional structure within an entry | |
123 * Drawers:: Tucking stuff away | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
124 * Orgstruct mode:: Structure editing outside Org |
84308 | 125 |
126 Archiving | |
127 | |
128 * ARCHIVE tag:: Marking a tree as inactive | |
129 * Moving subtrees:: Moving a tree to an archive file | |
130 | |
131 Tables | |
132 | |
133 * 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
|
134 * Narrow columns:: Stop wasting space in tables |
84308 | 135 * 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
|
136 * 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
|
137 * The spreadsheet:: The table editor has spreadsheet capabilities |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
138 * Org Plot:: Plotting from org tables |
84308 | 139 |
140 The spreadsheet | |
141 | |
142 * References:: How to refer to another field or range | |
143 * Formula syntax for Calc:: Using Calc to compute stuff | |
144 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp | |
145 * Field formulas:: Formulas valid for a single field | |
146 * Column formulas:: Formulas valid for an entire column | |
147 * Editing and debugging formulas:: Fixing formulas | |
148 * Updating the table:: Recomputing all dependent fields | |
149 * Advanced features:: Field names, parameters and automatic recalc | |
150 | |
151 Hyperlinks | |
152 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
153 * Link format:: How links in Org are formatted |
84308 | 154 * Internal links:: Links to other places in the current file |
155 * External links:: URL-like links to the world | |
156 * 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
|
157 * Using links outside Org:: Linking from my C source code? |
84308 | 158 * Link abbreviations:: Shortcuts for writing complex links |
159 * Search options:: Linking to a specific location | |
160 * Custom searches:: When the default search is not enough | |
161 | |
162 Internal links | |
163 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
164 * 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
|
165 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
166 TODO Items |
84308 | 167 |
168 * TODO basics:: Marking and displaying TODO entries | |
169 * TODO extensions:: Workflow and assignments | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
170 * Progress logging:: Dates and notes for progress |
84308 | 171 * Priorities:: Some things are more important than others |
172 * Breaking down tasks:: Splitting a task into manageable pieces | |
173 * Checkboxes:: Tick-off lists | |
174 | |
175 Extended use of TODO keywords | |
176 | |
177 * Workflow states:: From TODO to DONE in steps | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
178 * TODO types:: I do this, Fred does the rest |
84308 | 179 * 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
|
180 * 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
|
181 * Per-file keywords:: Different files, different requirements |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
182 * Faces for TODO keywords:: Highlighting states |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
183 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
184 Progress logging |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
185 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
186 * Closing items:: When was this entry marked DONE? |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
187 * Tracking TODO state changes:: When did the status change? |
84308 | 188 |
189 Tags | |
190 | |
191 * Tag inheritance:: Tags use the tree structure of the outline | |
192 * Setting tags:: How to assign tags to a headline | |
193 * Tag searches:: Searching for combinations of tags | |
194 | |
195 Properties and Columns | |
196 | |
197 * 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
|
198 * Special properties:: Access to other Org mode features |
84308 | 199 * Property searches:: Matching property values |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
200 * Property inheritance:: Passing values down the tree |
84308 | 201 * Column view:: Tabular viewing and editing |
202 * Property API:: Properties for Lisp programmers | |
203 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
204 Column view |
84308 | 205 |
206 * Defining columns:: The COLUMNS format property | |
207 * 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
|
208 * 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
|
209 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
210 Defining columns |
84308 | 211 |
212 * Scope of column definitions:: Where defined, where valid? | |
213 * Column attributes:: Appearance and content of a column | |
214 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
215 Dates and Times |
84308 | 216 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
217 * Timestamps:: Assigning a time to a tree entry |
84308 | 218 * Creating timestamps:: Commands which insert timestamps |
219 * 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
|
220 * 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
|
221 * Effort estimates:: Planning work effort in advance |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
222 * Relative timer:: Notes with a running timer |
84308 | 223 |
224 Creating timestamps | |
225 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
226 * 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
|
227 * 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
|
228 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
229 Deadlines and scheduling |
84308 | 230 |
231 * Inserting deadline/schedule:: Planning items | |
232 * Repeated tasks:: Items that show up again and again | |
233 | |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
234 Capture |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
235 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
236 * Remember:: Capture new tasks/ideas with little interruption |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
237 * Attachments:: Add files to tasks. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
238 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
239 Remember |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
240 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
241 * 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
|
242 * Remember templates:: Define the outline of different note types |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
243 * 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
|
244 * Refiling notes:: Moving a note or task to a project |
84308 | 245 |
246 Agenda Views | |
247 | |
248 * Agenda files:: Files being searched for agenda information | |
249 * Agenda dispatcher:: Keyboard access to agenda views | |
250 * Built-in agenda views:: What is available out of the box? | |
251 * 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
|
252 * Agenda commands:: Remote editing of Org trees |
84308 | 253 * 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
|
254 * Agenda column view:: Using column view for collected entries |
84308 | 255 |
256 The built-in agenda views | |
257 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
258 * Weekly/daily agenda:: The calendar page with current tasks |
84308 | 259 * Global TODO list:: All unfinished action items |
260 * Matching tags and properties:: Structured information with fine-tuned search | |
261 * 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
|
262 * Keyword search:: Finding entries by keyword |
84308 | 263 * Stuck projects:: Find projects you need to review |
264 | |
265 Presentation and sorting | |
266 | |
267 * Categories:: Not all tasks are equal | |
268 * Time-of-day specifications:: How the agenda knows the time | |
269 * Sorting of agenda items:: The order of things | |
270 | |
271 Custom agenda views | |
272 | |
273 * Storing searches:: Type once, use often | |
274 * Block agenda:: All the stuff you need in a single buffer | |
275 * 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
|
276 * 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
|
277 * Using the agenda elsewhere:: Using agenda information in other programs |
84308 | 278 |
279 Embedded LaTeX | |
280 | |
281 * 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
|
282 * Subscripts and superscripts:: Simple syntax for raising/lowering text |
84308 | 283 * LaTeX fragments:: Complex formulas made easy |
284 * Processing LaTeX fragments:: Previewing LaTeX processing | |
285 * CDLaTeX mode:: Speed up entering of formulas | |
286 | |
287 Exporting | |
288 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
289 * Markup rules:: Which structures are recognized? |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
290 * Selective export:: Using tags to select and exclude trees |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
291 * Export options:: Per-file export settings |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
292 * The export dispatcher:: How to access exporter commands |
84308 | 293 * ASCII export:: Exporting to plain ASCII |
294 * HTML export:: Exporting to HTML | |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
295 * LaTeX and PDF export:: Exporting to LaTeX, and processing to PDF |
84308 | 296 * XOXO export:: Exporting to XOXO |
297 * iCalendar export:: Exporting in iCalendar format | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
298 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
299 Markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
300 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
301 * Document title:: How the document title is determined |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
302 * Headings and sections:: The main structure of the exported document |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
303 * Table of contents:: If, where, how to create a table of contents |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
304 * Initial text:: Text before the first headline |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
305 * Lists:: Plain lists are exported |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
306 * Paragraphs:: What determines beginning and ending |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
307 * Literal examples:: Source code and other examples |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
308 * Include files:: Include the contents of a file during export |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
309 * Tables exported:: Tables are exported richly |
100450
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
310 * Inlined images:: How to inline images during export |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
311 * Footnotes:: Numbers like [1] |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
312 * Emphasis and monospace:: To bold or not to bold |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
313 * TeX macros and LaTeX fragments:: Create special, rich export. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
314 * Horizontal rules:: A line across the page |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
315 * Comment lines:: Some lines will not be exported |
84308 | 316 |
317 HTML export | |
318 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
319 * HTML Export commands:: How to invoke HTML export |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
320 * Quoting HTML tags:: Using direct HTML in Org mode |
84308 | 321 * Links:: Transformation of links for HTML |
100450
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
322 * Images in HTML export:: |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
323 * 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
|
324 * Javascript support:: Info and Folding in a web browser |
84308 | 325 |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
326 LaTeX and PDF export |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
327 |
100450
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
328 * LaTeX/PDF export commands:: Which key invode which commands |
84308 | 329 * 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
|
330 * Sectioning structure:: Changing sectioning in LaTeX output |
100450
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
331 * Tables in LaTeX export:: Options for exporting tables to LaTeX |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
332 * Images in LaTeX export:: How to insert figures into LaTeX output |
84308 | 333 |
334 Publishing | |
335 | |
336 * Configuration:: Defining projects | |
337 * Sample configuration:: Example projects | |
338 * Triggering publication:: Publication commands | |
339 | |
340 Configuration | |
341 | |
342 * Project alist:: The central configuration variable | |
343 * Sources and destinations:: From here to there | |
344 * Selecting files:: What files are part of the project? | |
345 * Publishing action:: Setting the function doing the publishing | |
346 * Publishing options:: Tweaking HTML export | |
347 * Publishing links:: Which links keep working after publishing? | |
348 * Project page index:: Publishing a list of project files | |
349 | |
350 Sample configuration | |
351 | |
352 * Simple example:: One-component publishing | |
353 * Complex example:: A multi-component publishing example | |
354 | |
355 Miscellaneous | |
356 | |
357 * 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
|
358 * Customization:: Adapting Org to your taste |
84308 | 359 * In-buffer settings:: Overview of the #+KEYWORDS |
360 * The very busy C-c C-c key:: When in doubt, press C-c C-c | |
361 * 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
|
362 * TTY keys:: Using Org on a tty |
84308 | 363 * Interaction:: Other Emacs packages |
364 * Bugs:: Things which do not work perfectly | |
365 | |
366 Interaction with other packages | |
367 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
368 * Cooperation:: Packages Org cooperates with |
84308 | 369 * Conflicts:: Packages that lead to conflicts |
370 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
371 Extensions |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
372 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
373 * Extensions in the contrib directory:: These come with the Org distro |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
374 * Other extensions:: These you have to find on the web. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
375 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
376 Hacking |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
377 |
84308 | 378 * Adding hyperlink types:: New custom link types |
379 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs | |
380 * Dynamic blocks:: Automatically filled blocks | |
381 * Special agenda views:: Customized views | |
382 * Using the property API:: Writing programs that use entry properties | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
383 * Using the mapping API:: Mapping over all or selected entries |
84308 | 384 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
385 Tables and lists in arbitrary syntax |
84308 | 386 |
387 * Radio tables:: Sending and receiving | |
388 * A LaTeX example:: Step by step, almost a tutorial | |
389 * 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
|
390 * Radio lists:: Doing the same for lists |
84308 | 391 |
392 @end detailmenu | |
393 @end menu | |
394 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
395 @node Introduction, Document Structure, Top, Top |
84308 | 396 @chapter Introduction |
397 @cindex introduction | |
398 | |
399 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
400 * 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
|
401 * 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
|
402 * Activation:: How to activate Org for certain buffers |
84308 | 403 * Feedback:: Bug reports, ideas, patches etc. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
404 * Conventions:: Type-setting conventions in the manual |
84308 | 405 @end menu |
406 | |
407 @node Summary, Installation, Introduction, Introduction | |
408 @section Summary | |
409 @cindex summary | |
410 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
411 Org is a mode for keeping notes, maintaining TODO lists, and doing |
84308 | 412 project planning with a fast and effective plain-text system. |
413 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
414 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
|
415 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
|
416 implemented on top of Outline mode, which makes it possible to keep the |
84308 | 417 content of large files well structured. Visibility cycling and |
418 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
|
419 with a built-in table editor. Org supports TODO items, deadlines, |
84308 | 420 time stamps, and scheduling. It dynamically compiles entries into an |
421 agenda that utilizes and smoothly integrates much of the Emacs calendar | |
422 and diary. Plain text URL-like links connect to websites, emails, | |
423 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
|
424 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
|
425 structured ASCII file, as HTML, or (TODO and agenda items only) as an |
84308 | 426 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
|
427 linked web pages. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
428 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
429 An important design aspect that distinguishes Org from for example |
84308 | 430 Planner/Muse is that it encourages to store every piece of information |
431 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
|
432 other files, duplicating some information such as tasks. In Org, |
84308 | 433 you only have notes files. In your notes you mark entries as tasks, |
434 label them with tags and timestamps. All necessary lists like a | |
435 schedule for the day, the agenda for a meeting, tasks lists selected by | |
436 tags etc are created dynamically when you need them. | |
437 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
438 Org keeps simple things simple. When first fired up, it should |
84308 | 439 feel like a straightforward, easy to use outliner. Complexity is not |
440 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
|
441 it. Org is a toolbox and can be used in different ways, for |
84308 | 442 example as: |
443 | |
444 @example | |
445 @r{@bullet{} outline extension with visibility cycling and structure editing} | |
446 @r{@bullet{} ASCII system and table editor for taking structured notes} | |
447 @r{@bullet{} ASCII table editor with spreadsheet-like capabilities} | |
448 @r{@bullet{} TODO list editor} | |
449 @r{@bullet{} full agenda and planner with deadlines and work scheduling} | |
450 @r{@bullet{} environment to implement David Allen's GTD system} | |
451 @r{@bullet{} a basic database application} | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
452 @r{@bullet{} simple hypertext system, with HTML and LaTeX export} |
84308 | 453 @r{@bullet{} publishing tool to create a set of interlinked webpages} |
454 @end example | |
455 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
456 Org's automatic, context sensitive table editor with spreadsheet |
84308 | 457 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
|
458 minor Orgtbl mode. Using a translation step, it can be used to maintain |
84308 | 459 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
|
460 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
|
461 the minor Orgstruct mode. |
84308 | 462 |
463 @cindex FAQ | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
464 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
|
465 version of Org, as well as additional information, frequently asked |
84308 | 466 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
|
467 @uref{http://orgmode.org}. |
84308 | 468 |
469 @page | |
470 | |
471 | |
472 @node Installation, Activation, Summary, Introduction | |
473 @section Installation | |
474 @cindex installation | |
475 @cindex XEmacs | |
476 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
477 @b{Important:} @i{If Org is part of the Emacs distribution or an |
84308 | 478 XEmacs package, please skip this section and go directly to |
479 @ref{Activation}.} | |
480 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
481 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
|
482 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
|
483 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
|
484 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
|
485 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
|
486 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
|
487 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
|
488 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
|
489 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
|
490 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
491 @example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
492 (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
|
493 @end example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
494 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
495 @noindent |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
496 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
|
497 step for this directory: |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
498 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
499 @example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
500 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path)) |
84308 | 501 @end example |
502 | |
503 @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
|
504 the @file{xemacs} sub-directory of the Org distribution. Use the |
84308 | 505 command:} |
506 | |
507 @example | |
508 @b{make install-noutline} | |
509 @end example | |
510 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
511 @noindent Now byte-compile the Lisp files with the shell command: |
84308 | 512 |
513 @example | |
514 make | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
515 @end example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
516 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
517 @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
|
518 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
|
519 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
520 @example |
84308 | 521 make install |
522 make install-info | |
523 @end example | |
524 | |
525 @noindent Then add to @file{.emacs}: | |
526 | |
527 @lisp | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
528 ;; This line only if Org is not part of the X/Emacs distribution. |
84308 | 529 (require 'org-install) |
530 @end lisp | |
531 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
532 |
84308 | 533 @node Activation, Feedback, Installation, Introduction |
534 @section Activation | |
535 @cindex activation | |
536 @cindex autoload | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
537 @cindex global key bindings |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
538 @cindex key bindings, global |
84308 | 539 |
540 @iftex | |
541 @b{Important:} @i{If you use copy-and-paste to copy lisp code from the | |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
542 PDF documentation as viewed by some PDF viewers to your .emacs file, the |
84308 | 543 single quote character comes out incorrectly and the code will not work. |
544 You need to fix the single quotes by hand, or copy from Info | |
545 documentation.} | |
546 @end iftex | |
547 | |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
548 Add the following lines to your @file{.emacs} file. The last three lines |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
549 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
|
550 @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
|
551 keys yourself. |
84308 | 552 |
553 @lisp | |
554 ;; The following lines are always needed. Choose your own keys. | |
555 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode)) | |
556 (global-set-key "\C-cl" 'org-store-link) | |
557 (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
|
558 (global-set-key "\C-cb" 'org-iswitchb) |
84308 | 559 @end lisp |
560 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
561 Furthermore, you must activate @code{font-lock-mode} in Org |
84308 | 562 buffers, because significant functionality depends on font-locking being |
563 active. You can do this with either one of the following two lines | |
564 (XEmacs user must use the second option): | |
565 @lisp | |
566 (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
|
567 (add-hook 'org-mode-hook 'turn-on-font-lock) ; Org buffers only |
84308 | 568 @end lisp |
569 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
570 @cindex Org mode, turning on |
84308 | 571 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
|
572 into Org mode. As an alternative, make the first line of a file look |
84308 | 573 like this: |
574 | |
575 @example | |
576 MY PROJECTS -*- mode: org; -*- | |
577 @end example | |
578 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
579 @noindent which will select Org mode for this buffer no matter what |
84308 | 580 the file's name is. See also the variable |
581 @code{org-insert-mode-line-in-empty-file}. | |
582 | |
100607
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
583 Many commands in Org work on the region is the region is active. To make use |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
584 of this, you need to have @code{transient-mark-mode} (@code{zmacs-regions} in |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
585 XEmacs) turned on. In Emacs 23 this is the default, in Emacs 22 you need to |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
586 do this yourself with |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
587 |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
588 @lisp |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
589 (transient-mark-mode 1) |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
590 @end lisp |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
591 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
592 @node Feedback, Conventions, Activation, Introduction |
84308 | 593 @section Feedback |
594 @cindex feedback | |
595 @cindex bug reports | |
596 @cindex maintainer | |
597 @cindex author | |
598 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
599 If you find problems with Org, or if you have questions, remarks, or ideas |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
600 about it, please mail to the Org mailing list @code{emacs-orgmode@@gnu.org}. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
601 If you are not a member of the mailing list, your mail will be reviewed by a |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
602 moderator and then passed through to the list. |
84308 | 603 |
604 For bug reports, please provide as much information as possible, | |
605 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
|
606 @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
|
607 the Org related setup in @file{.emacs}. If an error occurs, a |
84308 | 608 backtrace can be very useful (see below on how to create one). Often a |
609 small example file helps, along with clear information about: | |
610 | |
611 @enumerate | |
612 @item What exactly did you do? | |
613 @item What did you expect to happen? | |
614 @item What happened instead? | |
615 @end enumerate | |
616 @noindent Thank you for helping to improve this mode. | |
617 | |
618 @subsubheading How to create a useful backtrace | |
619 | |
620 @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
|
621 If working with Org produces an error with a message you don't |
84308 | 622 understand, you may have hit a bug. The best way to report this is by |
623 providing, in addition to what was mentioned above, a @emph{Backtrace}. | |
624 This is information from the built-in debugger about where and how the | |
625 error occurred. Here is how to produce a useful backtrace: | |
626 | |
627 @enumerate | |
628 @item | |
629 Start a fresh Emacs or XEmacs, and make sure that it will load the | |
630 original Lisp code in @file{org.el} instead of the compiled version in | |
631 @file{org.elc}. The backtrace contains much more information if it is | |
632 produced with uncompiled code. To do this, either rename @file{org.elc} | |
633 to something else before starting Emacs, or ask Emacs explicitly to load | |
634 @file{org.el} by using the command line | |
635 @example | |
636 emacs -l /path/to/org.el | |
637 @end example | |
638 @item | |
639 Go to the @code{Options} menu and select @code{Enter Debugger on Error} | |
640 (XEmacs has this option in the @code{Troubleshooting} sub-menu). | |
641 @item | |
642 Do whatever you have to do to hit the error. Don't forget to | |
643 document the steps you take. | |
644 @item | |
645 When you hit the error, a @file{*Backtrace*} buffer will appear on the | |
646 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and | |
647 attach it to your bug report. | |
648 @end enumerate | |
649 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
650 @node Conventions, , Feedback, Introduction |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
651 @section Typesetting conventions used in this manual |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
652 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
653 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
|
654 names. In this manual we use the following conventions: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
655 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
656 @table @code |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
657 @item TODO |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
658 @itemx WAITING |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
659 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
|
660 user-defined. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
661 @item boss |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
662 @itemx ARCHIVE |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
663 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
|
664 meaning are written with all capitals. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
665 @item Release |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
666 @itemx PRIORITY |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
667 User-defined properties are capitalized; built-in properties with |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
668 special meaning are written with all capitals. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
669 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
670 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
671 @node Document Structure, Tables, Introduction, Top |
84308 | 672 @chapter Document Structure |
673 @cindex document structure | |
674 @cindex structure of document | |
675 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
676 Org is based on outline mode and provides flexible commands to |
84308 | 677 edit the structure of the document. |
678 | |
679 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
680 * 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
|
681 * Headlines:: How to typeset Org tree headlines |
84308 | 682 * Visibility cycling:: Show and hide, much simplified |
683 * Motion:: Jumping to other headlines | |
684 * Structure editing:: Changing sequence and level of headlines | |
685 * Archiving:: Move done task trees to a different place | |
686 * Sparse trees:: Matches embedded in context | |
687 * Plain lists:: Additional structure within an entry | |
688 * Drawers:: Tucking stuff away | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
689 * Orgstruct mode:: Structure editing outside Org |
84308 | 690 @end menu |
691 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
692 @node Outlines, Headlines, Document Structure, Document Structure |
84308 | 693 @section Outlines |
694 @cindex outlines | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
695 @cindex Outline mode |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
696 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
697 Org is implemented on top of Outline mode. Outlines allow a |
84308 | 698 document to be organized in a hierarchical structure, which (at least |
699 for me) is the best representation of notes and thoughts. An overview | |
700 of this structure is achieved by folding (hiding) large parts of the | |
701 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
|
702 currently being worked on. Org greatly simplifies the use of |
84308 | 703 outlines by compressing the entire show/hide functionality into a single |
704 command @command{org-cycle}, which is bound to the @key{TAB} key. | |
705 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
706 @node Headlines, Visibility cycling, Outlines, Document Structure |
84308 | 707 @section Headlines |
708 @cindex headlines | |
709 @cindex outline tree | |
710 | |
711 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
|
712 Org start with one or more stars, on the left margin@footnote{See |
84308 | 713 the variable @code{org-special-ctrl-a/e} to configure special behavior |
714 of @kbd{C-a} and @kbd{C-e} in headlines.}. For example: | |
715 | |
716 @example | |
717 * Top level headline | |
718 ** Second level | |
719 *** 3rd level | |
720 some text | |
721 *** 3rd level | |
722 more text | |
723 | |
724 * Another top level headline | |
725 @end example | |
726 | |
727 @noindent Some people find the many stars too noisy and would prefer an | |
728 outline that has whitespace followed by a single star as headline | |
729 starters. @ref{Clean view} describes a setup to realize this. | |
730 | |
731 An empty line after the end of a subtree is considered part of it and | |
732 will be hidden when the subtree is folded. However, if you leave at | |
733 least two empty lines, one empty line will remain visible after folding | |
734 the subtree, in order to structure the collapsed view. See the | |
735 variable @code{org-cycle-separator-lines} to modify this behavior. | |
736 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
737 @node Visibility cycling, Motion, Headlines, Document Structure |
84308 | 738 @section Visibility cycling |
739 @cindex cycling, visibility | |
740 @cindex visibility cycling | |
741 @cindex trees, visibility | |
742 @cindex show hidden text | |
743 @cindex hide text | |
744 | |
745 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
|
746 Org uses just two commands, bound to @key{TAB} and |
84308 | 747 @kbd{S-@key{TAB}} to change the visibility in the buffer. |
748 | |
749 @cindex subtree visibility states | |
750 @cindex subtree cycling | |
751 @cindex folded, subtree visibility state | |
752 @cindex children, subtree visibility state | |
753 @cindex subtree, subtree visibility state | |
754 @table @kbd | |
755 @kindex @key{TAB} | |
756 @item @key{TAB} | |
757 @emph{Subtree cycling}: Rotate current subtree among the states | |
758 | |
759 @example | |
760 ,-> FOLDED -> CHILDREN -> SUBTREE --. | |
761 '-----------------------------------' | |
762 @end example | |
763 | |
764 The cursor must be on a headline for this to work@footnote{see, however, | |
765 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the | |
766 beginning of the buffer and the first line is not a headline, then | |
767 @key{TAB} actually runs global cycling (see below)@footnote{see the | |
768 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix | |
769 argument (@kbd{C-u @key{TAB}}), global cycling is invoked. | |
770 | |
771 @cindex global visibility states | |
772 @cindex global cycling | |
773 @cindex overview, global visibility state | |
774 @cindex contents, global visibility state | |
775 @cindex show all, global visibility state | |
776 @kindex S-@key{TAB} | |
777 @item S-@key{TAB} | |
778 @itemx C-u @key{TAB} | |
779 @emph{Global cycling}: Rotate the entire buffer among the states | |
780 | |
781 @example | |
782 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --. | |
783 '--------------------------------------' | |
784 @end example | |
785 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
786 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
|
787 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
|
788 tables, @kbd{S-@key{TAB}} jumps to the previous field. |
84308 | 789 |
790 @cindex show all, command | |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
791 @kindex C-u C-u C-u @key{TAB} |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
792 @item C-u C-u C-u @key{TAB} |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
793 Show all, including drawers. |
84308 | 794 @kindex C-c C-r |
795 @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
|
796 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
|
797 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
|
798 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
|
799 (@pxref{Agenda commands}). With a prefix argument show, on each |
84308 | 800 level, all sibling headings. |
801 @kindex C-c C-x b | |
802 @item C-c C-x b | |
803 Show the current subtree in an indirect buffer@footnote{The indirect | |
804 buffer | |
805 @ifinfo | |
806 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual}) | |
807 @end ifinfo | |
808 @ifnotinfo | |
809 (see the Emacs manual for more information about indirect buffers) | |
810 @end ifnotinfo | |
811 will contain the entire buffer, but will be narrowed to the current | |
812 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
|
813 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
|
814 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
|
815 negative then go up that many levels. With a @kbd{C-u} prefix, do not remove |
84308 | 816 the previously used indirect buffer. |
817 @end table | |
818 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
819 When Emacs first visits an Org file, the global state is set to |
84308 | 820 OVERVIEW, i.e. only the top level headlines are visible. This can be |
821 configured through the variable @code{org-startup-folded}, or on a | |
822 per-file basis by adding one of the following lines anywhere in the | |
823 buffer: | |
824 | |
825 @example | |
826 #+STARTUP: overview | |
827 #+STARTUP: content | |
828 #+STARTUP: showall | |
829 @end example | |
830 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
831 @noindent |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
832 Forthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
833 and Columns}) will get their visibility adapted accordingly. Allowed values |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
834 for this property are @code{folded}, @code{children}, @code{content}, and |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
835 @code{all}. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
836 @table @kbd |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
837 @kindex C-u C-u @key{TAB} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
838 @item C-u C-u @key{TAB} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
839 Switch back to the startup visibility of the buffer, i.e. whatever is |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
840 requested by startup options and @samp{VISIBILITY} properties in individual |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
841 entries. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
842 @end table |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
843 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
844 @node Motion, Structure editing, Visibility cycling, Document Structure |
84308 | 845 @section Motion |
846 @cindex motion, between headlines | |
847 @cindex jumping, to headlines | |
848 @cindex headline navigation | |
849 The following commands jump to other headlines in the buffer. | |
850 | |
851 @table @kbd | |
852 @kindex C-c C-n | |
853 @item C-c C-n | |
854 Next heading. | |
855 @kindex C-c C-p | |
856 @item C-c C-p | |
857 Previous heading. | |
858 @kindex C-c C-f | |
859 @item C-c C-f | |
860 Next heading same level. | |
861 @kindex C-c C-b | |
862 @item C-c C-b | |
863 Previous heading same level. | |
864 @kindex C-c C-u | |
865 @item C-c C-u | |
866 Backward to higher level heading. | |
867 @kindex C-c C-j | |
868 @item C-c C-j | |
869 Jump to a different place without changing the current outline | |
870 visibility. Shows the document structure in a temporary buffer, where | |
871 you can use the following keys to find your destination: | |
872 @example | |
873 @key{TAB} @r{Cycle visibility.} | |
874 @key{down} / @key{up} @r{Next/previous visible headline.} | |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
875 @key{RET} @r{Select this location.} |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
876 @kbd{/} @r{Do a Sparse-tree search} |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
877 @r{The following keys work if you turn off @code{org-goto-auto-isearch}} |
84308 | 878 n / p @r{Next/previous visible headline.} |
879 f / b @r{Next/previous headline same level.} | |
880 u @r{One level up.} | |
881 0-9 @r{Digit argument.} | |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
882 q @r{Quit} |
84308 | 883 @end example |
99868
404f28130174
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
99851
diff
changeset
|
884 See also the variable@code{org-goto-interface}. |
84308 | 885 @end table |
886 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
887 @node Structure editing, Archiving, Motion, Document Structure |
84308 | 888 @section Structure editing |
889 @cindex structure editing | |
890 @cindex headline, promotion and demotion | |
891 @cindex promotion, of subtrees | |
892 @cindex demotion, of subtrees | |
893 @cindex subtree, cut and paste | |
894 @cindex pasting, of subtrees | |
895 @cindex cutting, of subtrees | |
896 @cindex copying, of subtrees | |
897 @cindex subtrees, cut and paste | |
898 | |
899 @table @kbd | |
900 @kindex M-@key{RET} | |
901 @item M-@key{RET} | |
902 Insert new heading with same level as current. If the cursor is in a | |
903 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
|
904 creation of a new headline, use a prefix argument, or first press @key{RET} |
84308 | 905 to get to the beginning of the next line. When this command is used in |
906 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
|
907 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
|
908 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
|
909 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
|
910 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
|
911 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
|
912 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
|
913 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
|
914 after the end of the subtree. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
915 @kindex C-@key{RET} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
916 @item C-@key{RET} |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
917 Just like @kbd{M-@key{RET}}, except when adding a new heading below the |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
918 current heading, the new heading is placed after the body instead of before |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
919 it. This command works from anywhere in the entry. |
84308 | 920 @kindex M-S-@key{RET} |
921 @item M-S-@key{RET} | |
922 Insert new TODO entry with same level as current heading. | |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
923 @kindex C-S-@key{RET} |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
924 @item C-S-@key{RET} |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
925 Insert new TODO entry with same level as current heading. Like |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
926 @kbd{C-@key{RET}}, the new headline will be inserted after the current |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
927 subtree. |
84308 | 928 @kindex M-@key{left} |
929 @item M-@key{left} | |
930 Promote current heading by one level. | |
931 @kindex M-@key{right} | |
932 @item M-@key{right} | |
933 Demote current heading by one level. | |
934 @kindex M-S-@key{left} | |
935 @item M-S-@key{left} | |
936 Promote the current subtree by one level. | |
937 @kindex M-S-@key{right} | |
938 @item M-S-@key{right} | |
939 Demote the current subtree by one level. | |
940 @kindex M-S-@key{up} | |
941 @item M-S-@key{up} | |
942 Move subtree up (swap with previous subtree of same | |
943 level). | |
944 @kindex M-S-@key{down} | |
945 @item M-S-@key{down} | |
946 Move subtree down (swap with next subtree of same level). | |
947 @kindex C-c C-x C-w | |
948 @item C-c C-x C-w | |
949 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
|
950 With a numeric prefix argument N, kill N sequential subtrees. |
84308 | 951 @kindex C-c C-x M-w |
952 @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
|
953 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
|
954 sequential subtrees. |
84308 | 955 @kindex C-c C-x C-y |
956 @item C-c C-x C-y | |
957 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
|
958 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
|
959 also be specified with a numeric prefix argument, or by yanking after a |
84308 | 960 headline marker like @samp{****}. |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
961 @kindex C-y |
99503
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
962 @item C-y |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
963 Depending on the variables @code{org-yank-adjusted-subtrees} and |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
964 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
965 paste subtrees folded and in a clever way, using the same command as @kbd{C-c |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
966 C-x C-y}. With the default settings, level adjustment will take place and |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
967 yanked trees will be folded unless doing so would swallow text previously |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
968 visible. Any prefix argument to this command will force a normal @code{yank} |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
969 to be executed, with the prefix passed along. A good way to force a normal |
99851
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
970 yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a yank, it will yank |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
971 previous kill items plainly, without adjustment and folding. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
972 @kindex C-c C-w |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
973 @item C-c C-w |
99503
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
974 Refile entry or region to a different location. @xref{Refiling notes}. |
84308 | 975 @kindex C-c ^ |
976 @item C-c ^ | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
977 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
|
978 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
|
979 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
|
980 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
|
981 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
|
982 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
|
983 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
|
984 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
|
985 duplicate entries will also be removed. |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
986 @kindex C-x n s |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
987 @item C-x n s |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
988 Narrow buffer to current subtree. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
989 @kindex C-x n w |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
990 @item C-x n w |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
991 Widen buffer to remove a narrowing. |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
992 @kindex C-c * |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
993 @item C-c * |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
994 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
|
995 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
|
996 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
|
997 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
|
998 headline, remove the stars from all headlines in the region. |
84308 | 999 @end table |
1000 | |
1001 @cindex region, active | |
1002 @cindex active region | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1003 @cindex Transient mark mode |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1004 When there is an active region (Transient mark mode), promotion and |
84308 | 1005 demotion work on all headlines in the region. To select a region of |
1006 headlines, it is best to place both point and mark at the beginning of a | |
1007 line, mark at the beginning of the first headline, and point at the line | |
1008 just after the last headline to change. Note that when the cursor is | |
1009 inside a table (@pxref{Tables}), the Meta-Cursor keys have different | |
1010 functionality. | |
1011 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1012 @node Archiving, Sparse trees, Structure editing, Document Structure |
84308 | 1013 @section Archiving |
1014 @cindex archiving | |
1015 | |
1016 When a project represented by a (sub)tree is finished, you may want | |
1017 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
|
1018 agenda. Org mode knows two ways of archiving. You can mark a tree with |
84308 | 1019 the ARCHIVE tag, or you can move an entire (sub)tree to a different |
1020 location. | |
1021 | |
1022 @menu | |
1023 * ARCHIVE tag:: Marking a tree as inactive | |
1024 * Moving subtrees:: Moving a tree to an archive file | |
1025 @end menu | |
1026 | |
1027 @node ARCHIVE tag, Moving subtrees, Archiving, Archiving | |
1028 @subsection The ARCHIVE tag | |
1029 @cindex internal archiving | |
1030 | |
1031 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at | |
1032 its location in the outline tree, but behaves in the following way: | |
1033 @itemize @minus | |
1034 @item | |
1035 It does not open when you attempt to do so with a visibility cycling | |
1036 command (@pxref{Visibility cycling}). You can force cycling archived | |
1037 subtrees with @kbd{C-@key{TAB}}, or by setting the option | |
1038 @code{org-cycle-open-archived-trees}. Also normal outline commands like | |
1039 @code{show-all} will open archived subtrees. | |
1040 @item | |
1041 During sparse tree construction (@pxref{Sparse trees}), matches in | |
1042 archived subtrees are not exposed, unless you configure the option | |
1043 @code{org-sparse-tree-open-archived-trees}. | |
1044 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1045 During agenda view construction (@pxref{Agenda Views}), the content of |
84308 | 1046 archived trees is ignored unless you configure the option |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
1047 @code{org-agenda-skip-archived-trees}, in which case these trees will always |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
1048 be included. In the agenda you can press the @kbd{v} key to get archives |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
1049 temporarily included. |
84308 | 1050 @item |
1051 Archived trees are not exported (@pxref{Exporting}), only the headline | |
1052 is. Configure the details using the variable | |
1053 @code{org-export-with-archived-trees}. | |
1054 @end itemize | |
1055 | |
1056 The following commands help managing the ARCHIVE tag: | |
1057 | |
1058 @table @kbd | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1059 @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
|
1060 @item C-c C-x a |
84308 | 1061 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
|
1062 the headline changes to a shadowed face, and the subtree below it is |
84308 | 1063 hidden. |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1064 @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
|
1065 @item C-u C-c C-x a |
84308 | 1066 Check if any direct children of the current headline should be archived. |
1067 To do this, each subtree is checked for open TODO entries. If none are | |
1068 found, the command offers to set the ARCHIVE tag for the child. If the | |
1069 cursor is @emph{not} on a headline when this command is invoked, the | |
1070 level 1 trees will be checked. | |
1071 @kindex C-@kbd{TAB} | |
1072 @item C-@kbd{TAB} | |
1073 Cycle a tree even if it is tagged with ARCHIVE. | |
1074 @end table | |
1075 | |
1076 @node Moving subtrees, , ARCHIVE tag, Archiving | |
1077 @subsection Moving subtrees | |
1078 @cindex external archiving | |
1079 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1080 Once an entire project is finished, you may want to move it to a different |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
1081 location. Org can move it to an @emph{Archive Sibling} in the same tree, to a |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1082 different tree in the current file, or to a different file, the archive file. |
84308 | 1083 |
1084 @table @kbd | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1085 @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
|
1086 @item C-c C-x A |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
1087 Move the current entry to the @emph{Archive Sibling}. This is a sibling of |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
1088 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE} |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1089 (@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
|
1090 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
|
1091 approximate position in the outline. |
84308 | 1092 @kindex C-c C-x C-s |
1093 @item C-c C-x C-s | |
1094 Archive the subtree starting at the cursor position to the location | |
1095 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
|
1096 lost like the file name, the category, inherited tags, and the TODO |
84308 | 1097 state will be store as properties in the entry. |
1098 @kindex C-u C-c C-x C-s | |
1099 @item C-u C-c C-x C-s | |
1100 Check if any direct children of the current headline could be moved to | |
1101 the archive. To do this, each subtree is checked for open TODO entries. | |
1102 If none are found, the command offers to move it to the archive | |
1103 location. If the cursor is @emph{not} on a headline when this command | |
1104 is invoked, the level 1 trees will be checked. | |
1105 @end table | |
1106 | |
1107 @cindex archive locations | |
1108 The default archive location is a file in the same directory as the | |
1109 current file, with the name derived by appending @file{_archive} to the | |
1110 current file name. For information and examples on how to change this, | |
1111 see the documentation string of the variable | |
1112 @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
|
1113 setting this variable, for example@footnote{For backward compatibility, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1114 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
|
1115 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
|
1116 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
|
1117 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
|
1118 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
|
1119 setting multiple archive locations in a buffer is using a property.}: |
84308 | 1120 |
1121 @example | |
1122 #+ARCHIVE: %s_done:: | |
1123 @end example | |
1124 | |
1125 @noindent | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1126 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
|
1127 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
|
1128 location as the value (@pxref{Properties and Columns}). |
84308 | 1129 |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
1130 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
|
1131 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
|
1132 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
|
1133 @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
|
1134 added. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
1135 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1136 @node Sparse trees, Plain lists, Archiving, Document Structure |
84308 | 1137 @section Sparse trees |
1138 @cindex sparse trees | |
1139 @cindex trees, sparse | |
1140 @cindex folding, sparse trees | |
1141 @cindex occur, command | |
1142 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1143 An important feature of Org mode is the ability to construct @emph{sparse |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1144 trees} for selected information in an outline tree, so that the entire |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1145 document is folded as much as possible, but the selected information is made |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1146 visible along with the headline structure above it@footnote{See also the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1147 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading}, |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1148 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1149 control on how much context is shown around each match.}. Just try it out |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1150 and you will see immediately how it works. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1151 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1152 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
|
1153 commands can be accessed through a dispatcher: |
84308 | 1154 |
1155 @table @kbd | |
1156 @kindex C-c / | |
1157 @item C-c / | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1158 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
|
1159 @kindex C-c / r |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1160 @item C-c / r |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1161 Occur. Prompts for a regexp and shows a sparse tree with all matches. If |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1162 the match is in a headline, the headline is made visible. If the match is in |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1163 the body of an entry, headline and body are made visible. In order to |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1164 provide minimal context, also the full hierarchy of headlines above the match |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1165 is shown, as well as the headline following the match. Each match is also |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1166 highlighted; the highlights disappear when the buffer is changed by an |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1167 editing command@footnote{depending on the option |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1168 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1169 When called with a @kbd{C-u} prefix argument, previous highlights are kept, |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1170 so several calls to this command can be stacked. |
84308 | 1171 @end table |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1172 |
84308 | 1173 @noindent |
1174 For frequently used sparse trees of specific search strings, you can | |
1175 use the variable @code{org-agenda-custom-commands} to define fast | |
1176 keyboard access to specific sparse trees. These commands will then be | |
1177 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}). | |
1178 For example: | |
1179 | |
1180 @lisp | |
1181 (setq org-agenda-custom-commands | |
1182 '(("f" occur-tree "FIXME"))) | |
1183 @end lisp | |
1184 | |
1185 @noindent will define the key @kbd{C-c a f} as a shortcut for creating | |
1186 a sparse tree matching the string @samp{FIXME}. | |
1187 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1188 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
|
1189 tags, or properties and will be discussed later in this manual. |
84308 | 1190 |
1191 @kindex C-c C-e v | |
1192 @cindex printing sparse trees | |
1193 @cindex visible text, printing | |
1194 To print a sparse tree, you can use the Emacs command | |
1195 @code{ps-print-buffer-with-faces} which does not print invisible parts | |
1196 of the document @footnote{This does not work under XEmacs, because | |
1197 XEmacs uses selective display for outlining, not text properties.}. | |
1198 Or you can use the command @kbd{C-c C-e v} to export only the visible | |
1199 part of the document and print the resulting file. | |
1200 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1201 @node Plain lists, Drawers, Sparse trees, Document Structure |
84308 | 1202 @section Plain lists |
1203 @cindex plain lists | |
1204 @cindex lists, plain | |
1205 @cindex lists, ordered | |
1206 @cindex ordered lists | |
1207 | |
1208 Within an entry of the outline tree, hand-formatted lists can provide | |
1209 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
|
1210 checkboxes (@pxref{Checkboxes}). Org supports editing such lists, |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1211 and the HTML exporter (@pxref{Exporting}) parses and formats them. |
84308 | 1212 |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1213 Org knows ordered lists, unordered lists, and description lists. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1214 @itemize @bullet |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1215 @item |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1216 @emph{Unordered} list items start with @samp{-}, @samp{+}, or |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1217 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1218 they will be seen as top-level headlines. Also, when you are hiding leading |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1219 stars to get a clean outline view, plain list items starting with a star are |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1220 visually indistinguishable from true headlines. In short: even though |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1221 @samp{*} is supported, it may be better to not use it for plain list items.} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1222 as bullets. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1223 @item |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1224 @emph{Ordered} list items start with a numeral followed by either a period or |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1225 a right parenthesis, such as @samp{1.} or @samp{1)}. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1226 @item |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1227 @emph{Description} list items are like unordered list items, but contain the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1228 separator @samp{ :: } to separate the description @emph{term} from the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1229 desciption. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1230 @end itemize |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1231 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1232 Items belonging to the same list must have the same indentation on the first |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1233 line. In particular, if an ordered list reaches number @samp{10.}, then the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1234 2--digit numbers must be written left-aligned with the other numbers in the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1235 list. Indentation also determines the end of a list item. It ends before |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1236 the next line that is indented like the bullet/number, or less. Empty lines |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1237 are part of the previous item, so you can have several paragraphs in one |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1238 item. If you would like an empty line to terminate all currently open plain |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1239 lists, configure the variable @code{org-empty-line-terminates-plain-lists}. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1240 Here is an example: |
84308 | 1241 |
1242 @example | |
1243 @group | |
1244 ** Lord of the Rings | |
1245 My favorite scenes are (in this order) | |
1246 1. The attack of the Rohirrim | |
1247 2. Eowyns fight with the witch king | |
1248 + this was already my favorite scene in the book | |
1249 + I really like Miranda Otto. | |
1250 3. Peter Jackson being shot by Legolas | |
1251 - on DVD only | |
1252 He makes a really funny face when it happens. | |
1253 But in the end, not individual scenes matter but the film as a whole. | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1254 Important actors in this film are: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1255 - @b{Elijah Wood} :: He plays the Frodo |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1256 - @b{Sean Austin} :: He plays the Sam, Frodos friend. I still remember |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1257 him very well from his role as Mikey Walsh a in the Goonies. |
84308 | 1258 @end group |
1259 @end example | |
1260 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1261 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
|
1262 deal with them correctly@footnote{Org only changes the filling |
84308 | 1263 settings for Emacs. For XEmacs, you should use Kyle E. Jones' |
1264 @file{filladapt.el}. To turn this on, put into @file{.emacs}: | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1265 @code{(require 'filladapt)}}, and by exporting them properly |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1266 (@pxref{Exporting}). |
84308 | 1267 |
1268 The following commands act on items when the cursor is in the first line | |
1269 of an item (the line with the bullet or number). | |
1270 | |
1271 @table @kbd | |
1272 @kindex @key{TAB} | |
1273 @item @key{TAB} | |
1274 Items can be folded just like headline levels if you set the variable | |
1275 @code{org-cycle-include-plain-lists}. The level of an item is then | |
1276 given by the indentation of the bullet/number. Items are always | |
1277 subordinate to real headlines, however; the hierarchies remain | |
1278 completely separated. | |
1279 | |
1280 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
|
1281 fixes the indentation of the current line in a heuristic way. |
84308 | 1282 @kindex M-@key{RET} |
1283 @item M-@key{RET} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1284 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
|
1285 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
|
1286 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
|
1287 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
|
1288 @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
|
1289 @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
|
1290 @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
|
1291 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
|
1292 bullet, a bullet is added to the current line. |
84308 | 1293 @kindex M-S-@key{RET} |
1294 @item M-S-@key{RET} | |
1295 Insert a new item with a checkbox (@pxref{Checkboxes}). | |
1296 @kindex S-@key{up} | |
1297 @kindex S-@key{down} | |
1298 @item S-@key{up} | |
1299 @itemx S-@key{down} | |
1300 Jump to the previous/next item in the current list. | |
1301 @kindex M-S-@key{up} | |
1302 @kindex M-S-@key{down} | |
1303 @item M-S-@key{up} | |
1304 @itemx M-S-@key{down} | |
1305 Move the item including subitems up/down (swap with previous/next item | |
1306 of same indentation). If the list is ordered, renumbering is | |
1307 automatic. | |
1308 @kindex M-S-@key{left} | |
1309 @kindex M-S-@key{right} | |
1310 @item M-S-@key{left} | |
1311 @itemx M-S-@key{right} | |
1312 Decrease/increase the indentation of the item, including subitems. | |
1313 Initially, the item tree is selected based on current indentation. | |
1314 When these commands are executed several times in direct succession, | |
1315 the initially selected region is used, even if the new indentation | |
1316 would imply a different hierarchy. To use the new hierarchy, break | |
1317 the command chain with a cursor motion or so. | |
1318 @kindex C-c C-c | |
1319 @item C-c C-c | |
1320 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
|
1321 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
|
1322 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
|
1323 an ordered list, make sure the numbering is OK. |
84308 | 1324 @kindex C-c - |
1325 @item C-c - | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1326 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
|
1327 (@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
|
1328 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
|
1329 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
|
1330 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
|
1331 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
|
1332 converted into a list item. |
99851
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
1333 @kindex S-@key{left} |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
1334 @kindex S-@key{right} |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
1335 @item S-@key{left}/@key{right} |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
1336 Also cycle bullet styles when in the first line of an item. |
84308 | 1337 @end table |
1338 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1339 @node Drawers, Orgstruct mode, Plain lists, Document Structure |
84308 | 1340 @section Drawers |
1341 @cindex drawers | |
1342 @cindex visibility cycling, drawers | |
1343 | |
1344 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
|
1345 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
|
1346 Drawers need to be configured with the variable |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1347 @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
|
1348 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers |
84308 | 1349 look like this: |
1350 | |
1351 @example | |
1352 ** This is a headline | |
1353 Still outside the drawer | |
1354 :DRAWERNAME: | |
1355 This is inside the drawer. | |
1356 :END: | |
1357 After the drawer. | |
1358 @end example | |
1359 | |
1360 Visibility cycling (@pxref{Visibility cycling}) on the headline will | |
1361 hide and show the entry, but keep the drawer collapsed to a single line. | |
1362 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
|
1363 drawer line and press @key{TAB} there. Org mode uses a drawer for |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1364 storing properties (@pxref{Properties and Columns}), and another one for |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1365 storing clock times (@pxref{Clocking work time}). |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1366 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1367 @node Orgstruct mode, , Drawers, Document Structure |
84308 | 1368 @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
|
1369 @cindex Orgstruct mode |
84308 | 1370 @cindex minor mode for structure editing |
1371 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1372 If you like the intuitive way the Org mode structure editing and list |
84308 | 1373 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
|
1374 like Text mode or Mail mode as well. The minor mode Orgstruct mode |
84308 | 1375 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
|
1376 orgstruct-mode}. To turn it on by default, for example in Mail mode, |
84308 | 1377 use |
1378 | |
1379 @lisp | |
1380 (add-hook 'mail-mode-hook 'turn-on-orgstruct) | |
1381 @end lisp | |
1382 | |
1383 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
|
1384 Org like a headline of the first line of a list item, most |
84308 | 1385 structure editing commands will work, even if the same keys normally |
1386 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
|
1387 cursor is not in one of those special lines, Orgstruct mode lurks |
84308 | 1388 silently in the shadow. |
1389 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1390 @node Tables, Hyperlinks, Document Structure, Top |
84308 | 1391 @chapter Tables |
1392 @cindex tables | |
1393 @cindex editing tables | |
1394 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1395 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
|
1396 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
|
1397 package |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1398 @ifinfo |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1399 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}). |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1400 @end ifinfo |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1401 @ifnotinfo |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1402 (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
|
1403 calculator). |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1404 @end ifnotinfo |
84308 | 1405 |
1406 @menu | |
1407 * 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
|
1408 * Narrow columns:: Stop wasting space in tables |
84308 | 1409 * 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
|
1410 * 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
|
1411 * The spreadsheet:: The table editor has spreadsheet capabilities |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
1412 * Org Plot:: Plotting from org tables |
84308 | 1413 @end menu |
1414 | |
1415 @node Built-in table editor, Narrow columns, Tables, Tables | |
1416 @section The built-in table editor | |
1417 @cindex table editor, built-in | |
1418 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1419 Org makes it easy to format tables in plain ASCII. Any line with |
84308 | 1420 @samp{|} as the first non-whitespace character is considered part of a |
1421 table. @samp{|} is also the column separator. A table might look like | |
1422 this: | |
1423 | |
1424 @example | |
1425 | Name | Phone | Age | | |
1426 |-------+-------+-----| | |
1427 | Peter | 1234 | 17 | | |
1428 | Anna | 4321 | 25 | | |
1429 @end example | |
1430 | |
1431 A table is re-aligned automatically each time you press @key{TAB} or | |
1432 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to | |
1433 the next field (@key{RET} to the next row) and creates new table rows | |
1434 at the end of the table or before horizontal lines. The indentation | |
1435 of the table is set by the first line. Any line starting with | |
1436 @samp{|-} is considered as a horizontal separator line and will be | |
1437 expanded on the next re-align to span the whole table width. So, to | |
1438 create the above table, you would only type | |
1439 | |
1440 @example | |
1441 |Name|Phone|Age| | |
1442 |- | |
1443 @end example | |
1444 | |
1445 @noindent and then press @key{TAB} to align the table and start filling in | |
1446 fields. | |
1447 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1448 When typing text into a field, Org treats @key{DEL}, |
84308 | 1449 @key{Backspace}, and all character keys in a special way, so that |
1450 inserting and deleting avoids shifting other fields. Also, when | |
1451 typing @emph{immediately after the cursor was moved into a new field | |
1452 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the | |
1453 field is automatically made blank. If this behavior is too | |
1454 unpredictable for you, configure the variables | |
1455 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}. | |
1456 | |
1457 @table @kbd | |
1458 @tsubheading{Creation and conversion} | |
1459 @kindex C-c | | |
1460 @item C-c | | |
1461 Convert the active region to table. If every line contains at least one | |
1462 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
|
1463 If every line contains a comma, comma-separated values (CSV) are assumed. |
84308 | 1464 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
|
1465 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
|
1466 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
|
1467 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
|
1468 @* |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1469 If there is no active region, this command creates an empty Org |
84308 | 1470 table. But it's easier just to start typing, like |
1471 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}. | |
1472 | |
1473 @tsubheading{Re-aligning and field motion} | |
1474 @kindex C-c C-c | |
1475 @item C-c C-c | |
1476 Re-align the table without moving the cursor. | |
1477 @c | |
1478 @kindex @key{TAB} | |
1479 @item @key{TAB} | |
1480 Re-align the table, move to the next field. Creates a new row if | |
1481 necessary. | |
1482 @c | |
1483 @kindex S-@key{TAB} | |
1484 @item S-@key{TAB} | |
1485 Re-align, move to previous field. | |
1486 @c | |
1487 @kindex @key{RET} | |
1488 @item @key{RET} | |
1489 Re-align the table and move down to next row. Creates a new row if | |
1490 necessary. At the beginning or end of a line, @key{RET} still does | |
1491 NEWLINE, so it can be used to split a table. | |
1492 | |
1493 @tsubheading{Column and row editing} | |
1494 @kindex M-@key{left} | |
1495 @kindex M-@key{right} | |
1496 @item M-@key{left} | |
1497 @itemx M-@key{right} | |
1498 Move the current column left/right. | |
1499 @c | |
1500 @kindex M-S-@key{left} | |
1501 @item M-S-@key{left} | |
1502 Kill the current column. | |
1503 @c | |
1504 @kindex M-S-@key{right} | |
1505 @item M-S-@key{right} | |
1506 Insert a new column to the left of the cursor position. | |
1507 @c | |
1508 @kindex M-@key{up} | |
1509 @kindex M-@key{down} | |
1510 @item M-@key{up} | |
1511 @itemx M-@key{down} | |
1512 Move the current row up/down. | |
1513 @c | |
1514 @kindex M-S-@key{up} | |
1515 @item M-S-@key{up} | |
1516 Kill the current row or horizontal line. | |
1517 @c | |
1518 @kindex M-S-@key{down} | |
1519 @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
|
1520 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
|
1521 created below the current one. |
84308 | 1522 @c |
1523 @kindex C-c - | |
1524 @item C-c - | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1525 Insert a horizontal line below current row. With a prefix argument, the line |
84308 | 1526 is created above the current line. |
1527 @c | |
1528 @kindex C-c ^ | |
1529 @item C-c ^ | |
1530 Sort the table lines in the region. The position of point indicates the | |
1531 column to be used for sorting, and the range of lines is the range | |
1532 between the nearest horizontal separator lines, or the entire table. If | |
1533 point is before the first column, you will be prompted for the sorting | |
1534 column. If there is an active region, the mark specifies the first line | |
1535 and the sorting column, while point should be in the last line to be | |
1536 included into the sorting. The command prompts for the sorting type | |
1537 (alphabetically, numerically, or by time). When called with a prefix | |
1538 argument, alphabetic sorting will be case-sensitive. | |
1539 | |
1540 @tsubheading{Regions} | |
1541 @kindex C-c C-x M-w | |
1542 @item C-c C-x M-w | |
1543 Copy a rectangular region from a table to a special clipboard. Point | |
1544 and mark determine edge fields of the rectangle. The process ignores | |
1545 horizontal separator lines. | |
1546 @c | |
1547 @kindex C-c C-x C-w | |
1548 @item C-c C-x C-w | |
1549 Copy a rectangular region from a table to a special clipboard, and | |
1550 blank all fields in the rectangle. So this is the ``cut'' operation. | |
1551 @c | |
1552 @kindex C-c C-x C-y | |
1553 @item C-c C-x C-y | |
1554 Paste a rectangular region into a table. | |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
1555 The upper left corner ends up in the current field. All involved fields |
84308 | 1556 will be overwritten. If the rectangle does not fit into the present table, |
1557 the table is enlarged as needed. The process ignores horizontal separator | |
1558 lines. | |
1559 @c | |
1560 @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
|
1561 @kindex M-@key{RET} |
84308 | 1562 @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
|
1563 @itemx M-@kbd{RET} |
84308 | 1564 Wrap several fields in a column like a paragraph. If there is an active |
1565 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
|
1566 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
|
1567 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
|
1568 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
|
1569 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
|
1570 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
|
1571 field is made blank, and the content is appended to the field above. |
84308 | 1572 |
1573 @tsubheading{Calculations} | |
1574 @cindex formula, in tables | |
1575 @cindex calculations, in tables | |
1576 @cindex region, active | |
1577 @cindex active region | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1578 @cindex Transient mark mode |
84308 | 1579 @kindex C-c + |
1580 @item C-c + | |
1581 Sum the numbers in the current column, or in the rectangle defined by | |
1582 the active region. The result is shown in the echo area and can | |
1583 be inserted with @kbd{C-y}. | |
1584 @c | |
1585 @kindex S-@key{RET} | |
1586 @item S-@key{RET} | |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
1587 When current field is empty, copy from first non-empty field above. When not |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
1588 empty, copy current field down to next row and move cursor along with it. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
1589 Depending on the variable @code{org-table-copy-increment}, integer field |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
1590 values will be incremented during copy. Integers that are too large will not |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
1591 be incremented. Also, a @code{0} prefix argument temporarily dispables the |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
1592 increment. This key is also used by CUA mode (@pxref{Cooperation}). |
84308 | 1593 |
1594 @tsubheading{Miscellaneous} | |
1595 @kindex C-c ` | |
1596 @item C-c ` | |
1597 Edit the current field in a separate window. This is useful for fields | |
1598 that are not fully visible (@pxref{Narrow columns}). When called with a | |
1599 @kbd{C-u} prefix, just make the full field visible, so that it can be | |
1600 edited in place. | |
1601 @c | |
1602 @item M-x org-table-import | |
1603 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
|
1604 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
|
1605 from a database, because these programs generally can write |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1606 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
|
1607 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
|
1608 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
|
1609 separator. |
84308 | 1610 @item C-c | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1611 Tables can also be imported by pasting tabular text into the Org |
84308 | 1612 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
1613 @kbd{C-c |} command (see above under @i{Creation and conversion}). |
84308 | 1614 @c |
1615 @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
|
1616 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
|
1617 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
|
1618 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
|
1619 @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
|
1620 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1621 name and the format for table export in a subtree. Org supports quite |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1622 general formats for exported tables. The exporter format is the same as the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1623 format used by Orgtbl radio tables, see @ref{Translator functions} for a |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1624 detailed description. |
84308 | 1625 @end table |
1626 | |
1627 If you don't like the automatic table editor because it gets in your | |
1628 way on lines which you would like to start with @samp{|}, you can turn | |
1629 it off with | |
1630 | |
1631 @lisp | |
1632 (setq org-enable-table-editor nil) | |
1633 @end lisp | |
1634 | |
1635 @noindent Then the only table command that still works is | |
1636 @kbd{C-c C-c} to do a manual re-align. | |
1637 | |
1638 @node Narrow columns, Column groups, Built-in table editor, Tables | |
1639 @section Narrow columns | |
1640 @cindex narrow columns in tables | |
1641 | |
1642 The width of columns is automatically determined by the table editor. | |
1643 Sometimes a single field or a few fields need to carry more text, | |
1644 leading to inconveniently wide columns. To limit@footnote{This feature | |
1645 does not work on XEmacs.} the width of a column, one field anywhere in | |
1646 the column may contain just the string @samp{<N>} where @samp{N} is an | |
1647 integer specifying the width of the column in characters. The next | |
1648 re-align will then set the width of this column to no more than this | |
1649 value. | |
1650 | |
1651 @example | |
1652 @group | |
1653 |---+------------------------------| |---+--------| | |
1654 | | | | | <6> | | |
1655 | 1 | one | | 1 | one | | |
1656 | 2 | two | ----\ | 2 | two | | |
1657 | 3 | This is a long chunk of text | ----/ | 3 | This=> | | |
1658 | 4 | four | | 4 | four | | |
1659 |---+------------------------------| |---+--------| | |
1660 @end group | |
1661 @end example | |
1662 | |
1663 @noindent | |
1664 Fields that are wider become clipped and end in the string @samp{=>}. | |
1665 Note that the full text is still in the buffer, it is only invisible. | |
1666 To see the full text, hold the mouse over the field - a tool-tip window | |
1667 will show the full content. To edit such a field, use the command | |
1668 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will | |
1669 open a new window with the full field. Edit it and finish with @kbd{C-c | |
1670 C-c}. | |
1671 | |
1672 When visiting a file containing a table with narrowed columns, the | |
1673 necessary character hiding has not yet happened, and the table needs to | |
1674 be aligned before it looks nice. Setting the option | |
1675 @code{org-startup-align-all-tables} will realign all tables in a file | |
1676 upon visiting, but also slow down startup. You can also set this option | |
1677 on a per-file basis with: | |
1678 | |
1679 @example | |
1680 #+STARTUP: align | |
1681 #+STARTUP: noalign | |
1682 @end example | |
1683 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1684 @node Column groups, Orgtbl mode, Narrow columns, Tables |
84308 | 1685 @section Column groups |
1686 @cindex grouping columns in tables | |
1687 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1688 When Org exports tables, it does so by default without vertical |
84308 | 1689 lines because that is visually more satisfying in general. Occasionally |
1690 however, vertical lines can be useful to structure a table into groups | |
1691 of columns, much like horizontal lines can do for groups of rows. In | |
1692 order to specify column groups, you can use a special row where the | |
1693 first field contains only @samp{/}. The further fields can either | |
1694 contain @samp{<} to indicate that this column should start a group, | |
1695 @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
|
1696 a group of its own. Boundaries between column groups will upon export be |
84308 | 1697 marked with vertical lines. Here is an example: |
1698 | |
1699 @example | |
1700 | | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) | | |
1701 |---+----+-----+-----+-----+---------+------------| | |
1702 | / | <> | < | | > | < | > | | |
1703 | # | 1 | 1 | 1 | 1 | 1 | 1 | | |
1704 | # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 | | |
1705 | # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 | | |
1706 |---+----+-----+-----+-----+---------+------------| | |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
1707 #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2))) |
84308 | 1708 @end example |
1709 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1710 It is also sufficient to just insert the column group starters after |
84308 | 1711 every vertical line you'd like to have: |
1712 | |
1713 @example | |
1714 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) | | |
1715 |----+-----+-----+-----+---------+------------| | |
1716 | / | < | | | < | | | |
1717 @end example | |
1718 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1719 @node Orgtbl mode, The spreadsheet, Column groups, Tables |
84308 | 1720 @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
|
1721 @cindex Orgtbl mode |
84308 | 1722 @cindex minor mode for tables |
1723 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1724 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
|
1725 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
|
1726 The minor mode Orgtbl mode makes this possible. You can always toggle |
84308 | 1727 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for |
1728 example in mail mode, use | |
1729 | |
1730 @lisp | |
1731 (add-hook 'mail-mode-hook 'turn-on-orgtbl) | |
1732 @end lisp | |
1733 | |
1734 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
|
1735 in arbitrary syntax with Orgtbl mode. For example, it is possible to |
84308 | 1736 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
|
1737 Orgtbl mode, including spreadsheet capabilities. For details, see |
84308 | 1738 @ref{Tables in arbitrary syntax}. |
1739 | |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
1740 @node The spreadsheet, Org Plot, Orgtbl mode, Tables |
84308 | 1741 @section The spreadsheet |
1742 @cindex calculations, in tables | |
1743 @cindex spreadsheet capabilities | |
1744 @cindex @file{calc} package | |
1745 | |
1746 The table editor makes use of the Emacs @file{calc} package to implement | |
1747 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
|
1748 derive fields from other fields. While fully featured, Org's |
84308 | 1749 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
|
1750 Org knows the concept of a @emph{column formula} that will be |
84308 | 1751 applied to all non-header fields in a column without having to copy the |
1752 formula to each relevant field. | |
1753 | |
1754 @menu | |
1755 * References:: How to refer to another field or range | |
1756 * Formula syntax for Calc:: Using Calc to compute stuff | |
1757 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp | |
1758 * Field formulas:: Formulas valid for a single field | |
1759 * Column formulas:: Formulas valid for an entire column | |
1760 * Editing and debugging formulas:: Fixing formulas | |
1761 * Updating the table:: Recomputing all dependent fields | |
1762 * Advanced features:: Field names, parameters and automatic recalc | |
1763 @end menu | |
1764 | |
1765 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet | |
1766 @subsection References | |
1767 @cindex references | |
1768 | |
1769 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
|
1770 reference other fields or ranges. In Org, fields can be referenced |
84308 | 1771 by name, by absolute coordinates, and by relative coordinates. To find |
1772 out what the coordinates of a field are, press @kbd{C-c ?} in that | |
1773 field, or press @kbd{C-c @}} to toggle the display of a grid. | |
1774 | |
1775 @subsubheading Field references | |
1776 @cindex field references | |
1777 @cindex references, to fields | |
1778 | |
1779 Formulas can reference the value of another field in two ways. Like in | |
1780 any other spreadsheet, you may reference fields with a letter/number | |
1781 combination like @code{B3}, meaning the 2nd field in the 3rd row. | |
1782 @c Such references are always fixed to that field, they don't change | |
1783 @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
|
1784 @c Org's @code{B3} behaves like @code{$B$3} in other spreadsheets. |
84308 | 1785 |
1786 @noindent | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1787 Org also uses another, more general operator that looks like this: |
84308 | 1788 @example |
1789 @@row$column | |
1790 @end example | |
1791 | |
1792 @noindent | |
1793 Column references can be absolute like @samp{1}, @samp{2},...@samp{N}, | |
100508
00c300ec74ba
2008-12-18 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100460
diff
changeset
|
1794 or relative to the current column like @samp{+1} or @samp{-2}. |
84308 | 1795 |
1796 The row specification only counts data lines and ignores horizontal | |
1797 separator lines (hlines). You can use absolute row numbers | |
1798 @samp{1}...@samp{N}, and row numbers relative to the current row like | |
1799 @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
|
1800 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
|
1801 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
|
1802 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
|
1803 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
|
1804 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
|
1805 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
|
1806 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
|
1807 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
|
1808 the value directly at the hline is used. |
84308 | 1809 |
1810 @samp{0} refers to the current row and column. Also, if you omit | |
1811 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
|
1812 row/column is implied. |
84308 | 1813 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1814 Org's references with @emph{unsigned} numbers are fixed references |
84308 | 1815 in the sense that if you use the same reference in the formula for two |
1816 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
|
1817 Org's references with @emph{signed} numbers are floating |
84308 | 1818 references because the same reference operator can reference different |
1819 fields depending on the field being calculated by the formula. | |
1820 | |
100607
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
1821 As a special case references like @samp{$LR5} and @samp{$LR12} can be used to |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
1822 refer in a stable way to the 5th and 12th field in the last row of the table. |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
1823 |
84308 | 1824 Here are a few examples: |
1825 | |
1826 @example | |
1827 @@2$3 @r{2nd row, 3rd column} | |
1828 C2 @r{same as previous} | |
1829 $5 @r{column 5 in the current row} | |
1830 E& @r{same as previous} | |
1831 @@2 @r{current column, row 2} | |
1832 @@-1$-3 @r{the field one row up, three columns to the left} | |
1833 @@-I$2 @r{field just under hline above current row, column 2} | |
1834 @end example | |
1835 | |
1836 @subsubheading Range references | |
1837 @cindex range references | |
1838 @cindex references, to ranges | |
1839 | |
1840 You may reference a rectangular range of fields by specifying two field | |
1841 references connected by two dots @samp{..}. If both fields are in the | |
1842 current row, you may simply use @samp{$2..$7}, but if at least one field | |
1843 is in a different row, you need to use the general @code{@@row$column} | |
1844 format at least for the first field (i.e the reference must start with | |
1845 @samp{@@} in order to be interpreted correctly). Examples: | |
1846 | |
1847 @example | |
1848 $1..$3 @r{First three fields in the current row.} | |
1849 $P..$Q @r{Range, using column names (see under Advanced)} | |
1850 @@2$1..@@4$3 @r{6 fields between these two fields.} | |
1851 A2..C4 @r{Same as above.} | |
1852 @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row} | |
1853 @end example | |
1854 | |
1855 @noindent Range references return a vector of values that can be fed | |
1856 into Calc vector functions. Empty fields in ranges are normally | |
1857 suppressed, so that the vector contains only the non-empty fields (but | |
1858 see the @samp{E} mode switch below). If there are no non-empty fields, | |
1859 @samp{[0]} is returned to avoid syntax errors in formulas. | |
1860 | |
1861 @subsubheading Named references | |
1862 @cindex named references | |
1863 @cindex references, named | |
1864 @cindex name, of column or field | |
1865 @cindex constants, in calculations | |
1866 | |
1867 @samp{$name} is interpreted as the name of a column, parameter or | |
1868 constant. Constants are defined globally through the variable | |
1869 @code{org-table-formula-constants}, and locally (for the file) through a | |
1870 line like | |
1871 | |
1872 @example | |
1873 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6 | |
1874 @end example | |
1875 | |
1876 @noindent | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1877 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
|
1878 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
|
1879 @samp{$PROP_Xyz}, and the property will be searched in the current |
84308 | 1880 outline entry and in the hierarchy above it. If you have the |
1881 @file{constants.el} package, it will also be used to resolve constants, | |
1882 including natural constants like @samp{$h} for Planck's constant, and | |
1883 units like @samp{$km} for kilometers@footnote{@file{Constant.el} can | |
1884 supply the values of constants in two different unit systems, @code{SI} | |
1885 and @code{cgs}. Which one is used depends on the value of the variable | |
1886 @code{constants-unit-system}. You can use the @code{#+STARTUP} options | |
1887 @code{constSI} and @code{constcgs} to set this value for the current | |
1888 buffer.}. Column names and parameters can be specified in special table | |
1889 lines. These are described below, see @ref{Advanced features}. All | |
1890 names must start with a letter, and further consist of letters and | |
1891 numbers. | |
1892 | |
1893 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet | |
1894 @subsection Formula syntax for Calc | |
1895 @cindex formula syntax, Calc | |
1896 @cindex syntax, of formulas | |
1897 | |
1898 A formula can be any algebraic expression understood by the Emacs | |
1899 @file{Calc} package. @b{Note that @file{calc} has the | |
1900 non-standard convention that @samp{/} has lower precedence than | |
1901 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before | |
1902 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
|
1903 Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU |
84308 | 1904 Emacs Calc Manual}), |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1905 @c FIXME: The link to the Calc manual in HTML does not work. |
84308 | 1906 variable substitution takes place according to the rules described above. |
1907 @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
|
1908 The range vectors can be directly fed into the Calc vector functions |
84308 | 1909 like @samp{vmean} and @samp{vsum}. |
1910 | |
1911 @cindex format specifier | |
1912 @cindex mode, for @file{calc} | |
1913 A formula can contain an optional mode string after a semicolon. This | |
1914 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
|
1915 execution. By default, Org uses the standard Calc modes (precision |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
1916 12, angular units degrees, fraction and symbolic modes off). The display |
84308 | 1917 format, however, has been changed to @code{(float 5)} to keep tables |
1918 compact. The default settings can be configured using the variable | |
1919 @code{org-calc-default-modes}. | |
1920 | |
1921 @example | |
1922 p20 @r{switch the internal precision to 20 digits} | |
1923 n3 s3 e2 f4 @r{normal, scientific, engineering, or fixed display format} | |
1924 D R @r{angle modes: degrees, radians} | |
1925 F S @r{fraction and symbolic modes} | |
1926 N @r{interpret all fields as numbers, use 0 for non-numbers} | |
1927 T @r{force text interpretation} | |
1928 E @r{keep empty fields in ranges} | |
1929 @end example | |
1930 | |
1931 @noindent | |
1932 In addition, you may provide a @code{printf} format specifier to | |
1933 reformat the final result. A few examples: | |
1934 | |
1935 @example | |
1936 $1+$2 @r{Sum of first and second field} | |
1937 $1+$2;%.2f @r{Same, format result to two decimals} | |
1938 exp($2)+exp($1) @r{Math functions can be used} | |
1939 $0;%.1f @r{Reformat current cell to 1 decimal} | |
1940 ($3-32)*5/9 @r{Degrees F -> C conversion} | |
1941 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}} | |
1942 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1} | |
1943 sin($1);Dp3%.1e @r{Same, but use printf specifier for display} | |
1944 vmean($2..$7) @r{Compute column range mean, using vector function} | |
1945 vmean($2..$7);EN @r{Same, but treat empty fields as 0} | |
1946 taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree} | |
1947 @end example | |
1948 | |
1949 Calc also contains a complete set of logical operations. For example | |
1950 | |
1951 @example | |
1952 if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty} | |
1953 @end example | |
1954 | |
1955 @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet | |
1956 @subsection Emacs Lisp forms as formulas | |
1957 @cindex Lisp forms, as table formulas | |
1958 | |
1959 It is also possible to write a formula in Emacs Lisp; this can be useful | |
1960 for string manipulation and control structures, if the Calc's | |
1961 functionality is not enough. If a formula starts with a single quote | |
1962 followed by an opening parenthesis, then it is evaluated as a lisp form. | |
1963 The evaluation should return either a string or a number. Just as with | |
1964 @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
|
1965 semicolon. With Emacs Lisp forms, you need to be conscious about the way |
84308 | 1966 field references are interpolated into the form. By default, a |
1967 reference will be interpolated as a Lisp string (in double quotes) | |
1968 containing the field. If you provide the @samp{N} mode switch, all | |
1969 referenced elements will be numbers (non-number fields will be zero) and | |
1970 interpolated as Lisp numbers, without quotes. If you provide the | |
1971 @samp{L} flag, all fields will be interpolated literally, without quotes. | |
1972 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
|
1973 form, enclose the reference operator itself in double quotes, like |
84308 | 1974 @code{"$3"}. Ranges are inserted as space-separated fields, so you can |
1975 embed them in list or vector syntax. A few examples, note how the | |
1976 @samp{N} mode is used when we do computations in lisp. | |
1977 | |
1978 @example | |
1979 @r{Swap the first two characters of the content of column 1} | |
1980 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2)) | |
1981 @r{Add columns 1 and 2, equivalent to the Calc's @code{$1+$2}} | |
1982 '(+ $1 $2);N | |
1983 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}} | |
1984 '(apply '+ '($1..$4));N | |
1985 @end example | |
1986 | |
1987 @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet | |
1988 @subsection Field formulas | |
1989 @cindex field formula | |
1990 @cindex formula, for individual table field | |
1991 | |
1992 To assign a formula to a particular field, type it directly into the | |
1993 field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you | |
1994 press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in | |
1995 the field, the formula will be stored as the formula for this field, | |
1996 evaluated, and the current field replaced with the result. | |
1997 | |
1998 Formulas are stored in a special line starting with @samp{#+TBLFM:} | |
1999 directly below the table. If you typed the equation in the 4th field of | |
2000 the 3rd data line in the table, the formula will look like | |
2001 @samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows | |
2002 with the appropriate commands, @i{absolute references} (but not relative | |
2003 ones) in stored formulas are modified in order to still reference the | |
2004 same field. Of cause this is not true if you edit the table structure | |
2005 with normal editing commands - then you must fix the equations yourself. | |
100607
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
2006 The left hand side of a formula may also be a named field (@pxref{Advanced |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
2007 features}), or a last-row reference like @samp{$LR3}. |
84308 | 2008 |
2009 Instead of typing an equation into the field, you may also use the | |
2010 following command | |
2011 | |
2012 @table @kbd | |
2013 @kindex C-u C-c = | |
2014 @item C-u C-c = | |
2015 Install a new formula for the current field. The command prompts for a | |
2016 formula, with default taken from the @samp{#+TBLFM:} line, applies | |
2017 it to the current field and stores it. | |
2018 @end table | |
2019 | |
2020 @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet | |
2021 @subsection Column formulas | |
2022 @cindex column formula | |
2023 @cindex formula, for table column | |
2024 | |
2025 Often in a table, the same formula should be used for all fields in a | |
2026 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
|
2027 in that column, Org allows to assign a single formula to an entire |
84308 | 2028 column. If the table contains horizontal separator hlines, everything |
2029 before the first such line is considered part of the table @emph{header} | |
2030 and will not be modified by column formulas. | |
2031 | |
2032 To assign a formula to a column, type it directly into any field in the | |
2033 column, preceded by an equal sign, like @samp{=$1+$2}. When you press | |
2034 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the | |
2035 field, the formula will be stored as the formula for the current column, | |
2036 evaluated and the current field replaced with the result. If the field | |
2037 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
|
2038 used. For each column, Org will only remember the most recently |
84308 | 2039 used formula. In the @samp{TBLFM:} line, column formulas will look like |
2040 @samp{$4=$1+$2}. | |
2041 | |
2042 Instead of typing an equation into the field, you may also use the | |
2043 following command: | |
2044 | |
2045 @table @kbd | |
2046 @kindex C-c = | |
2047 @item C-c = | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2048 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
|
2049 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
|
2050 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
|
2051 stores it. With a numeric prefix argument(e.g. @kbd{C-5 C-c =}) the command |
84308 | 2052 will apply it to that many consecutive fields in the current column. |
2053 @end table | |
2054 | |
2055 @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
|
2056 @subsection Editing and debugging formulas |
84308 | 2057 @cindex formula editing |
2058 @cindex editing, of table formulas | |
2059 | |
2060 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
|
2061 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
|
2062 formulas of a table. When offering a formula for editing, Org |
84308 | 2063 converts references to the standard format (like @code{B3} or @code{D&}) |
2064 if possible. If you prefer to only work with the internal format (like | |
2065 @code{@@3$2} or @code{$4}), configure the variable | |
2066 @code{org-table-use-standard-references}. | |
2067 | |
2068 @table @kbd | |
2069 @kindex C-c = | |
2070 @kindex C-u C-c = | |
2071 @item C-c = | |
2072 @itemx C-u C-c = | |
2073 Edit the formula associated with the current column/field in the | |
2074 minibuffer. See @ref{Column formulas} and @ref{Field formulas}. | |
2075 @kindex C-u C-u C-c = | |
2076 @item C-u C-u C-c = | |
2077 Re-insert the active formula (either a | |
2078 field formula, or a column formula) into the current field, so that you | |
2079 can edit it directly in the field. The advantage over editing in the | |
2080 minibuffer is that you can use the command @kbd{C-c ?}. | |
2081 @kindex C-c ? | |
2082 @item C-c ? | |
2083 While editing a formula in a table field, highlight the field(s) | |
2084 referenced by the reference at the cursor position in the formula. | |
2085 @kindex C-c @} | |
2086 @item C-c @} | |
2087 Toggle the display of row and column numbers for a table, using | |
2088 overlays. These are updated each time the table is aligned, you can | |
2089 force it with @kbd{C-c C-c}. | |
2090 @kindex C-c @{ | |
2091 @item C-c @{ | |
2092 Toggle the formula debugger on and off. See below. | |
2093 @kindex C-c ' | |
2094 @item C-c ' | |
2095 Edit all formulas for the current table in a special buffer, where the | |
2096 formulas will be displayed one per line. If the current field has an | |
2097 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
|
2098 While inside the special buffer, Org will automatically highlight |
84308 | 2099 any field or range reference at the cursor position. You may edit, |
2100 remove and add formulas, and use the following commands: | |
2101 @table @kbd | |
2102 @kindex C-c C-c | |
2103 @kindex C-x C-s | |
2104 @item C-c C-c | |
2105 @itemx C-x C-s | |
2106 Exit the formula editor and store the modified formulas. With @kbd{C-u} | |
2107 prefix, also apply the new formulas to the entire table. | |
2108 @kindex C-c C-q | |
2109 @item C-c C-q | |
2110 Exit the formula editor without installing changes. | |
2111 @kindex C-c C-r | |
2112 @item C-c C-r | |
2113 Toggle all references in the formula editor between standard (like | |
2114 @code{B3}) and internal (like @code{@@3$2}). | |
2115 @kindex @key{TAB} | |
2116 @item @key{TAB} | |
2117 Pretty-print or indent lisp formula at point. When in a line containing | |
2118 a lisp formula, format the formula according to Emacs Lisp rules. | |
2119 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
|
2120 formula, @key{TAB} re-indents just like in Emacs lisp mode. |
84308 | 2121 @kindex M-@key{TAB} |
2122 @item M-@key{TAB} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2123 Complete Lisp symbols, just like in Emacs lisp mode. |
84308 | 2124 @kindex S-@key{up} |
2125 @kindex S-@key{down} | |
2126 @kindex S-@key{left} | |
2127 @kindex S-@key{right} | |
2128 @item S-@key{up}/@key{down}/@key{left}/@key{right} | |
2129 Shift the reference at point. For example, if the reference is | |
2130 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}. | |
2131 This also works for relative references, and for hline references. | |
2132 @kindex M-S-@key{up} | |
2133 @kindex M-S-@key{down} | |
2134 @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
|
2135 Move the test line for column formulas in the Org buffer up and |
84308 | 2136 down. |
2137 @kindex M-@key{up} | |
2138 @kindex M-@key{down} | |
2139 @item M-@key{up}/@key{down} | |
2140 Scroll the window displaying the table. | |
2141 @kindex C-c @} | |
2142 @item C-c @} | |
2143 Turn the coordinate grid in the table on and off. | |
2144 @end table | |
2145 @end table | |
2146 | |
2147 Making a table field blank does not remove the formula associated with | |
2148 the field, because that is stored in a different line (the @samp{TBLFM} | |
2149 line) - during the next recalculation the field will be filled again. | |
2150 To remove a formula from a field, you have to give an empty reply when | |
2151 prompted for the formula, or to edit the @samp{#+TBLFM} line. | |
2152 | |
2153 @kindex C-c C-c | |
2154 You may edit the @samp{#+TBLFM} directly and re-apply the changed | |
2155 equations with @kbd{C-c C-c} in that line, or with the normal | |
2156 recalculation commands in the table. | |
2157 | |
2158 @subsubheading Debugging formulas | |
2159 @cindex formula debugging | |
2160 @cindex debugging, of table formulas | |
2161 When the evaluation of a formula leads to an error, the field content | |
2162 becomes the string @samp{#ERROR}. If you would like see what is going | |
2163 on during variable substitution and calculation in order to find a bug, | |
2164 turn on formula debugging in the @code{Tbl} menu and repeat the | |
2165 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a | |
2166 field. Detailed information will be displayed. | |
2167 | |
2168 @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
|
2169 @subsection Updating the table |
84308 | 2170 @cindex recomputing table fields |
2171 @cindex updating, table | |
2172 | |
2173 Recalculation of a table is normally not automatic, but needs to be | |
2174 triggered by a command. See @ref{Advanced features} for a way to make | |
2175 recalculation at least semi-automatically. | |
2176 | |
2177 In order to recalculate a line of a table or the entire table, use the | |
2178 following commands: | |
2179 | |
2180 @table @kbd | |
2181 @kindex C-c * | |
2182 @item C-c * | |
2183 Recalculate the current row by first applying the stored column formulas | |
2184 from left to right, and all field formulas in the current row. | |
2185 @c | |
2186 @kindex C-u C-c * | |
2187 @item C-u C-c * | |
2188 @kindex C-u C-c C-c | |
2189 @itemx C-u C-c C-c | |
2190 Recompute the entire table, line by line. Any lines before the first | |
2191 hline are left alone, assuming that these are part of the table header. | |
2192 @c | |
2193 @kindex C-u C-u C-c * | |
2194 @kindex C-u C-u C-c C-c | |
2195 @item C-u C-u C-c * | |
2196 @itemx C-u C-u C-c C-c | |
2197 Iterate the table by recomputing it until no further changes occur. | |
2198 This may be necessary if some computed fields use the value of other | |
2199 fields that are computed @i{later} in the calculation sequence. | |
2200 @end table | |
2201 | |
2202 @node Advanced features, , Updating the table, The spreadsheet | |
2203 @subsection Advanced features | |
2204 | |
2205 If you want the recalculation of fields to happen automatically, or if | |
2206 you want to be able to assign @i{names} to fields and columns, you need | |
2207 to reserve the first column of the table for special marking characters. | |
2208 @table @kbd | |
2209 @kindex C-# | |
2210 @item C-# | |
2211 Rotate the calculation mark in first column through the states @samp{}, | |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2212 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region, |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2213 change all marks in the region. |
84308 | 2214 @end table |
2215 | |
2216 Here is an example of a table that collects exam results of students and | |
2217 makes use of these features: | |
2218 | |
2219 @example | |
2220 @group | |
2221 |---+---------+--------+--------+--------+-------+------| | |
2222 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note | | |
2223 |---+---------+--------+--------+--------+-------+------| | |
2224 | ! | | P1 | P2 | P3 | Tot | | | |
2225 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 | | |
2226 | ^ | | m1 | m2 | m3 | mt | | | |
2227 |---+---------+--------+--------+--------+-------+------| | |
2228 | # | Peter | 10 | 8 | 23 | 41 | 8.2 | | |
2229 | # | Sam | 2 | 4 | 3 | 9 | 1.8 | | |
2230 |---+---------+--------+--------+--------+-------+------| | |
2231 | | Average | | | | 29.7 | | | |
2232 | ^ | | | | | at | | | |
2233 | $ | max=50 | | | | | | | |
2234 |---+---------+--------+--------+--------+-------+------| | |
2235 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f | |
2236 @end group | |
2237 @end example | |
2238 | |
2239 @noindent @b{Important}: Please note that for these special tables, | |
2240 recalculating the table with @kbd{C-u C-c *} will only affect rows that | |
2241 are marked @samp{#} or @samp{*}, and fields that have a formula assigned | |
2242 to the field itself. The column formulas are not applied in rows with | |
2243 empty first field. | |
2244 | |
2245 @cindex marking characters, tables | |
2246 The marking characters have the following meaning: | |
2247 @table @samp | |
2248 @item ! | |
2249 The fields in this line define names for the columns, so that you may | |
2250 refer to a column as @samp{$Tot} instead of @samp{$6}. | |
2251 @item ^ | |
2252 This row defines names for the fields @emph{above} the row. With such | |
2253 a definition, any formula in the table may use @samp{$m1} to refer to | |
2254 the value @samp{10}. Also, if you assign a formula to a names field, it | |
2255 will be stored as @samp{$name=...}. | |
2256 @item _ | |
2257 Similar to @samp{^}, but defines names for the fields in the row | |
2258 @emph{below}. | |
2259 @item $ | |
2260 Fields in this row can define @emph{parameters} for formulas. For | |
2261 example, if a field in a @samp{$} row contains @samp{max=50}, then | |
2262 formulas in this table can refer to the value 50 using @samp{$max}. | |
2263 Parameters work exactly like constants, only that they can be defined on | |
2264 a per-table basis. | |
2265 @item # | |
2266 Fields in this row are automatically recalculated when pressing | |
2267 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row | |
2268 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked | |
2269 lines will be left alone by this command. | |
2270 @item * | |
2271 Selects this line for global recalculation with @kbd{C-u C-c *}, but | |
2272 not for automatic recalculation. Use this when automatic | |
2273 recalculation slows down editing too much. | |
2274 @item | |
2275 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}. | |
2276 All lines that should be recalculated should be marked with @samp{#} | |
2277 or @samp{*}. | |
2278 @item / | |
2279 Do not export this line. Useful for lines that contain the narrowing | |
2280 @samp{<N>} markers. | |
2281 @end table | |
2282 | |
2283 Finally, just to whet your appetite on what can be done with the | |
2284 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
|
2285 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
|
2286 functions. |
84308 | 2287 |
2288 @example | |
2289 @group | |
2290 |---+-------------+---+-----+--------------------------------------| | |
2291 | | Func | n | x | Result | | |
2292 |---+-------------+---+-----+--------------------------------------| | |
2293 | # | exp(x) | 1 | x | 1 + x | | |
2294 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 | | |
2295 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 | | |
2296 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 | | |
2297 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 | | |
2298 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 | | |
2299 |---+-------------+---+-----+--------------------------------------| | |
2300 #+TBLFM: $5=taylor($2,$4,$3);n3 | |
2301 @end group | |
2302 @end example | |
2303 | |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2304 @page |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2305 @node Org Plot, , The spreadsheet, Tables |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2306 @section Org Plot |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2307 @cindex graph, in tables |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2308 @cindex plot tables using gnuplot |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2309 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2310 Org Plot can produce 2D and 3D graphs of information stored in org tables |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
2311 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode} |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
2312 @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}. To see |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
2313 this in action ensure that you have both Gnuplot and Gnuplot-mode installed |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
2314 on your system, then call @code{org-plot/gnuplot} on the following table. |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2315 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2316 @example |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2317 @group |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2318 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]" |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2319 | Sede | Max cites | H-index | |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2320 |-----------+-----------+---------| |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2321 | Chile | 257.72 | 21.39 | |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2322 | Leeds | 165.77 | 19.68 | |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2323 | Sao Paolo | 71.00 | 11.50 | |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2324 | Stockholm | 134.19 | 14.33 | |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2325 | Morelia | 257.56 | 17.67 | |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2326 @end group |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2327 @end example |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2328 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2329 Notice that Org Plot is smart enough to apply the tables headers as labels. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2330 Further control over the labels, type, content, and appearance of plots can |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2331 be exercised through the @code{#+Plot:} lines preceding a table. See below |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2332 for a complete list of Org plot options. For more information and examples |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
2333 see the org-plot tutorial at |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
2334 @uref{http://legito.org/worg/org-tutorials/org-plot.php}. |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2335 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2336 @subsubheading Plot Options |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2337 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2338 @table @code |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2339 @item set |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2340 Specify any @file{gnuplot} option to be set when graphing. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2341 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2342 @item title |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2343 Specify the title of the plot. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2344 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2345 @item ind |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2346 Specify which column of the table to use as the @code{x} axis. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2347 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2348 @item deps |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
2349 Specify the columns to graph as a lisp style list, surrounded by parenthesis |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
2350 and separated by spaces for example @code{dep:(3 4)} to graph the third and |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
2351 fourth columns (defaults to graphing all other columns aside from the ind |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
2352 column). |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2353 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2354 @item type |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2355 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2356 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2357 @item with |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2358 Specify a @code{with} option to be inserted for every col being plotted |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2359 (e.g. @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...). |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2360 Defaults to 'lines'. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2361 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2362 @item file |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2363 If you want to plot to a file specify the @code{"path/to/desired/output-file"}. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2364 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2365 @item labels |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2366 List of labels to be used for the deps (defaults to column headers if they |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2367 exist). |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2368 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2369 @item line |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2370 Specify an entire line to be inserted in the gnuplot script. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2371 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2372 @item map |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2373 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2374 flat mapping rather than a @code{3d} slope. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2375 |
99503
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
2376 @item timefmt |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
2377 Specify format of org-mode timestamps as they will be parsed by gnuplot. |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
2378 Defaults to '%Y-%m-%d-%H:%M:%S'. |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
2379 |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2380 @item script |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2381 If you want total control you can specify a script file (place the file name |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2382 between double quotes) which will be used to plot. Before plotting, every |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2383 instance of @code{$datafile} in the specified script will be replaced with |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2384 the path to the generated data file. Note even if you set this option you |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2385 may still want to specify the plot type, as that can impact the content of |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2386 the data file. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2387 @end table |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2388 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2389 @node Hyperlinks, TODO Items, Tables, Top |
84308 | 2390 @chapter Hyperlinks |
2391 @cindex hyperlinks | |
2392 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2393 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
|
2394 other files, Usenet articles, emails, and much more. |
84308 | 2395 |
2396 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2397 * Link format:: How links in Org are formatted |
84308 | 2398 * Internal links:: Links to other places in the current file |
2399 * External links:: URL-like links to the world | |
2400 * 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
|
2401 * Using links outside Org:: Linking from my C source code? |
84308 | 2402 * Link abbreviations:: Shortcuts for writing complex links |
2403 * Search options:: Linking to a specific location | |
2404 * Custom searches:: When the default search is not enough | |
2405 @end menu | |
2406 | |
2407 @node Link format, Internal links, Hyperlinks, Hyperlinks | |
2408 @section Link format | |
2409 @cindex link format | |
2410 @cindex format, of links | |
2411 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2412 Org will recognize plain URL-like links and activate them as |
84308 | 2413 clickable links. The general link format, however, looks like this: |
2414 | |
2415 @example | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2416 [[link][description]] @r{or alternatively} [[link]] |
84308 | 2417 @end example |
2418 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2419 Once a link in the buffer is complete (all brackets present), Org |
84308 | 2420 will change the display so that @samp{description} is displayed instead |
2421 of @samp{[[link][description]]} and @samp{link} is displayed instead of | |
2422 @samp{[[link]]}. Links will be highlighted in the face @code{org-link}, | |
2423 which by default is an underlined face. You can directly edit the | |
2424 visible part of a link. Note that this can be either the @samp{link} | |
2425 part (if there is no description) or the @samp{description} part. To | |
2426 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the | |
2427 cursor on the link. | |
2428 | |
2429 If you place the cursor at the beginning or just behind the end of the | |
2430 displayed text and press @key{BACKSPACE}, you will remove the | |
2431 (invisible) bracket at that location. This makes the link incomplete | |
2432 and the internals are again displayed as plain text. Inserting the | |
2433 missing bracket hides the link internals again. To show the | |
2434 internal structure of all links, use the menu entry | |
2435 @code{Org->Hyperlinks->Literal links}. | |
2436 | |
2437 @node Internal links, External links, Link format, Hyperlinks | |
2438 @section Internal links | |
2439 @cindex internal links | |
2440 @cindex links, internal | |
2441 @cindex targets, for links | |
2442 | |
2443 If the link does not look like a URL, it is considered to be internal in | |
2444 the current file. Links such as @samp{[[My Target]]} or @samp{[[My | |
2445 Target][Find my target]]} lead to a text search in the current file. | |
2446 The link can be followed with @kbd{C-c C-o} when the cursor is on the | |
2447 link, or with a mouse click (@pxref{Handling links}). The preferred | |
2448 match for such a link is a dedicated target: the same string in double | |
2449 angular brackets. Targets may be located anywhere; sometimes it is | |
2450 convenient to put them into a comment line. For example | |
2451 | |
2452 @example | |
2453 # <<My Target>> | |
2454 @end example | |
2455 | |
2456 @noindent In HTML export (@pxref{HTML export}), such targets will become | |
99851
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
2457 named anchors for direct access through @samp{http} links@footnote{Note that |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
2458 text before the first headline is usually not exported, so the first such |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
2459 target should be after the first headline, or in the line directly before the |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
2460 first headline.}. |
84308 | 2461 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2462 If no dedicated target exists, Org will search for the words in the |
84308 | 2463 link. In the above example the search would be for @samp{my target}. |
2464 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
|
2465 headlines. When searching, Org mode will first try an exact match, but |
84308 | 2466 then move on to more and more lenient searches. For example, the link |
2467 @samp{[[*My Targets]]} will find any of the following: | |
2468 | |
2469 @example | |
2470 ** My targets | |
2471 ** TODO my targets are bright | |
2472 ** my 20 targets are | |
2473 @end example | |
2474 | |
2475 To insert a link targeting a headline, in-buffer completion can be used. | |
2476 Just type a star followed by a few optional letters into the buffer and | |
2477 press @kbd{M-@key{TAB}}. All headlines in the current buffer will be | |
2478 offered as completions. @xref{Handling links}, for more commands | |
2479 creating links. | |
2480 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2481 Following a link pushes a mark onto Org's own mark ring. You can |
84308 | 2482 return to the previous position with @kbd{C-c &}. Using this command |
2483 several times in direct succession goes back to positions recorded | |
2484 earlier. | |
2485 | |
2486 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2487 * Radio targets:: Make targets trigger links in plain text |
84308 | 2488 @end menu |
2489 | |
2490 @node Radio targets, , Internal links, Internal links | |
2491 @subsection Radio targets | |
2492 @cindex radio targets | |
2493 @cindex targets, radio | |
2494 @cindex links, radio targets | |
2495 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2496 Org can automatically turn any occurrences of certain target names |
84308 | 2497 in normal text into a link. So without explicitly creating a link, the |
2498 text connects to the target radioing its position. Radio targets are | |
2499 enclosed by triple angular brackets. For example, a target @samp{<<<My | |
2500 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
|
2501 become activated as a link. The Org file is scanned automatically |
84308 | 2502 for radio targets only when the file is first loaded into Emacs. To |
2503 update the target list during editing, press @kbd{C-c C-c} with the | |
2504 cursor on or at a target. | |
2505 | |
2506 @node External links, Handling links, Internal links, Hyperlinks | |
2507 @section External links | |
2508 @cindex links, external | |
2509 @cindex external links | |
2510 @cindex links, external | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2511 @cindex Gnus links |
84308 | 2512 @cindex BBDB links |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2513 @cindex IRC links |
84308 | 2514 @cindex URL links |
2515 @cindex file links | |
2516 @cindex VM links | |
2517 @cindex RMAIL links | |
2518 @cindex WANDERLUST links | |
2519 @cindex MH-E links | |
2520 @cindex USENET links | |
2521 @cindex SHELL links | |
2522 @cindex Info links | |
2523 @cindex elisp links | |
2524 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2525 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
|
2526 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
|
2527 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
|
2528 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
|
2529 the colon. The following list shows examples for each link type. |
84308 | 2530 |
2531 @example | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2532 http://www.astro.uva.nl/~dominik @r{on the web} |
84308 | 2533 file:/home/dominik/images/jupiter.jpg @r{file, absolute path} |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
2534 /home/dominik/images/jupiter.jpg @r{same as above} |
84308 | 2535 file:papers/last.pdf @r{file, relative path} |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
2536 ./papers/last.pdf @r{same as above} |
84308 | 2537 news:comp.emacs @r{Usenet link} |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
2538 mailto:adent@@galaxy.net @r{Mail link} |
84308 | 2539 vm:folder @r{VM folder link} |
2540 vm:folder#id @r{VM message link} | |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
2541 vm://myself@@some.where.org/folder#id @r{VM on remote machine} |
84308 | 2542 wl:folder @r{WANDERLUST folder link} |
2543 wl:folder#id @r{WANDERLUST message link} | |
2544 mhe:folder @r{MH-E folder link} | |
2545 mhe:folder#id @r{MH-E message link} | |
2546 rmail:folder @r{RMAIL folder link} | |
2547 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
|
2548 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
|
2549 gnus:group#id @r{Gnus article link} |
99851
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
2550 bbdb:R.*Stallman @r{BBDB link (with regexp)} |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2551 irc:/irc.com/#emacs/bob @r{IRC link} |
84308 | 2552 shell:ls *.org @r{A shell command} |
99851
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
2553 elisp:org-agenda @r{Interactive elisp command} |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
2554 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate} |
84308 | 2555 @end example |
2556 | |
2557 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
|
2558 descriptive text to be displayed instead of the URL (@pxref{Link |
84308 | 2559 format}), for example: |
2560 | |
2561 @example | |
2562 [[http://www.gnu.org/software/emacs/][GNU Emacs]] | |
2563 @end example | |
2564 | |
2565 @noindent | |
2566 If the description is a file name or URL that points to an image, HTML | |
2567 export (@pxref{HTML export}) will inline the image as a clickable | |
2568 button. If there is no description at all and the link points to an | |
2569 image, | |
2570 that image will be inlined into the exported HTML file. | |
2571 | |
2572 @cindex angular brackets, around links | |
2573 @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
|
2574 Org also finds external links in the normal text and activates them |
84308 | 2575 as links. If spaces must be part of the link (for example in |
2576 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities | |
2577 about the end of the link, enclose them in angular brackets. | |
2578 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2579 @node Handling links, Using links outside Org, External links, Hyperlinks |
84308 | 2580 @section Handling links |
2581 @cindex links, handling | |
2582 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2583 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
|
2584 insert it into an Org file, and to follow the link. |
84308 | 2585 |
2586 @table @kbd | |
2587 @kindex C-c l | |
2588 @cindex storing links | |
2589 @item C-c l | |
100450
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
2590 Store a link to the current location. This is a @emph{global} command which |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
2591 can be used in any buffer to create a link. The link will be stored for |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
2592 later insertion into an Org buffer (see below). For Org files, if there is a |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
2593 @samp{<<target>>} at the cursor, the link points to the target. Otherwise it |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
2594 points to the current headline, either by text, or, if @file{org-id.el} is |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
2595 loaded, by ID property. For VM, Rmail, Wanderlust, MH-E, Gnus and BBDB |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
2596 buffers, the link will indicate the current article/entry. For W3 and W3M |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
2597 buffers, the link goes to the current URL. For IRC links, if you set the |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
2598 variable @code{org-irc-link-to-logs} to non-nil then @kbd{C-c l} will store a |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
2599 @samp{file:/} style link to the relevant point in the logs for the current |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
2600 conversation. Otherwise an @samp{irc:/} style link to the user/channel/server |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
2601 under the point will be stored. For any other files, the link will point to |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
2602 the file, with a search string (@pxref{Search options}) pointing to the |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
2603 contents of the current line. If there is an active region, the selected |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
2604 words will form the basis of the search string. If the automatically created |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
2605 link is not working correctly or accurately enough, you can write custom |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
2606 functions to select the search string and to do the search for particular |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
2607 file types - see @ref{Custom searches}. The key binding @kbd{C-c l} is only |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
2608 a suggestion - see @ref{Installation}. |
84308 | 2609 @c |
2610 @kindex C-c C-l | |
2611 @cindex link completion | |
2612 @cindex completion, of links | |
2613 @cindex inserting links | |
2614 @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
|
2615 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
|
2616 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
|
2617 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
|
2618 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
|
2619 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
|
2620 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
|
2621 @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
|
2622 (@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
|
2623 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
|
2624 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
|
2625 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
|
2626 @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
|
2627 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
|
2628 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
|
2629 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
|
2630 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
|
2631 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
|
2632 optional descriptive text. |
84308 | 2633 @c |
2634 @c If the link is a @samp{file:} link and | |
2635 @c the linked file is located in the same directory as the current file or | |
2636 @c a subdirectory of it, the path of the file will be inserted relative to | |
2637 @c the current directory. | |
2638 @c | |
2639 @kindex C-u C-c C-l | |
2640 @cindex file name completion | |
2641 @cindex completion, of file names | |
2642 @item C-u C-c C-l | |
2643 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to | |
2644 a file will be inserted and you may use file name completion to select | |
2645 the name of the file. The path to the file is inserted relative to the | |
2646 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
|
2647 directory or in a sub-directory of it, or if the path is written relative |
84308 | 2648 to the current directory using @samp{../}. Otherwise an absolute path |
2649 is used, if possible with @samp{~/} for your home directory. You can | |
2650 force an absolute path with two @kbd{C-u} prefixes. | |
2651 @c | |
2652 @item C-c C-l @r{(with cursor on existing link)} | |
2653 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the | |
2654 link and description parts of the link. | |
2655 @c | |
2656 @cindex following links | |
2657 @kindex C-c C-o | |
2658 @item C-c C-o | |
2659 Open link at point. This will launch a web browser for URLs (using | |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2660 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2661 the corresponding links, and execute the command in a shell link. When the |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2662 cursor is on an internal link, this commands runs the corresponding search. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2663 When the cursor is on a TAG list in a headline, it creates the corresponding |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2664 TAGS view. If the cursor is on a time stamp, it compiles the agenda for that |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2665 date. Furthermore, it will visit text and remote files in @samp{file:} links |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2666 with Emacs and select a suitable application for local non-text files. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2667 Classification of files is based on file extension only. See option |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
2668 @code{org-file-apps}. If you want to override the default application and |
99503
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
2669 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
2670 opening in Emacs, use a @kbd{C-u C-u} prefix. |
84308 | 2671 @c |
2672 @kindex mouse-2 | |
2673 @kindex mouse-1 | |
2674 @item mouse-2 | |
2675 @itemx mouse-1 | |
2676 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o} | |
2677 would. Under Emacs 22, also @kbd{mouse-1} will follow a link. | |
2678 @c | |
2679 @kindex mouse-3 | |
2680 @item mouse-3 | |
2681 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and | |
2682 internal links to be displayed in another window@footnote{See the | |
2683 variable @code{org-display-internal-link-with-indirect-buffer}}. | |
2684 @c | |
2685 @cindex mark ring | |
2686 @kindex C-c % | |
2687 @item C-c % | |
2688 Push the current position onto the mark ring, to be able to return | |
2689 easily. Commands following an internal link do this automatically. | |
2690 @c | |
2691 @cindex links, returning to | |
2692 @kindex C-c & | |
2693 @item C-c & | |
2694 Jump back to a recorded position. A position is recorded by the | |
2695 commands following internal links, and by @kbd{C-c %}. Using this | |
2696 command several times in direct succession moves through a ring of | |
2697 previously recorded positions. | |
2698 @c | |
2699 @kindex C-c C-x C-n | |
2700 @kindex C-c C-x C-p | |
2701 @cindex links, finding next/previous | |
2702 @item C-c C-x C-n | |
2703 @itemx C-c C-x C-p | |
2704 Move forward/backward to the next link in the buffer. At the limit of | |
2705 the buffer, the search fails once, and then wraps around. The key | |
2706 bindings for this are really too long, you might want to bind this also | |
2707 to @kbd{C-n} and @kbd{C-p} | |
2708 @lisp | |
2709 (add-hook 'org-load-hook | |
2710 (lambda () | |
2711 (define-key 'org-mode-map "\C-n" 'org-next-link) | |
2712 (define-key 'org-mode-map "\C-p" 'org-previous-link))) | |
2713 @end lisp | |
2714 @end table | |
2715 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2716 @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
|
2717 @section Using links outside Org |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2718 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2719 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
|
2720 Org, but in any Emacs buffer. For this, you should create two |
84308 | 2721 global commands, like this (please select suitable global keys |
2722 yourself): | |
2723 | |
2724 @lisp | |
2725 (global-set-key "\C-c L" 'org-insert-link-global) | |
2726 (global-set-key "\C-c o" 'org-open-at-point-global) | |
2727 @end lisp | |
2728 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2729 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks |
84308 | 2730 @section Link abbreviations |
2731 @cindex link abbreviations | |
2732 @cindex abbreviation, links | |
2733 | |
2734 Long URLs can be cumbersome to type, and often many similar links are | |
2735 needed in a document. For this you can use link abbreviations. An | |
2736 abbreviated link looks like this | |
2737 | |
2738 @example | |
2739 [[linkword:tag][description]] | |
2740 @end example | |
2741 | |
2742 @noindent | |
2743 where the tag is optional. Such abbreviations are resolved according to | |
2744 the information in the variable @code{org-link-abbrev-alist} that | |
2745 relates the linkwords to replacement text. Here is an example: | |
2746 | |
2747 @lisp | |
2748 @group | |
2749 (setq org-link-abbrev-alist | |
2750 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=") | |
2751 ("google" . "http://www.google.com/search?q=") | |
2752 ("ads" . "http://adsabs.harvard.edu/cgi-bin/ | |
2753 nph-abs_connect?author=%s&db_key=AST"))) | |
2754 @end group | |
2755 @end lisp | |
2756 | |
2757 If the replacement text contains the string @samp{%s}, it will be | |
2758 replaced with the tag. Otherwise the tag will be appended to the string | |
2759 in order to create the link. You may also specify a function that will | |
2760 be called with the tag as the only argument to create the link. | |
2761 | |
2762 With the above setting, you could link to a specific bug with | |
2763 @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
|
2764 @code{[[google:OrgMode]]} and find out what the Org author is |
84308 | 2765 doing besides Emacs hacking with @code{[[ads:Dominik,C]]}. |
2766 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2767 If you need special abbreviations just for a single Org buffer, you |
84308 | 2768 can define them in the file with |
2769 | |
2770 @example | |
2771 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id= | |
2772 #+LINK: google http://www.google.com/search?q=%s | |
2773 @end example | |
2774 | |
2775 @noindent | |
2776 In-buffer completion @pxref{Completion} can be used after @samp{[} to | |
2777 complete link abbreviations. | |
2778 | |
2779 @node Search options, Custom searches, Link abbreviations, Hyperlinks | |
2780 @section Search options in file links | |
2781 @cindex search option in file links | |
2782 @cindex file links, searching | |
2783 | |
2784 File links can contain additional information to make Emacs jump to a | |
2785 particular location in the file when following a link. This can be a | |
2786 line number or a search option after a double@footnote{For backward | |
2787 compatibility, line numbers can also follow a single colon.} colon. For | |
2788 example, when the command @kbd{C-c l} creates a link (@pxref{Handling | |
2789 links}) to a file, it encodes the words in the current line as a search | |
2790 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
|
2791 link with @kbd{C-c C-o}. |
84308 | 2792 |
2793 Here is the syntax of the different ways to attach a search to a file | |
2794 link, together with an explanation: | |
2795 | |
2796 @example | |
2797 [[file:~/code/main.c::255]] | |
2798 [[file:~/xx.org::My Target]] | |
2799 [[file:~/xx.org::*My Target]] | |
2800 [[file:~/xx.org::/regexp/]] | |
2801 @end example | |
2802 | |
2803 @table @code | |
2804 @item 255 | |
2805 Jump to line 255. | |
2806 @item My Target | |
2807 Search for a link target @samp{<<My Target>>}, or do a text search for | |
2808 @samp{my target}, similar to the search in internal links, see | |
2809 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file | |
2810 link will become an HTML reference to the corresponding named anchor in | |
2811 the linked file. | |
2812 @item *My Target | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2813 In an Org file, restrict search to headlines. |
84308 | 2814 @item /regexp/ |
2815 Do a regular expression search for @code{regexp}. This uses the Emacs | |
2816 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
|
2817 target file is in Org mode, @code{org-occur} is used to create a |
84308 | 2818 sparse tree with the matches. |
2819 @c If the target file is a directory, | |
2820 @c @code{grep} will be used to search all files in the directory. | |
2821 @end table | |
2822 | |
2823 As a degenerate case, a file link with an empty file name can be used | |
2824 to search the current file. For example, @code{[[file:::find me]]} does | |
2825 a search for @samp{find me} in the current file, just as | |
2826 @samp{[[find me]]} would. | |
2827 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2828 @node Custom searches, , Search options, Hyperlinks |
84308 | 2829 @section Custom Searches |
2830 @cindex custom search strings | |
2831 @cindex search strings, custom | |
2832 | |
2833 The default mechanism for creating search strings and for doing the | |
2834 actual search related to a file link may not work correctly in all | |
2835 cases. For example, BibTeX database files have many entries like | |
2836 @samp{year="1993"} which would not result in good search strings, | |
2837 because the only unique identification for a BibTeX entry is the | |
2838 citation key. | |
2839 | |
2840 If you come across such a problem, you can write custom functions to set | |
2841 the right search string for a particular file type, and to do the search | |
2842 for the string in the file. Using @code{add-hook}, these functions need | |
2843 to be added to the hook variables | |
2844 @code{org-create-file-search-functions} and | |
2845 @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
|
2846 variables for more information. Org actually uses this mechanism |
84308 | 2847 for Bib@TeX{} database files, and you can use the corresponding code as |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
2848 an implementation example. See the file @file{org-bibtex.el}. |
84308 | 2849 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2850 @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
|
2851 @chapter TODO Items |
84308 | 2852 @cindex TODO items |
2853 | |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
2854 Org mode does not maintain TODO lists as separate documents@footnote{Of |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
2855 course, you can make a document that contains inly long lists of TODO items, |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
2856 but this is not required.}. Instead, TODO items are an integral part of the |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
2857 notes file, because TODO items usually come up while taking notes! With Org |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
2858 mode, simply mark any entry in a tree as being a TODO item. In this way, |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
2859 information is not duplicated, and the entire context from which the TODO |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
2860 item emerged is always present. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2861 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2862 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
|
2863 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
|
2864 methods to give you an overview of all the things that you have to do. |
84308 | 2865 |
2866 @menu | |
2867 * TODO basics:: Marking and displaying TODO entries | |
2868 * TODO extensions:: Workflow and assignments | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2869 * Progress logging:: Dates and notes for progress |
84308 | 2870 * Priorities:: Some things are more important than others |
2871 * Breaking down tasks:: Splitting a task into manageable pieces | |
2872 * Checkboxes:: Tick-off lists | |
2873 @end menu | |
2874 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2875 @node TODO basics, TODO extensions, TODO Items, TODO Items |
84308 | 2876 @section Basic TODO functionality |
2877 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2878 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
|
2879 @samp{TODO}, for example: |
84308 | 2880 |
2881 @example | |
2882 *** TODO Write letter to Sam Fortune | |
2883 @end example | |
2884 | |
2885 @noindent | |
2886 The most important commands to work with TODO entries are: | |
2887 | |
2888 @table @kbd | |
2889 @kindex C-c C-t | |
2890 @cindex cycling, of TODO states | |
2891 @item C-c C-t | |
2892 Rotate the TODO state of the current item among | |
2893 | |
2894 @example | |
2895 ,-> (unmarked) -> TODO -> DONE --. | |
2896 '--------------------------------' | |
2897 @end example | |
2898 | |
2899 The same rotation can also be done ``remotely'' from the timeline and | |
2900 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
|
2901 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2902 @kindex C-u C-c C-t |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2903 @item C-u C-c C-t |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2904 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
|
2905 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
|
2906 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
|
2907 more information. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2908 |
84308 | 2909 @kindex S-@key{right} |
2910 @kindex S-@key{left} | |
2911 @item S-@key{right} | |
2912 @itemx S-@key{left} | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2913 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
|
2914 mostly if more than two TODO states are possible (@pxref{TODO |
84308 | 2915 extensions}). |
2916 @kindex C-c C-v | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2917 @kindex C-c / t |
84308 | 2918 @cindex sparse tree, for TODO |
2919 @item C-c C-v | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2920 @itemx C-c / t |
84308 | 2921 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds |
2922 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
|
2923 above them. With a prefix argument, search for a specific TODO. You will be |
84308 | 2924 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
|
2925 @code{KWD1|KWD2|...}. With numeric prefix argument N, show the tree for the |
84308 | 2926 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
|
2927 arguments, find all TODO and DONE entries. |
84308 | 2928 @kindex C-c a t |
2929 @item C-c a t | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2930 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
|
2931 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
|
2932 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
|
2933 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
|
2934 commands}). @xref{Global TODO list}, for more information. |
84308 | 2935 @kindex S-M-@key{RET} |
2936 @item S-M-@key{RET} | |
2937 Insert a new TODO entry below the current one. | |
2938 @end table | |
2939 | |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
2940 @noindent |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
2941 Changing a TODO state can also trigger tag changes. See the docstring of the |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
2942 option @code{org-todo-state-tags-triggers} for details. |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
2943 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2944 @node TODO extensions, Progress logging, TODO basics, TODO Items |
84308 | 2945 @section Extended use of TODO keywords |
2946 @cindex extended TODO keywords | |
2947 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2948 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
|
2949 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
|
2950 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
|
2951 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
|
2952 files. |
84308 | 2953 |
2954 Note that @i{tags} are another way to classify headlines in general and | |
2955 TODO items in particular (@pxref{Tags}). | |
2956 | |
2957 @menu | |
2958 * Workflow states:: From TODO to DONE in steps | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2959 * TODO types:: I do this, Fred does the rest |
84308 | 2960 * 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
|
2961 * 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
|
2962 * Per-file keywords:: Different files, different requirements |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2963 * Faces for TODO keywords:: Highlighting states |
84308 | 2964 @end menu |
2965 | |
2966 @node Workflow states, TODO types, TODO extensions, TODO extensions | |
2967 @subsection TODO keywords as workflow states | |
2968 @cindex TODO workflow | |
2969 @cindex workflow states as TODO keywords | |
2970 | |
2971 You can use TODO keywords to indicate different @emph{sequential} states | |
2972 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
|
2973 this variable only becomes effective after restarting Org mode in a |
84308 | 2974 buffer.}: |
2975 | |
2976 @lisp | |
2977 (setq org-todo-keywords | |
2978 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED"))) | |
2979 @end lisp | |
2980 | |
2981 The vertical bar separates the TODO keywords (states that @emph{need | |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
2982 action}) from the DONE states (which need @emph{no further action}). If |
84308 | 2983 you don't provide the separator bar, the last state is used as the DONE |
2984 state. | |
2985 @cindex completion, of TODO keywords | |
2986 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO | |
2987 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
|
2988 also use a numeric prefix argument to quickly select a specific state. For |
84308 | 2989 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
|
2990 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
|
2991 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
|
2992 (@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
|
2993 (@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
|
2994 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
|
2995 @ref{Tracking TODO state changes} for more information. |
84308 | 2996 |
2997 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions | |
2998 @subsection TODO keywords as types | |
2999 @cindex TODO types | |
3000 @cindex names as TODO keywords | |
3001 @cindex types as TODO keywords | |
3002 | |
3003 The second possibility is to use TODO keywords to indicate different | |
3004 @emph{types} of action items. For example, you might want to indicate | |
3005 that items are for ``work'' or ``home''. Or, when you work with several | |
3006 people on a single project, you might want to assign action items | |
3007 directly to persons, by using their names as TODO keywords. This would | |
3008 be set up like this: | |
3009 | |
3010 @lisp | |
3011 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE"))) | |
3012 @end lisp | |
3013 | |
3014 In this case, different keywords do not indicate a sequence, but rather | |
3015 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
|
3016 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
|
3017 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
|
3018 @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
|
3019 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
|
3020 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
|
3021 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
|
3022 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
|
3023 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
|
3024 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
|
3025 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
|
3026 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
|
3027 argument as well when creating the global TODO list: @kbd{C-3 C-c t}. |
84308 | 3028 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3029 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions |
84308 | 3030 @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
|
3031 @cindex TODO keyword sets |
84308 | 3032 |
3033 Sometimes you may want to use different sets of TODO keywords in | |
3034 parallel. For example, you may want to have the basic | |
3035 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a | |
3036 separate state indicating that an item has been canceled (so it is not | |
3037 DONE, but also does not require action). Your setup would then look | |
3038 like this: | |
3039 | |
3040 @lisp | |
3041 (setq org-todo-keywords | |
3042 '((sequence "TODO" "|" "DONE") | |
3043 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED") | |
3044 (sequence "|" "CANCELED"))) | |
3045 @end lisp | |
3046 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3047 The keywords should all be different, this helps Org mode to keep track |
84308 | 3048 of which subsequence should be used for a given entry. In this setup, |
3049 @kbd{C-c C-t} only operates within a subsequence, so it switches from | |
3050 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to | |
3051 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially | |
3052 select the correct sequence. Besides the obvious ways like typing a | |
3053 keyword or using completion, you may also apply the following commands: | |
3054 | |
3055 @table @kbd | |
3056 @kindex C-S-@key{right} | |
3057 @kindex C-S-@key{left} | |
3058 @item C-S-@key{right} | |
3059 @itemx C-S-@key{left} | |
3060 These keys jump from one TODO subset to the next. In the above example, | |
3061 @kbd{C-S-@key{right}} would jump from @code{TODO} or @code{DONE} to | |
3062 @code{REPORT}, and any of the words in the second row to @code{CANCELED}. | |
3063 @kindex S-@key{right} | |
3064 @kindex S-@key{left} | |
3065 @item S-@key{right} | |
3066 @itemx S-@key{left} | |
3067 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through | |
3068 @emph{all} keywords from all sets, so for example @kbd{S-@key{<right>}} | |
3069 would switch from @code{DONE} to @code{REPORT} in the example above. | |
3070 @end table | |
3071 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3072 @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
|
3073 @subsection Fast access to TODO states |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3074 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3075 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
|
3076 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
|
3077 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
|
3078 key after each keyword, in parenthesis. For example: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3079 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3080 @lisp |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3081 (setq org-todo-keywords |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3082 '((sequence "TODO(t)" "|" "DONE(d)") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3083 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3084 (sequence "|" "CANCELED(c)"))) |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3085 @end lisp |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3086 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3087 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
|
3088 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
|
3089 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
|
3090 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
|
3091 @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
|
3092 the default. Check also the variable |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3093 @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
|
3094 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
|
3095 like to mingle the two concepts. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3096 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3097 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions |
84308 | 3098 @subsection Setting up keywords for individual files |
3099 @cindex keyword options | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3100 @cindex per-file keywords |
84308 | 3101 |
3102 It can be very useful to use different aspects of the TODO mechanism in | |
3103 different files. For file-local settings, you need to add special lines | |
3104 to the file which set the keywords and interpretation for that file | |
3105 only. For example, to set one of the two examples discussed above, you | |
3106 need one of the following lines, starting in column zero anywhere in the | |
3107 file: | |
3108 | |
3109 @example | |
3110 #+SEQ_TODO: TODO FEEDBACK VERIFY | DONE CANCELED | |
3111 @end example | |
3112 or | |
3113 @example | |
3114 #+TYP_TODO: Fred Sara Lucy Mike | DONE | |
3115 @end example | |
3116 | |
3117 A setup for using several sets in parallel would be: | |
3118 | |
3119 @example | |
3120 #+SEQ_TODO: TODO | DONE | |
3121 #+SEQ_TODO: REPORT BUG KNOWNCAUSE | FIXED | |
3122 #+SEQ_TODO: | CANCELED | |
3123 @end example | |
3124 | |
3125 @cindex completion, of option keywords | |
3126 @kindex M-@key{TAB} | |
3127 @noindent To make sure you are using the correct keyword, type | |
3128 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion. | |
3129 | |
3130 @cindex DONE, final TODO keyword | |
3131 Remember that the keywords after the vertical bar (or the last keyword | |
3132 if no bar is there) must always mean that the item is DONE (although you | |
3133 may use a different word). After changing one of these lines, use | |
3134 @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
|
3135 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
|
3136 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
|
3137 cursor in a line starting with @samp{#+} is simply restarting Org mode |
84308 | 3138 for the current buffer.}. |
3139 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3140 @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
|
3141 @subsection Faces for TODO keywords |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3142 @cindex faces, for TODO keywords |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3143 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3144 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
|
3145 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
|
3146 @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
|
3147 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
|
3148 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
|
3149 @code{org-todo-keyword-faces}. For example: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3150 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3151 @lisp |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3152 @group |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3153 (setq org-todo-keyword-faces |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3154 '(("TODO" . org-warning) |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3155 ("DEFERRED" . shadow) |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3156 ("CANCELED" . (:foreground "blue" :weight bold)))) |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3157 @end group |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3158 @end lisp |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3159 |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3160 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
|
3161 @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
|
3162 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
|
3163 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3164 @page |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3165 @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
|
3166 @section Progress logging |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3167 @cindex progress logging |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3168 @cindex logging, of progress |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3169 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3170 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
|
3171 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
|
3172 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
|
3173 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
|
3174 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
|
3175 work time}. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3176 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3177 @menu |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3178 * Closing items:: When was this entry marked DONE? |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3179 * Tracking TODO state changes:: When did the status change? |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3180 @end menu |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3181 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3182 @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
|
3183 @subsection Closing items |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3184 |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3185 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
|
3186 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
|
3187 in-buffer setting is: @code{#+STARTUP: logdone}}. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3188 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3189 @lisp |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3190 (setq org-log-done 'time) |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3191 @end lisp |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3192 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3193 @noindent |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3194 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
|
3195 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
|
3196 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
|
3197 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
|
3198 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
|
3199 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}} |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3200 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3201 @lisp |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3202 (setq org-log-done 'note) |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3203 @end lisp |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3204 |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3205 @noindent |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3206 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
|
3207 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
|
3208 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3209 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
|
3210 (@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
|
3211 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
|
3212 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
|
3213 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3214 @node Tracking TODO state changes, , Closing items, Progress logging |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3215 @subsection Tracking TODO state changes |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3216 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3217 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
|
3218 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
|
3219 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
|
3220 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
|
3221 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
|
3222 @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
|
3223 after each keyword. For example, with the setting |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3224 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3225 @lisp |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3226 (setq org-todo-keywords |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3227 '((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
|
3228 @end lisp |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3229 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3230 @noindent |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3231 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
|
3232 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
|
3233 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
|
3234 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
|
3235 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
|
3236 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
|
3237 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
|
3238 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
|
3239 @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
|
3240 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
|
3241 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
|
3242 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
|
3243 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
|
3244 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
|
3245 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
|
3246 configured. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3247 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3248 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
|
3249 to a buffer: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3250 @example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3251 #+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
|
3252 @end example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3253 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3254 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
|
3255 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
|
3256 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
|
3257 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
|
3258 @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
|
3259 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
|
3260 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3261 @example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3262 * 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
|
3263 :PROPERTIES: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3264 :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
|
3265 :END: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3266 * 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
|
3267 :PROPERTIES: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3268 :LOGGING: WAIT(@@) logrepeat |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3269 :END: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3270 * 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
|
3271 :PROPERTIES: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3272 :LOGGING: nil |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3273 :END: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3274 @end example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3275 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3276 @node Priorities, Breaking down tasks, Progress logging, TODO Items |
84308 | 3277 @section Priorities |
3278 @cindex priorities | |
3279 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3280 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
|
3281 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
|
3282 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
|
3283 this |
84308 | 3284 |
3285 @example | |
3286 *** TODO [#A] Write letter to Sam Fortune | |
3287 @end example | |
3288 | |
3289 @noindent | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3290 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
|
3291 @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
|
3292 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
|
3293 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
|
3294 no inherent meaning to Org mode. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3295 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3296 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
|
3297 to be TODO items. |
84308 | 3298 |
3299 @table @kbd | |
3300 @kindex @kbd{C-c ,} | |
3301 @item @kbd{C-c ,} | |
3302 Set the priority of the current headline. The command prompts for a | |
3303 priority character @samp{A}, @samp{B} or @samp{C}. When you press | |
3304 @key{SPC} instead, the priority cookie is removed from the headline. | |
3305 The priorities can also be changed ``remotely'' from the timeline and | |
3306 agenda buffer with the @kbd{,} command (@pxref{Agenda commands}). | |
3307 @c | |
3308 @kindex S-@key{up} | |
3309 @kindex S-@key{down} | |
3310 @item S-@key{up} | |
3311 @itemx S-@key{down} | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3312 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
|
3313 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
|
3314 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
|
3315 Furthermore, these keys are also used by CUA mode (@pxref{Conflicts}). |
84308 | 3316 @end table |
3317 | |
3318 You can change the range of allowed priorities by setting the variables | |
3319 @code{org-highest-priority}, @code{org-lowest-priority}, and | |
3320 @code{org-default-priority}. For an individual buffer, you may set | |
3321 these values (highest, lowest, default) like this (please make sure that | |
3322 the highest priority is earlier in the alphabet than the lowest | |
3323 priority): | |
3324 | |
3325 @example | |
3326 #+PRIORITIES: A C B | |
3327 @end example | |
3328 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3329 @node Breaking down tasks, Checkboxes, Priorities, TODO Items |
84308 | 3330 @section Breaking tasks down into subtasks |
3331 @cindex tasks, breaking down | |
3332 | |
3333 It is often advisable to break down large tasks into smaller, manageable | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3334 subtasks. You can do this by creating an outline tree below a TODO item, |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3335 with detailed subtasks on the tree@footnote{To keep subtasks out of the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3336 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3337 the overview over the fraction of subtasks that are already completed, insert |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3338 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3339 be updates each time the todo status of a child changes. For example: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3340 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3341 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3342 * Organize Party [33%] |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3343 ** TODO Call people [1/2] |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3344 *** TODO Peter |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3345 *** DONE Sarah |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3346 ** TODO Buy food |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3347 ** DONE Talk to neighbor |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3348 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3349 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3350 If you would like a TODO entry to automatically change to DONE when all |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3351 chilrden are done, you can use the following setup: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3352 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3353 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3354 (defun org-summary-todo (n-done n-not-done) |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3355 "Switch entry to DONE when all subentries are done, to TODO otherwise." |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3356 (let (org-log-done org-log-states) ; turn off logging |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3357 (org-todo (if (= n-not-done 0) "DONE" "TODO")))) |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3358 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3359 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo) |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3360 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3361 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3362 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3363 Another possibility is the use of checkboxes to identify (a hierarchy of) a |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3364 large number of subtasks (@pxref{Checkboxes}). |
84308 | 3365 |
3366 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3367 @node Checkboxes, , Breaking down tasks, TODO Items |
84308 | 3368 @section Checkboxes |
3369 @cindex checkboxes | |
3370 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3371 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
|
3372 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
|
3373 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
|
3374 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
|
3375 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
|
3376 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
|
3377 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
|
3378 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3379 Here is an example of a checkbox list. |
84308 | 3380 |
3381 @example | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3382 * 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
|
3383 - [-] call people [1/3] |
84308 | 3384 - [ ] Peter |
3385 - [X] Sarah | |
3386 - [ ] Sam | |
3387 - [X] order food | |
3388 - [ ] think about what music to play | |
3389 - [X] talk to the neighbors | |
3390 @end example | |
3391 | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3392 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
|
3393 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
|
3394 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
|
3395 checked. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3396 |
84308 | 3397 @cindex statistics, for checkboxes |
3398 @cindex checkbox statistics | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3399 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
|
3400 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
|
3401 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
|
3402 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
|
3403 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
|
3404 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
|
3405 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
|
3406 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
|
3407 @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
|
3408 the examples above. With @samp{[%]} you get information about the |
84308 | 3409 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
|
3410 @samp{[50%]} and @samp{[33%]}, respectively). |
84308 | 3411 |
3412 @noindent The following commands work with checkboxes: | |
3413 | |
3414 @table @kbd | |
3415 @kindex C-c C-c | |
3416 @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
|
3417 Toggle checkbox at point. With a prefix argument, set it to @samp{[-]}, |
84308 | 3418 which is considered to be an intermediate state. |
3419 @kindex C-c C-x C-b | |
3420 @item C-c C-x C-b | |
3421 Toggle checkbox at point. | |
3422 @itemize @minus | |
3423 @item | |
3424 If there is an active region, toggle the first checkbox in the region | |
3425 and set all remaining boxes to the same status as the first. If you | |
3426 want to toggle all boxes in the region independently, use a prefix | |
3427 argument. | |
3428 @item | |
3429 If the cursor is in a headline, toggle checkboxes in the region between | |
3430 this headline and the next (so @emph{not} the entire subtree). | |
3431 @item | |
3432 If there is no active region, just toggle the checkbox at point. | |
3433 @end itemize | |
3434 @kindex M-S-@key{RET} | |
3435 @item M-S-@key{RET} | |
3436 Insert a new item with a checkbox. | |
3437 This works only if the cursor is already in a plain list item | |
3438 (@pxref{Plain lists}). | |
3439 @kindex C-c # | |
3440 @item C-c # | |
3441 Update the checkbox statistics in the current outline entry. When | |
3442 called with a @kbd{C-u} prefix, update the entire file. Checkbox | |
3443 statistic cookies are updated automatically if you toggle checkboxes | |
3444 with @kbd{C-c C-c} and make new ones with @kbd{M-S-@key{RET}}. If you | |
3445 delete boxes or add/change them by hand, use this command to get things | |
3446 back into synch. Or simply toggle any checkbox twice with @kbd{C-c C-c}. | |
3447 @end table | |
3448 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3449 @node Tags, Properties and Columns, TODO Items, Top |
84308 | 3450 @chapter Tags |
3451 @cindex tags | |
3452 @cindex headline tagging | |
3453 @cindex matching, tags | |
3454 @cindex sparse tree, tag based | |
3455 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3456 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
|
3457 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
|
3458 support for tags. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3459 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3460 Every headline can contain a list of tags; they occur at the end of the |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3461 headline. Tags are normal words containing letters, numbers, @samp{_}, and |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3462 @samp{@@}. Tags must be preceded and followed by a single colon, e.g., |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3463 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}. |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3464 Tags will by default get a bold face with the same color as the headline. |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3465 You may specify special faces for specific tags using the variable |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3466 @code{org-tag-faces}, much in the same way as you can do for TODO keywords |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3467 (@pxref{Faces for TODO keywords}). |
84308 | 3468 |
3469 @menu | |
3470 * Tag inheritance:: Tags use the tree structure of the outline | |
3471 * Setting tags:: How to assign tags to a headline | |
3472 * Tag searches:: Searching for combinations of tags | |
3473 @end menu | |
3474 | |
3475 @node Tag inheritance, Setting tags, Tags, Tags | |
3476 @section Tag inheritance | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3477 @cindex tag inheritance |
84308 | 3478 @cindex inheritance, of tags |
3479 @cindex sublevels, inclusion into tags match | |
3480 | |
3481 @i{Tags} make use of the hierarchical structure of outline trees. If a | |
3482 heading has a certain tag, all subheadings will inherit the tag as | |
3483 well. For example, in the list | |
3484 | |
3485 @example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3486 * Meeting with the French group :work: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3487 ** Summary by Frank :boss:notes: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3488 *** TODO Prepare slides for him :action: |
84308 | 3489 @end example |
3490 | |
3491 @noindent | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3492 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
|
3493 @samp{:notes:}, and @samp{:action:} even though the final heading is not |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3494 explicitly marked with those tags. You can also set tags that all entries in |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3495 a file should inherit as if these tags would be defined in a hypothetical |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3496 level zero that surounds the entire file. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3497 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3498 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3499 #+FILETAGS: :Peter:Boss:Secret: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3500 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3501 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3502 @noindent |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3503 To limit tag inheritance to specific tags, or to turn it off entirely, use |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3504 the variables @code{org-use-tag-inheritance} and |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3505 @code{org-tags-exclude-from-inheritance}. |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3506 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3507 When a headline matches during a tags search while tag inheritance is turned |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3508 on, all the sublevels in the same tree will (for a simple match form) match |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3509 as well@footnote{This is only true if the the search does not involve more |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3510 complex tests including properties (@pxref{Property searches}).}. The list |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3511 of matches may then become very long. If you only want to see the first tags |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3512 match in a subtree, configure the variable |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3513 @code{org-tags-match-list-sublevels} (not recommended). |
84308 | 3514 |
3515 @node Setting tags, Tag searches, Tag inheritance, Tags | |
3516 @section Setting tags | |
3517 @cindex setting tags | |
3518 @cindex tags, setting | |
3519 | |
3520 @kindex M-@key{TAB} | |
3521 Tags can simply be typed into the buffer at the end of a headline. | |
3522 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is | |
3523 also a special command for inserting tags: | |
3524 | |
3525 @table @kbd | |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
3526 @kindex C-c C-q |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
3527 @item C-c C-q |
84308 | 3528 @cindex completion, of tags |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3529 Enter new tags for the current headline. Org mode will either offer |
84308 | 3530 completion or a special single-key interface for setting tags, see |
3531 below. After pressing @key{RET}, the tags will be inserted and aligned | |
3532 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all | |
3533 tags in the current buffer will be aligned to that column, just to make | |
3534 things look nice. TAGS are automatically realigned after promotion, | |
3535 demotion, and TODO state changes (@pxref{TODO basics}). | |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
3536 @kindex C-c C-c |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
3537 @item C-c C-c |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
3538 When the cursor is in a headline, this does the same as @kbd{C-c C-q}. |
84308 | 3539 @end table |
3540 | |
3541 Org will support tag insertion based on a @emph{list of tags}. By | |
3542 default this list is constructed dynamically, containing all tags | |
3543 currently used in the buffer. You may also globally specify a hard list | |
3544 of tags with the variable @code{org-tag-alist}. Finally you can set | |
3545 the default tags for a given file with lines like | |
3546 | |
3547 @example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3548 #+TAGS: @@work @@home @@tennisclub |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3549 #+TAGS: laptop car pc sailboat |
84308 | 3550 @end example |
3551 | |
3552 If you have globally defined your preferred set of tags using the | |
3553 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
|
3554 in a specific file, add an empty TAGS option line to that file: |
84308 | 3555 |
3556 @example | |
3557 #+TAGS: | |
3558 @end example | |
3559 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3560 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
|
3561 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
|
3562 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
|
3563 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
|
3564 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
|
3565 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
|
3566 @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
|
3567 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
|
3568 like: |
84308 | 3569 |
3570 @lisp | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3571 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l))) |
84308 | 3572 @end lisp |
3573 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3574 @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
|
3575 can, instead, set the TAGS option line as: |
84308 | 3576 |
3577 @example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3578 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p) |
84308 | 3579 @end example |
3580 | |
3581 @noindent | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3582 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
|
3583 braces, as in: |
84308 | 3584 |
3585 @example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3586 #+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
|
3587 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3588 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3589 @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
|
3590 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed. |
84308 | 3591 |
3592 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of | |
3593 these lines to activate any changes. | |
3594 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3595 @noindent |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3596 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
|
3597 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
|
3598 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
|
3599 configuration: |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3600 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3601 @lisp |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3602 (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
|
3603 ("@@work" . ?w) ("@@home" . ?h) |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3604 ("@@tennisclub" . ?t) |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3605 (:endgroup . nil) |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3606 ("laptop" . ?l) ("pc" . ?p))) |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3607 @end lisp |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3608 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3609 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
|
3610 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
|
3611 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
|
3612 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
|
3613 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
|
3614 keys: |
84308 | 3615 |
3616 @table @kbd | |
3617 @item a-z... | |
3618 Pressing keys assigned to tags will add or remove them from the list of | |
3619 tags in the current line. Selecting a tag in a group of mutually | |
3620 exclusive tags will turn off any other tags from that group. | |
3621 @kindex @key{TAB} | |
3622 @item @key{TAB} | |
3623 Enter a tag in the minibuffer, even if the tag is not in the predefined | |
3624 list. You will be able to complete on all tags present in the buffer. | |
3625 @kindex @key{SPC} | |
3626 @item @key{SPC} | |
3627 Clear all tags for this line. | |
3628 @kindex @key{RET} | |
3629 @item @key{RET} | |
3630 Accept the modified set. | |
3631 @item C-g | |
3632 Abort without installing changes. | |
3633 @item q | |
3634 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}. | |
3635 @item ! | |
3636 Turn off groups of mutually exclusive tags. Use this to (as an | |
3637 exception) assign several tags from such a group. | |
3638 @item C-c | |
3639 Toggle auto-exit after the next change (see below). | |
3640 If you are using expert mode, the first @kbd{C-c} will display the | |
3641 selection window. | |
3642 @end table | |
3643 | |
3644 @noindent | |
3645 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
|
3646 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
|
3647 @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
|
3648 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
|
3649 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or |
84308 | 3650 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag |
3651 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h | |
3652 @key{RET} @key{RET}}. | |
3653 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3654 If you find that most of the time, you need only a single key press to |
84308 | 3655 modify your list of tags, set the variable |
3656 @code{org-fast-tag-selection-single-key}. Then you no longer have to | |
3657 press @key{RET} to exit fast tag selection - it will immediately exit | |
3658 after the first change. If you then occasionally need more keys, press | |
3659 @kbd{C-c} to turn off auto-exit for the current tag selection process | |
3660 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c | |
3661 C-c}). If you set the variable to the value @code{expert}, the special | |
3662 window is not even shown for single-key tag selection, it comes up only | |
3663 when you press an extra @kbd{C-c}. | |
3664 | |
3665 @node Tag searches, , Setting tags, Tags | |
3666 @section Tag searches | |
3667 @cindex tag searches | |
3668 @cindex searching for tags | |
3669 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3670 Once a system of tags has been set up, it can be used to collect related |
84308 | 3671 information into special lists. |
3672 | |
3673 @table @kbd | |
3674 @kindex C-c \ | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3675 @kindex C-c / T |
84308 | 3676 @item C-c \ |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3677 @itemx C-c / T |
84308 | 3678 Create a sparse tree with all headlines matching a tags search. With a |
3679 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line. | |
3680 @kindex C-c a m | |
3681 @item C-c a m | |
3682 Create a global list of tag matches from all agenda files. | |
3683 @xref{Matching tags and properties}. | |
3684 @kindex C-c a M | |
3685 @item C-c a M | |
3686 Create a global list of tag matches from all agenda files, but check | |
3687 only TODO items and force checking subitems (see variable | |
3688 @code{org-tags-match-list-sublevels}). | |
3689 @end table | |
3690 | |
3691 @cindex Boolean logic, for tag searches | |
3692 A @i{tags} search string can use Boolean operators @samp{&} for AND and | |
3693 @samp{|} for OR. @samp{&} binds more strongly than @samp{|}. | |
3694 Parenthesis are currently not implemented. A tag may also be preceded | |
3695 by @samp{-}, to select against it, and @samp{+} is syntactic sugar for | |
3696 positive selection. The AND operator @samp{&} is optional when @samp{+} | |
3697 or @samp{-} is present. Examples: | |
3698 | |
3699 @table @samp | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3700 @item +work-boss |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3701 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
|
3702 @samp{:boss:}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3703 @item work|laptop |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3704 Selects lines tagged @samp{:work:} or @samp{:laptop:}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3705 @item work|laptop&night |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3706 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
|
3707 @samp{:night:}. |
84308 | 3708 @end table |
3709 | |
3710 @cindex TODO keyword matching, with tags search | |
99503
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3711 You may also test for TODO keywords (@pxref{TODO extensions}) and properties |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3712 (@pxref{Properties and Columns}) at the same time as matching tags. For a |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3713 guide on how to match properties, see @ref{Property searches}. To match a |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3714 specific TODO keyword, include an expression like @samp{+TODO="NEXT"} as one |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3715 of the terms in a tags search. |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3716 |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3717 There is also the possibility to end the tags part of the match (which may |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3718 include several terms connected with @samp{|}) with a @samp{/} and then |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3719 specify a Boolean expression just for TODO keywords. The syntax is then |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3720 similar to the tag matches, but should be applied with consideration: For |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3721 example, a positive selection on several TODO keywords can not meaningfully |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3722 be combined with boolean AND. However, @emph{negative selection} combined |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3723 with AND can be meaningful. To make sure that only lines are checked that |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3724 actually have any TODO keyword (resulting in a speed-up), use @kbd{C-c a M}, |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3725 or equivalently start the TODO part after the slash with @samp{!}. Examples: |
84308 | 3726 |
3727 @table @samp | |
99503
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3728 @item work+TODO="WAITING" |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3729 Select @samp{:work:}-tagged TODO lines with the specific TODO |
84308 | 3730 keyword @samp{WAITING}. |
99503
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3731 @item work+TODO="WAITING"|home+TODO="WAITING" |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3732 Waiting tasks both at work and at home. |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3733 @item work/WAITING |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3734 Same as the first example. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3735 @item work/!-WAITING-NEXT |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3736 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING} |
84308 | 3737 nor @samp{NEXT} |
99503
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3738 @item work/!+WAITING|+NEXT |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3739 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or |
84308 | 3740 @samp{NEXT}. |
3741 @end table | |
3742 | |
3743 @cindex regular expressions, with tags search | |
3744 Any element of the tag/todo match can be a regular expression - in this | |
3745 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
|
3746 @samp{work+@{^boss.*@}} matches headlines that contain the tag |
99503
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3747 @samp{:work:} and any tag @i{starting} with @samp{boss}. You may also use a |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3748 regular expression in @samp{TODO=@{^W@}} which would match TODO keywords |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3749 starting with the letter @samp{W}. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3750 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3751 @cindex level, require for tags/property match |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3752 @cindex category, require for tags/property match |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3753 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
|
3754 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
|
3755 @samp{CATEGORY="work"}, respectively. For example, a search |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3756 @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
|
3757 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
|
3758 |
99503
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3759 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3760 other properties will slow down the search. |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
3761 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3762 @node Properties and Columns, Dates and Times, Tags, Top |
84308 | 3763 @chapter Properties and Columns |
3764 @cindex properties | |
3765 | |
3766 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
|
3767 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
|
3768 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
|
3769 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
|
3770 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
|
3771 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
|
3772 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
|
3773 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
|
3774 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
|
3775 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
|
3776 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
|
3777 release, number of tracks, and so on. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3778 |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3779 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
|
3780 (@pxref{Column view}). |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3781 |
84308 | 3782 @menu |
3783 * 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
|
3784 * Special properties:: Access to other Org mode features |
84308 | 3785 * Property searches:: Matching property values |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3786 * Property inheritance:: Passing values down the tree |
84308 | 3787 * Column view:: Tabular viewing and editing |
3788 * Property API:: Properties for Lisp programmers | |
3789 @end menu | |
3790 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3791 @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
|
3792 @section Property syntax |
84308 | 3793 @cindex property syntax |
3794 @cindex drawer, for properties | |
3795 | |
3796 Properties are key-value pairs. They need to be inserted into a special | |
3797 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property | |
3798 is specified on a single line, with the key (surrounded by colons) | |
3799 first, and the value after it. Here is an example: | |
3800 | |
3801 @example | |
3802 * CD collection | |
3803 ** Classic | |
3804 *** Goldberg Variations | |
3805 :PROPERTIES: | |
3806 :Title: Goldberg Variations | |
3807 :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
|
3808 :Artist: Glen Gould |
84308 | 3809 :Publisher: Deutsche Grammphon |
3810 :NDisks: 1 | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3811 :END: |
84308 | 3812 @end example |
3813 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3814 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
|
3815 by setting a property @samp{:Xyz_ALL:}. This special property is |
84308 | 3816 @emph{inherited}, so if you set it in a level 1 entry, it will apply to |
3817 the entire tree. When allowed values are defined, setting the | |
3818 corresponding property becomes easier and is less prone to typing | |
3819 errors. For the example with the CD collection, we can predefine | |
3820 publishers and the number of disks in a box like this: | |
3821 | |
3822 @example | |
3823 * CD collection | |
3824 :PROPERTIES: | |
3825 :NDisks_ALL: 1 2 3 4 | |
99851
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
3826 :Publisher_ALL: "Deutsche Grammophon" Philips EMI |
84308 | 3827 :END: |
3828 @end example | |
3829 | |
3830 If you want to set properties that can be inherited by any entry in a | |
3831 file, use a line like | |
3832 | |
3833 @example | |
3834 #+PROPERTY: NDisks_ALL 1 2 3 4 | |
3835 @end example | |
3836 | |
3837 Property values set with the global variable | |
3838 @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
|
3839 Org files. |
84308 | 3840 |
3841 @noindent | |
3842 The following commands help to work with properties: | |
3843 | |
3844 @table @kbd | |
3845 @kindex M-@key{TAB} | |
3846 @item M-@key{TAB} | |
3847 After an initial colon in a line, complete property keys. All keys used | |
3848 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
|
3849 @kindex C-c C-x p |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3850 @item C-c C-x p |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3851 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
|
3852 necessary, the property drawer is created as well. |
84308 | 3853 @item M-x org-insert-property-drawer |
3854 Insert a property drawer into the current entry. The drawer will be | |
3855 inserted early in the entry, but after the lines with planning | |
3856 information like deadlines. | |
3857 @kindex C-c C-c | |
3858 @item C-c C-c | |
3859 With the cursor in a property drawer, this executes property commands. | |
3860 @item C-c C-c s | |
3861 Set a property in the current entry. Both the property and the value | |
3862 can be inserted using completion. | |
3863 @kindex S-@key{right} | |
3864 @kindex S-@key{left} | |
3865 @item S-@key{left}/@key{right} | |
3866 Switch property at point to the next/previous allowed value. | |
3867 @item C-c C-c d | |
3868 Remove a property from the current entry. | |
3869 @item C-c C-c D | |
3870 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
|
3871 @item C-c C-c c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3872 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
|
3873 nearest column format definition. |
84308 | 3874 @end table |
3875 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3876 @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
|
3877 @section Special properties |
84308 | 3878 @cindex properties, special |
3879 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3880 Special properties provide alternative access method to Org mode |
84308 | 3881 features discussed in the previous chapters, like the TODO state or the |
3882 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
|
3883 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
|
3884 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
|
3885 used as keys in the properties drawer: |
84308 | 3886 |
3887 @example | |
3888 TODO @r{The TODO keyword of the entry.} | |
3889 TAGS @r{The tags defined directly in the headline.} | |
3890 ALLTAGS @r{All tags, including inherited ones.} | |
3891 PRIORITY @r{The priority of the entry, a string with a single letter.} | |
3892 DEADLINE @r{The deadline time string, without the angular brackets.} | |
3893 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
|
3894 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
|
3895 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
|
3896 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
|
3897 @r{must be run first to compute the values.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3898 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3899 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3900 @node Property searches, Property inheritance, Special properties, Properties and Columns |
84308 | 3901 @section Property searches |
3902 @cindex properties, searching | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3903 @cindex searching, of properties |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3904 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3905 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
|
3906 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
|
3907 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
|
3908 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3909 @example |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
3910 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \ |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
3911 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>" |
84308 | 3912 @end example |
3913 | |
3914 @noindent | |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
3915 The type of comparison will depend on how the comparison value is written: |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
3916 @itemize @minus |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
3917 @item |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3918 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
|
3919 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=}, |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
3920 @samp{>=}, and @samp{<>}. |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
3921 @item |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
3922 If the comparison value is enclosed in double |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3923 quotes, a string comparison is done, and the same operators are allowed. |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
3924 @item |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
3925 If the comparison value is enclosed in double quotes @emph{and} angular |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
3926 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3927 assumed to be date/time specifications in the standard Org way, and the |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3928 comparison will be done accordingly. Special values that will be recognized |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3929 are @code{"<now>"} for now (including time), and @code{"<today>"}, and |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3930 @code{"<tomorrow>"} for these days at 0:00 hours, i.e. without a time |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3931 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3932 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year, |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3933 respectively, can be used. |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
3934 @item |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
3935 If the comparison value is enclosed |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
3936 in curly braces, a regexp match is performed, with @samp{=} meaning that the |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
3937 regexp matches the property value, and @samp{<>} meaning that it does not |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
3938 match. |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
3939 @end itemize |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
3940 |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
3941 So the search string in the example finds entries tagged @samp{:work:} but |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
3942 not @samp{:boss:}, which also have a priority value @samp{A}, a |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
3943 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort} |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
3944 property that is numerically smaller than 2, a @samp{:With:} property that is |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
3945 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
3946 on or after October 11, 2008. |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3947 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3948 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
|
3949 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
|
3950 inheritance} for details. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3951 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3952 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
|
3953 single property: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3954 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3955 @table @kbd |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3956 @kindex C-c / p |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3957 @item C-c / p |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3958 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
|
3959 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
|
3960 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
|
3961 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
|
3962 a regular expression and matched against the property values. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3963 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3964 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3965 @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
|
3966 @section Property Inheritance |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3967 @cindex properties, inheritance |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3968 @cindex inheritance, of properties |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3969 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3970 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
|
3971 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
|
3972 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
|
3973 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
|
3974 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
|
3975 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
|
3976 @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
|
3977 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
|
3978 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
|
3979 inherited properties. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3980 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3981 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
|
3982 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
|
3983 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3984 @table @code |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3985 @item COLUMNS |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3986 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
|
3987 (@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
|
3988 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
|
3989 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
|
3990 subtree from where columns view is turned on. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3991 @item CATEGORY |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3992 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
|
3993 applies to the entire subtree. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3994 @item ARCHIVE |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3995 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
|
3996 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
|
3997 @item LOGGING |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3998 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
|
3999 subtree (@pxref{Tracking TODO state changes}). |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4000 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4001 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4002 @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
|
4003 @section Column view |
84308 | 4004 |
4005 A great way to view and edit properties in an outline tree is | |
4006 @emph{column view}. In column view, each outline item is turned into a | |
4007 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
|
4008 entries. Org mode implements columns by overlaying a tabular structure |
84308 | 4009 over the headline of each item. While the headlines have been turned |
4010 into a table row, you can still change the visibility of the outline | |
4011 tree. For example, you get a compact table by switching to CONTENTS | |
4012 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view | |
4013 is active), but you can still open, read, and edit the entry below each | |
4014 headline. Or, you can switch to column view after executing a sparse | |
4015 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
|
4016 Column view also works in agenda buffers (@pxref{Agenda Views}) where |
84308 | 4017 queries have collected selected items, possibly from a number of files. |
4018 | |
4019 @menu | |
4020 * Defining columns:: The COLUMNS format property | |
4021 * 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
|
4022 * Capturing column view:: A dynamic block for column view |
84308 | 4023 @end menu |
4024 | |
4025 @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
|
4026 @subsection Defining columns |
84308 | 4027 @cindex column view, for properties |
4028 @cindex properties, column view | |
4029 | |
4030 Setting up a column view first requires defining the columns. This is | |
4031 done by defining a column format line. | |
4032 | |
4033 @menu | |
4034 * Scope of column definitions:: Where defined, where valid? | |
4035 * Column attributes:: Appearance and content of a column | |
4036 @end menu | |
4037 | |
4038 @node Scope of column definitions, Column attributes, Defining columns, Defining columns | |
4039 @subsubsection Scope of column definitions | |
4040 | |
4041 To define a column format for an entire file, use a line like | |
4042 | |
4043 @example | |
4044 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO | |
4045 @end example | |
4046 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4047 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
|
4048 @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
|
4049 |
84308 | 4050 @example |
4051 ** Top node for columns view | |
4052 :PROPERTIES: | |
4053 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO | |
4054 :END: | |
4055 @end example | |
4056 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4057 If a @code{:COLUMNS:} property is present in an entry, it defines columns |
84308 | 4058 for the entry itself, and for the entire subtree below it. Since the |
4059 column definition is part of the hierarchical structure of the document, | |
4060 you can define columns on level 1 that are general enough for all | |
4061 sublevels, and more specific columns further down, when you edit a | |
4062 deeper part of the tree. | |
4063 | |
4064 @node Column attributes, , Scope of column definitions, Defining columns | |
4065 @subsubsection Column attributes | |
4066 A column definition sets the attributes of a column. The general | |
4067 definition looks like this: | |
4068 | |
4069 @example | |
4070 %[width]property[(title)][@{summary-type@}] | |
4071 @end example | |
4072 | |
4073 @noindent | |
4074 Except for the percent sign and the property name, all items are | |
4075 optional. The individual parts have the following meaning: | |
4076 | |
4077 @example | |
4078 width @r{An integer specifying the width of the column in characters.} | |
4079 @r{If omitted, the width will be determined automatically.} | |
4080 property @r{The property that should be edited in this column.} | |
4081 (title) @r{The header text for the column. If omitted, the} | |
4082 @r{property name is used.} | |
4083 @{summary-type@} @r{The summary type. If specified, the column values for} | |
4084 @r{parent nodes are computed from the children.} | |
4085 @r{Supported summary types are:} | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4086 @{+@} @r{Sum numbers in this column.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4087 @{+;%.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
|
4088 @{$@} @r{Currency, short for @samp{+;%.2f}.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4089 @{:@} @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
|
4090 @{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
|
4091 @{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
|
4092 @{X%@} @r{Checkbox status, [n%].} |
84308 | 4093 @end example |
4094 | |
4095 @noindent | |
4096 Here is an example for a complete columns definition, along with allowed | |
4097 values. | |
4098 | |
4099 @example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4100 :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
|
4101 %10Time_Estimate@{:@} %CLOCKSUM |
84308 | 4102 :Owner_ALL: Tammy Mark Karl Lisa Don |
4103 :Status_ALL: "In progress" "Not started yet" "Finished" "" | |
4104 :Approved_ALL: "[ ]" "[X]" | |
4105 @end example | |
4106 | |
4107 The first column, @samp{%25ITEM}, means the first 25 characters of the | |
4108 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
|
4109 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
|
4110 create columns @samp{Owner} with a list of names as allowed values, for |
84308 | 4111 @samp{Status} with four different possible values, and for a checkbox |
4112 field @samp{Approved}. When no width is given after the @samp{%} | |
4113 character, the column will be exactly as wide as it needs to be in order | |
4114 to fully display all values. The @samp{Approved} column does have a | |
4115 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
|
4116 be created for the @samp{Time_Estimate} column by adding time duration |
84308 | 4117 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
|
4118 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
|
4119 @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
|
4120 in the subtree. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4121 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4122 @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
|
4123 @subsection Using column view |
84308 | 4124 |
4125 @table @kbd | |
4126 @tsubheading{Turning column view on and off} | |
4127 @kindex C-c C-x C-c | |
4128 @item C-c C-x C-c | |
4129 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
|
4130 the hierarchy, up from point, for a @code{:COLUMNS:} property that defines |
84308 | 4131 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
|
4132 the entire tree, starting from the entry that contains the @code{:COLUMNS:} |
84308 | 4133 property. If none is found, the format is taken from the @code{#+COLUMNS} |
4134 line or from the variable @code{org-columns-default-format}, and column | |
4135 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
|
4136 @kindex r |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4137 @item r |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4138 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
|
4139 @kindex g |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4140 @item g |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4141 Same as @kbd{r}. |
84308 | 4142 @kindex q |
4143 @item q | |
4144 Exit column view. | |
4145 @tsubheading{Editing values} | |
4146 @item @key{left} @key{right} @key{up} @key{down} | |
4147 Move through the column view from field to field. | |
4148 @kindex S-@key{left} | |
4149 @kindex S-@key{right} | |
4150 @item S-@key{left}/@key{right} | |
4151 Switch to the next/previous allowed value of the field. For this, you | |
4152 have to have specified allowed values for a property. | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4153 @item 1..9,0 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4154 Directly select the nth allowed value, @kbd{0} selects the 10th value. |
84308 | 4155 @kindex n |
4156 @kindex p | |
4157 @itemx n / p | |
4158 Same as @kbd{S-@key{left}/@key{right}} | |
4159 @kindex e | |
4160 @item e | |
4161 Edit the property at point. For the special properties, this will | |
4162 invoke the same interface that you normally use to change that | |
4163 property. For example, when editing a TAGS property, the tag completion | |
4164 or fast selection interface will pop up. | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4165 @kindex C-c C-c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4166 @item C-c C-c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4167 When there is a checkbox at point, toggle it. |
84308 | 4168 @kindex v |
4169 @item v | |
4170 View the full value of this property. This is useful if the width of | |
4171 the column is smaller than that of the value. | |
4172 @kindex a | |
4173 @item a | |
4174 Edit the list of allowed values for this property. If the list is found | |
4175 in the hierarchy, the modified values is stored there. If no list is | |
4176 found, the new value is stored in the first entry that is part of the | |
4177 current column view. | |
4178 @tsubheading{Modifying the table structure} | |
4179 @kindex < | |
4180 @kindex > | |
4181 @item < / > | |
4182 Make the column narrower/wider by one character. | |
4183 @kindex S-M-@key{right} | |
4184 @item S-M-@key{right} | |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
4185 Insert a new column, to the left of the current column. |
84308 | 4186 @kindex S-M-@key{left} |
4187 @item S-M-@key{left} | |
4188 Delete the current column. | |
4189 @end table | |
4190 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4191 @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
|
4192 @subsection Capturing column view |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4193 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4194 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
|
4195 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
|
4196 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
|
4197 of this block looks like this: |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4198 |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4199 @cindex #+BEGIN: columnview |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4200 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4201 * The column view |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4202 #+BEGIN: columnview :hlines 1 :id "label" |
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 #+END: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4205 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4206 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4207 @noindent This dynamic block has the following parameters: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4208 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4209 @table @code |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4210 @item :id |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4211 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
|
4212 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
|
4213 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
|
4214 capture, you can use 3 values: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4215 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4216 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
|
4217 global @r{make a global view, including all headings in the file} |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4218 "label" @r{call column view in the tree that has an @code{:ID:}} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4219 @r{property with the value @i{label}. You can use} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4220 @r{@kbd{M-x org-id-copy} to create a globally unique ID for} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4221 @r{the current entry and copy it to the kill-ring.} |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4222 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4223 @item :hlines |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4224 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
|
4225 a hline before each headline with level @code{<= N}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4226 @item :vlines |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4227 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
|
4228 @item :maxlevel |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4229 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
|
4230 @item :skip-empty-rows |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4231 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
|
4232 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
|
4233 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4234 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4235 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4236 @noindent |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4237 The following commands insert or update the dynamic block: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4238 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4239 @table @kbd |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
4240 @kindex C-c C-x i |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
4241 @item C-c C-x i |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4242 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
|
4243 for the scope or id of the view. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4244 @kindex C-c C-c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4245 @item C-c C-c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4246 @kindex C-c C-x C-u |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4247 @itemx C-c C-x C-u |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4248 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
|
4249 @code{#+BEGIN} line of the dynamic block. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4250 @kindex C-u C-c C-x C-u |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4251 @item C-u C-c C-x C-u |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4252 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
|
4253 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
|
4254 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4255 |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
4256 You can add formulas to the column view table and you may add plotting |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
4257 instructions in front of the table - these will survive an update of the |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
4258 block. If there is a @code{#+TBLFM:} after the table, the table will |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
4259 actually be recalculated automatically after an update. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
4260 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4261 @node Property API, , Column view, Properties and Columns |
84308 | 4262 @section The Property API |
4263 @cindex properties, API | |
4264 @cindex API, for properties | |
4265 | |
4266 There is a full API for accessing and changing properties. This API can | |
4267 be used by Emacs Lisp programs to work with properties and to implement | |
4268 features based on them. For more information see @ref{Using the | |
4269 property API}. | |
4270 | |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
4271 @node Dates and Times, Capture, Properties and Columns, Top |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4272 @chapter Dates and Times |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4273 @cindex dates |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4274 @cindex times |
84308 | 4275 @cindex time stamps |
4276 @cindex date stamps | |
4277 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4278 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
|
4279 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
|
4280 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
|
4281 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
|
4282 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
|
4283 is used in a much wider sense. |
84308 | 4284 |
4285 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4286 * Timestamps:: Assigning a time to a tree entry |
84308 | 4287 * Creating timestamps:: Commands which insert timestamps |
4288 * 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
|
4289 * 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
|
4290 * Effort estimates:: Planning work effort in advance |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4291 * Relative timer:: Notes with a running timer |
84308 | 4292 @end menu |
4293 | |
4294 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4295 @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
|
4296 @section Timestamps, deadlines and scheduling |
84308 | 4297 @cindex time stamps |
4298 @cindex ranges, time | |
4299 @cindex date stamps | |
4300 @cindex deadlines | |
4301 @cindex scheduling | |
4302 | |
4303 A time stamp is a specification of a date (possibly with time or a range | |
4304 of times) in a special format, either @samp{<2003-09-16 Tue>} or | |
4305 @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
|
4306 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
|
4307 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
|
4308 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
|
4309 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
|
4310 (@pxref{Weekly/daily agenda}). We distinguish: |
84308 | 4311 |
4312 @table @var | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4313 @item Plain time stamp; Event; Appointment |
84308 | 4314 @cindex timestamp |
4315 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
|
4316 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
|
4317 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
|
4318 plain time stamp will be shown exactly on that date. |
84308 | 4319 |
4320 @example | |
4321 * Meet Peter at the movies <2006-11-01 Wed 19:15> | |
4322 * Discussion on climate change <2006-11-02 Thu 20:00-22:00> | |
4323 @end example | |
4324 | |
4325 @item Time stamp with repeater interval | |
4326 @cindex timestamp, with repeater interval | |
4327 A time stamp may contain a @emph{repeater interval}, indicating that it | |
4328 applies not only on the given date, but again and again after a certain | |
4329 interval of N days (d), weeks (w), months(m), or years(y). The | |
4330 following will show up in the agenda every Wednesday: | |
4331 | |
4332 @example | |
4333 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w> | |
4334 @end example | |
4335 | |
4336 @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
|
4337 For more complex date specifications, Org mode supports using the |
84308 | 4338 special sexp diary entries implemented in the Emacs calendar/diary |
4339 package. For example | |
4340 | |
4341 @example | |
4342 * The nerd meeting on every 2nd Thursday of the month | |
4343 <%%(diary-float t 4 2)> | |
4344 @end example | |
4345 | |
4346 @item Time/Date range | |
4347 @cindex timerange | |
4348 @cindex date range | |
4349 Two time stamps connected by @samp{--} denote a range. The headline | |
4350 will be shown on the first and last day of the range, and on any dates | |
4351 that are displayed and fall in the range. Here is an example: | |
4352 | |
4353 @example | |
4354 ** Meeting in Amsterdam | |
4355 <2004-08-23 Mon>--<2004-08-26 Thu> | |
4356 @end example | |
4357 | |
4358 @item Inactive time stamp | |
4359 @cindex timestamp, inactive | |
4360 @cindex inactive timestamp | |
4361 Just like a plain time stamp, but with square brackets instead of | |
4362 angular ones. These time stamps are inactive in the sense that they do | |
4363 @emph{not} trigger an entry to show up in the agenda. | |
4364 | |
4365 @example | |
4366 * Gillian comes late for the fifth time [2006-11-01 Wed] | |
4367 @end example | |
4368 | |
4369 @end table | |
4370 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4371 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times |
84308 | 4372 @section Creating timestamps |
4373 @cindex creating timestamps | |
4374 @cindex timestamps, creating | |
4375 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4376 For Org mode to recognize time stamps, they need to be in the specific |
84308 | 4377 format. All commands listed below produce time stamps in the correct |
4378 format. | |
4379 | |
4380 @table @kbd | |
4381 @kindex C-c . | |
4382 @item C-c . | |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
4383 Prompt for a date and insert a corresponding time stamp. When the cursor is |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
4384 at an existing time stamp in the buffer, the command is used to modify this |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
4385 timestamp instead of inserting a new one. When this command is used twice in |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
4386 succession, a time range is inserted. |
84308 | 4387 @c |
4388 @kindex C-u C-c . | |
4389 @item C-u C-c . | |
4390 Like @kbd{C-c .}, but use the alternative format which contains date | |
4391 and time. The default time can be rounded to multiples of 5 minutes, | |
4392 see the option @code{org-time-stamp-rounding-minutes}. | |
4393 @c | |
4394 @kindex C-c ! | |
4395 @item C-c ! | |
4396 Like @kbd{C-c .}, but insert an inactive time stamp that will not cause | |
4397 an agenda entry. | |
4398 @c | |
4399 @kindex C-c < | |
4400 @item C-c < | |
4401 Insert a time stamp corresponding to the cursor date in the Calendar. | |
4402 @c | |
4403 @kindex C-c > | |
4404 @item C-c > | |
4405 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
|
4406 timestamp in the current line, go to the corresponding date |
84308 | 4407 instead. |
4408 @c | |
4409 @kindex C-c C-o | |
4410 @item C-c C-o | |
4411 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
|
4412 point (@pxref{Weekly/daily agenda}). |
84308 | 4413 @c |
4414 @kindex S-@key{left} | |
4415 @kindex S-@key{right} | |
4416 @item S-@key{left} | |
4417 @itemx S-@key{right} | |
4418 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
|
4419 CUA mode (@pxref{Conflicts}). |
84308 | 4420 @c |
4421 @kindex S-@key{up} | |
4422 @kindex S-@key{down} | |
4423 @item S-@key{up} | |
4424 @itemx S-@key{down} | |
4425 Change the item under the cursor in a timestamp. The cursor can be on a | |
4426 year, month, day, hour or minute. Note that if the cursor is in a | |
4427 headline and not at a time stamp, these same keys modify the priority of | |
4428 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
|
4429 CUA mode (@pxref{Conflicts}). |
84308 | 4430 @c |
4431 @kindex C-c C-y | |
4432 @cindex evaluate time range | |
4433 @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
|
4434 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
|
4435 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
|
4436 the following column). |
84308 | 4437 @end table |
4438 | |
4439 | |
4440 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4441 * 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
|
4442 * Custom time format:: Making dates look different |
84308 | 4443 @end menu |
4444 | |
4445 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps | |
4446 @subsection The date/time prompt | |
4447 @cindex date, reading in minibuffer | |
4448 @cindex time, reading in minibuffer | |
4449 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4450 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
|
4451 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
|
4452 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
|
4453 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
|
4454 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
|
4455 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
|
4456 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
|
4457 @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
|
4458 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
|
4459 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
|
4460 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
|
4461 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
|
4462 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
|
4463 future date@footnote{See the variable |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4464 @code{org-read-date-prefer-future}.}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4465 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4466 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
|
4467 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
|
4468 in @b{bold}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4469 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4470 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4471 3-2-5 --> 2003-02-05 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4472 14 --> @b{2006}-@b{06}-14 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4473 12 --> @b{2006}-@b{07}-12 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4474 Fri --> nearest Friday (defaultdate or later) |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4475 sep 15 --> @b{2006}-11-15 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4476 feb 15 --> @b{2007}-02-15 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4477 sep 12 9 --> 2009-09-12 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4478 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
|
4479 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
|
4480 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
|
4481 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
|
4482 2012-w04-5 --> Same as above |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4483 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4484 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4485 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
|
4486 @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
|
4487 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
|
4488 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
|
4489 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
|
4490 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
|
4491 the nth such day. E.g. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4492 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4493 @example |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4494 +0 --> today |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4495 . --> today |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4496 +4d --> four days from today |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4497 +4 --> same as above |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4498 +2w --> two weeks from today |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4499 ++5 --> five days from default date |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4500 +2tue --> second tuesday from now. |
84308 | 4501 @end example |
4502 | |
4503 The function understands English month and weekday abbreviations. If | |
4504 you want to use unabbreviated names and/or other languages, configure | |
4505 the variables @code{parse-time-months} and @code{parse-time-weekdays}. | |
4506 | |
4507 @cindex calendar, for selecting date | |
4508 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If | |
4509 you don't need/want the calendar, configure the variable | |
4510 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date | |
4511 prompt, either by clicking on a date in the calendar, or by pressing | |
4512 @key{RET}, the date selected in the calendar will be combined with the | |
4513 information entered at the prompt. You can control the calendar fully | |
4514 from the minibuffer: | |
4515 | |
4516 @kindex < | |
4517 @kindex > | |
4518 @kindex mouse-1 | |
4519 @kindex S-@key{right} | |
4520 @kindex S-@key{left} | |
4521 @kindex S-@key{down} | |
4522 @kindex S-@key{up} | |
4523 @kindex M-S-@key{right} | |
4524 @kindex M-S-@key{left} | |
4525 @kindex @key{RET} | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4526 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4527 > / < @r{Scroll calendar forward/backward by one month.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4528 mouse-1 @r{Select date by clicking on it.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4529 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
|
4530 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
|
4531 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
|
4532 @key{RET} @r{Choose date in calendar.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4533 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4534 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4535 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
|
4536 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
|
4537 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
|
4538 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
|
4539 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
|
4540 @code{org-read-date-display-live}.}. |
84308 | 4541 |
4542 @node Custom time format, , The date/time prompt, Creating timestamps | |
4543 @subsection Custom time format | |
4544 @cindex custom date/time format | |
4545 @cindex time format, custom | |
4546 @cindex date format, custom | |
4547 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4548 Org mode uses the standard ISO notation for dates and times as it is |
84308 | 4549 defined in ISO 8601. If you cannot get used to this and require another |
4550 representation of date and time to keep you happy, you can get it by | |
4551 customizing the variables @code{org-display-custom-times} and | |
4552 @code{org-time-stamp-custom-formats}. | |
4553 | |
4554 @table @kbd | |
4555 @kindex C-c C-x C-t | |
4556 @item C-c C-x C-t | |
4557 Toggle the display of custom formats for dates and times. | |
4558 @end table | |
4559 | |
4560 @noindent | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4561 Org mode needs the default format for scanning, so the custom date/time |
84308 | 4562 format does not @emph{replace} the default format - instead it is put |
4563 @emph{over} the default format using text properties. This has the | |
4564 following consequences: | |
4565 @itemize @bullet | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4566 @item |
84308 | 4567 You cannot place the cursor onto a time stamp anymore, only before or |
4568 after. | |
4569 @item | |
4570 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust | |
4571 each component of a time stamp. If the cursor is at the beginning of | |
4572 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day, | |
4573 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the | |
4574 time will be changed by one minute. | |
4575 @item | |
4576 If the time stamp contains a range of clock times or a repeater, these | |
4577 will not be overlayed, but remain in the buffer as they were. | |
4578 @item | |
4579 When you delete a time stamp character-by-character, it will only | |
4580 disappear from the buffer after @emph{all} (invisible) characters | |
4581 belonging to the ISO timestamp have been removed. | |
4582 @item | |
4583 If the custom time stamp format is longer than the default and you are | |
4584 using dates in tables, table alignment will be messed up. If the custom | |
4585 format is shorter, things do work as expected. | |
4586 @end itemize | |
4587 | |
4588 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4589 @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
|
4590 @section Deadlines and scheduling |
84308 | 4591 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4592 A time stamp may be preceded by special keywords to facilitate planning: |
84308 | 4593 |
4594 @table @var | |
4595 @item DEADLINE | |
4596 @cindex DEADLINE keyword | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4597 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4598 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
|
4599 to be finished on that date. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4600 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4601 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
|
4602 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
|
4603 approaching or missed deadline, starting |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4604 @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
|
4605 until the entry is marked DONE. An example: |
84308 | 4606 |
4607 @example | |
4608 *** TODO write article about the Earth for the Guide | |
4609 The editor in charge is [[bbdb:Ford Prefect]] | |
4610 DEADLINE: <2004-02-29 Sun> | |
4611 @end example | |
4612 | |
4613 You can specify a different lead time for warnings for a specific | |
4614 deadlines using the following syntax. Here is an example with a warning | |
4615 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}. | |
4616 | |
4617 @item SCHEDULED | |
4618 @cindex SCHEDULED keyword | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4619 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4620 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
|
4621 date. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4622 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4623 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
|
4624 be listed on that date after it has been marked DONE. If you don't like |
84308 | 4625 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In |
4626 addition, a reminder that the scheduled date has passed will be present | |
4627 in the compilation for @emph{today}, until the entry is marked DONE. | |
4628 I.e., the task will automatically be forwarded until completed. | |
4629 | |
4630 @example | |
4631 *** TODO Call Trillian for a date on New Years Eve. | |
4632 SCHEDULED: <2004-12-25 Sat> | |
4633 @end example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4634 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4635 @noindent |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4636 @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
|
4637 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
|
4638 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
|
4639 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
|
4640 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
|
4641 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
|
4642 want to start working on an action item. |
84308 | 4643 @end table |
4644 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4645 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
|
4646 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
|
4647 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
|
4648 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
|
4649 @c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4650 @code{<%%(diary-float t 42)>} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4651 @c |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4652 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
|
4653 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
|
4654 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
|
4655 sexp entry matches. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4656 |
84308 | 4657 @menu |
4658 * Inserting deadline/schedule:: Planning items | |
4659 * Repeated tasks:: Items that show up again and again | |
4660 @end menu | |
4661 | |
4662 @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
|
4663 @subsection Inserting deadlines or schedules |
84308 | 4664 |
4665 The following commands allow to quickly insert a deadline or to schedule | |
4666 an item: | |
4667 | |
4668 @table @kbd | |
4669 @c | |
4670 @kindex C-c C-d | |
4671 @item C-c C-d | |
4672 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
|
4673 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
|
4674 prefix arg, an existing deadline will be removed from the entry. |
84308 | 4675 @c FIXME Any CLOSED timestamp will be removed.???????? |
4676 @c | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4677 @kindex C-c / d |
84308 | 4678 @cindex sparse tree, for deadlines |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4679 @item C-c / d |
84308 | 4680 Create a sparse tree with all deadlines that are either past-due, or |
4681 which will become due within @code{org-deadline-warning-days}. | |
4682 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
|
4683 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows |
84308 | 4684 all deadlines due tomorrow. |
4685 @c | |
4686 @kindex C-c C-s | |
4687 @item C-c C-s | |
4688 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will | |
4689 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
|
4690 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
|
4691 the scheduling date from the entry. |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4692 @c |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4693 @kindex C-c C-x C-k |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4694 @kindex k a |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4695 @kindex k s |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4696 @item C-c C-x C-k |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4697 Mark the current entry for agenda action. After you have marked the entry |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4698 like this, you can open the agenda or the calendar to find an appropriate |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4699 date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4700 schedule the marked item. |
84308 | 4701 @end table |
4702 | |
4703 @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
|
4704 @subsection Repeated tasks |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4705 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4706 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
|
4707 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
|
4708 or plain time stamp. In the following example |
84308 | 4709 @example |
4710 ** TODO Pay the rent | |
4711 DEADLINE: <2005-10-01 Sat +1m> | |
4712 @end example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4713 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
|
4714 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
|
4715 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
|
4716 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
|
4717 warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}. |
84308 | 4718 |
4719 Deadlines and scheduled items produce entries in the agenda when they | |
4720 are over-due, so it is important to be able to mark such an entry as | |
4721 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
|
4722 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
|
4723 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
|
4724 @emph{next} instance of the repeated entry will not be active. Org mode |
84308 | 4725 deals with this in the following way: When you try to mark such an entry |
4726 DONE (using @kbd{C-c C-t}), it will shift the base date of the repeating | |
4727 time stamp by the repeater interval, and immediately set the entry state | |
4728 back to TODO. In the example above, setting the state to DONE would | |
4729 actually switch the date like this: | |
4730 | |
4731 @example | |
4732 ** TODO Pay the rent | |
4733 DEADLINE: <2005-11-01 Tue +1m> | |
4734 @end example | |
4735 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4736 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
|
4737 @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
|
4738 @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
|
4739 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
|
4740 a record that you actually acted on the previous instance of this deadline. |
84308 | 4741 |
4742 As a consequence of shifting the base date, this entry will no longer be | |
4743 visible in the agenda when checking past dates, but all future instances | |
4744 will be visible. | |
4745 | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4746 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
|
4747 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
|
4748 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
|
4749 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
|
4750 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
|
4751 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
|
4752 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
|
4753 @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
|
4754 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
|
4755 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4756 @example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4757 ** TODO Call Father |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4758 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
|
4759 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
|
4760 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
|
4761 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
|
4762 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
|
4763 ** 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
|
4764 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
|
4765 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
|
4766 today. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4767 @end example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4768 |
84308 | 4769 You may have both scheduling and deadline information for a specific |
4770 task - just make sure that the repeater intervals on both are the same. | |
4771 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4772 @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
|
4773 @section Clocking work time |
84308 | 4774 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4775 Org mode allows you to clock the time you spent on specific tasks in a |
84308 | 4776 project. When you start working on an item, you can start the clock. |
4777 When you stop working on that task, or when you mark the task done, the | |
4778 clock is stopped and the corresponding time interval is recorded. It | |
4779 also computes the total time spent on each subtree of a project. | |
4780 | |
4781 @table @kbd | |
4782 @kindex C-c C-x C-i | |
4783 @item C-c C-x C-i | |
4784 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
|
4785 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
|
4786 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
|
4787 @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
|
4788 @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
|
4789 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
|
4790 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
|
4791 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
|
4792 with letter @kbd{d}. |
84308 | 4793 @kindex C-c C-x C-o |
4794 @item C-c C-x C-o | |
4795 Stop the clock (clock-out). The inserts another timestamp at the same | |
4796 location where the clock was last started. It also directly computes | |
4797 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
|
4798 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
|
4799 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
|
4800 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
|
4801 @code{#+STARTUP: lognoteclock-out}}. |
84308 | 4802 @kindex C-c C-y |
4803 @item C-c C-y | |
4804 Recompute the time interval after changing one of the time stamps. This | |
4805 is only necessary if you edit the time stamps directly. If you change | |
4806 them with @kbd{S-@key{cursor}} keys, the update is automatic. | |
4807 @kindex C-c C-t | |
4808 @item C-c C-t | |
4809 Changing the TODO state of an item to DONE automatically stops the clock | |
4810 if it is running in this same item. | |
4811 @kindex C-c C-x C-x | |
4812 @item C-c C-x C-x | |
4813 Cancel the current clock. This is useful if a clock was started by | |
4814 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
|
4815 @kindex C-c C-x C-j |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4816 @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
|
4817 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
|
4818 @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
|
4819 tasks. |
84308 | 4820 @kindex C-c C-x C-d |
4821 @item C-c C-x C-d | |
4822 Display time summaries for each subtree in the current buffer. This | |
4823 puts overlays at the end of each headline, showing the total time | |
4824 recorded under that heading, including the time of any subheadings. You | |
4825 can use visibility cycling to study the tree, but the overlays disappear | |
4826 when you change the buffer (see variable | |
4827 @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}. | |
4828 @kindex C-c C-x C-r | |
4829 @item C-c C-x C-r | |
4830 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
|
4831 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
|
4832 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
|
4833 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
|
4834 update it. |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4835 @cindex #+BEGIN: clocktable |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4836 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4837 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file |
84308 | 4838 #+END: clocktable |
4839 @end example | |
4840 @noindent | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4841 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
|
4842 new table. The @samp{BEGIN} line can specify options: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4843 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4844 :maxlevel @r{Maximum level depth to which times are listed in the table.} |
84308 | 4845 :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
|
4846 :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
|
4847 nil @r{the current buffer or narrowed region} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4848 file @r{the full current buffer} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4849 subtree @r{the subtree where the clocktable is located} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4850 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
|
4851 tree @r{the surrounding level 1 tree} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4852 agenda @r{all agenda files} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4853 ("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
|
4854 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
|
4855 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
|
4856 :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
|
4857 @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
|
4858 @r{these formats:} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4859 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
|
4860 2007-12 @r{December 2007} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4861 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
|
4862 2007 @r{the year 2007} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4863 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
|
4864 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
|
4865 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
|
4866 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
|
4867 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.} |
84308 | 4868 :tstart @r{A time string specifying when to start considering times} |
4869 :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
|
4870 :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
|
4871 @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
|
4872 :link @r{Link the item headlines in the table to their origins} |
99503
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
4873 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.} |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
4874 @r{As a special case, @samp{:formula %} adds column with % time.} |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
4875 @r{If you do not specify a formula here, any existing formula} |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
4876 @r{below the clock table will survive updates and be evaluated.} |
84308 | 4877 @end example |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4878 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
|
4879 day, you could write |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4880 @example |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4881 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t |
84308 | 4882 #+END: clocktable |
4883 @end example | |
4884 and to use a specific time range you could write@footnote{Note that all | |
4885 parameters must be specified in a single line - the line is broken here | |
4886 only to fit it onto the manual.} | |
4887 @example | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4888 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>" |
84308 | 4889 :tend "<2006-08-10 Thu 12:00>" |
4890 #+END: clocktable | |
4891 @end example | |
99503
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
4892 A summary of the current subtree with % times would be |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
4893 @example |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
4894 #+BEGIN: clocktable :scope subtree :link t :formula % |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
4895 #+END: clocktable |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
4896 @end example |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4897 @kindex C-c C-c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4898 @item C-c C-c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4899 @kindex C-c C-x C-u |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4900 @itemx C-c C-x C-u |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4901 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
|
4902 @code{#+BEGIN} line of the dynamic block. |
84308 | 4903 @kindex C-u C-c C-x C-u |
4904 @item C-u C-c C-x C-u | |
4905 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
|
4906 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
|
4907 @kindex S-@key{left} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4908 @kindex S-@key{right} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4909 @item S-@key{left} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4910 @itemx S-@key{right} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4911 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
|
4912 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
|
4913 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc. |
84308 | 4914 @end table |
4915 | |
4916 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
|
4917 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been |
84308 | 4918 worked on or closed during a day. |
4919 | |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4920 @node Effort estimates, Relative timer, Clocking work time, Dates and Times |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4921 @section Effort estimates |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4922 @cindex effort estimates |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4923 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4924 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
|
4925 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
|
4926 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
|
4927 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
|
4928 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
|
4929 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
|
4930 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
|
4931 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
|
4932 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
|
4933 @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
|
4934 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
|
4935 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4936 @example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4937 #+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
|
4938 #+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
|
4939 @end example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4940 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4941 @noindent |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
4942 or, even better, you can set up these values globally by customizing the |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
4943 variables @code{org-global-properties} and @code{org-columns-default-format}. |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
4944 In particular if you want to use this setup also in the agenda, a global |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
4945 setup may be advised. |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4946 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4947 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
|
4948 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
|
4949 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
|
4950 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
|
4951 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4952 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
|
4953 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
|
4954 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4955 column view}).}, and you can use this to find space in your schedule. To get |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4956 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
|
4957 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
|
4958 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
|
4959 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
|
4960 |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
4961 Effort estimates can be used in secondary agenda filtering that is triggered |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
4962 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
4963 these estimates defined consistently, two or three key presses will narrow |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
4964 down the list to stuff that fits into an available time slot. |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
4965 |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4966 @node Relative timer, , Effort estimates, Dates and Times |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4967 @section Taking notes with a relative timer |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4968 @cindex relative timer |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4969 |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4970 When taking notes during, for example, a meeting or a video viewing, it can |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4971 be useful to have access to times relative to a starting time. Org provides |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4972 such a relative timer and make it easy to create timed notes. |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4973 |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4974 @table @kbd |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4975 @kindex C-c C-x . |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4976 @item C-c C-x . |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4977 Insert a relative time into the buffer. The first time you use this, the |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4978 timer will be started. When called with a prefix argument, the timer is |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4979 restarted. |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4980 @kindex C-c C-x - |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4981 @item C-c C-x - |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4982 Insert a description list item with the current relative time. With a prefix |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4983 argument, first reset the timer to 0. |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4984 @kindex M-@key{RET} |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4985 @item M-@key{RET} |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4986 One the timer list is started, you can also use @kbd{M-@key{RET}} to insert |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4987 new timer items. |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4988 @kindex C-c C-x 0 |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4989 @item C-c C-x 0 |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4990 Reset the timer without inserting anything into the buffer. By default, the |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4991 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4992 specific starting offset. The user is prompted for the offset, with a |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4993 default taken from a timer string at point, if any, So this can be used to |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4994 restart taking notes after a break in the process. When called with a double |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4995 prefix argument @kbd{C-c C-u}, change all timer strings in the active region |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4996 by a certain amount. This can be used to fix timer strings if the timer was |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4997 not started at exactly the right moment. |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4998 @end table |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
4999 |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5000 @node Capture, Agenda Views, Dates and Times, Top |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5001 @chapter Capture |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5002 @cindex capture |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5003 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5004 An important part of any organization system is the ability to quickly |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5005 capture new ideas and tasks, and to associate reference material with them. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5006 Org uses the @file{remember} package to create tasks, and stores files |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5007 related to a task (@i{attachments}) in a special directory. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5008 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5009 @menu |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5010 * Remember:: Capture new tasks/ideas with little interruption |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5011 * Attachments:: Add files to tasks. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5012 @end menu |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5013 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5014 @node Remember, Attachments, Capture, Capture |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5015 @section Remember |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5016 @cindex @file{remember.el} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5017 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5018 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
|
5019 little interruption of your work flow. See |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5020 @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
|
5021 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
|
5022 Org files. Org significantly expands the possibilities of |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5023 @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
|
5024 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
|
5025 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
|
5026 interactively, on the fly. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5027 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5028 @menu |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5029 * 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
|
5030 * Remember templates:: Define the outline of different note types |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5031 * 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
|
5032 * 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
|
5033 @end menu |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5034 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5035 @node Setting up Remember, Remember templates, Remember, Remember |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5036 @subsection Setting up Remember |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5037 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5038 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
|
5039 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
|
5040 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5041 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5042 (org-remember-insinuate) |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5043 (setq org-directory "~/path/to/my/orgfiles/") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5044 (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
|
5045 (define-key global-map "\C-cr" 'org-remember) |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5046 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5047 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5048 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
|
5049 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
|
5050 suggestion.}. @code{org-remember} basically just calls @code{remember}, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5051 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
|
5052 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
|
5053 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
|
5054 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
|
5055 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
|
5056 remember note was stored. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5057 |
99851
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
5058 The remember buffer will actually use @code{org-mode} as its major mode, so |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
5059 that all editing features of Org-mode are available. In addition to this, a |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
5060 minor mode @code{org-remember-mode} is turned on, for the single purpose that |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
5061 you can use its keymap @code{org-remember-mode-map} to overwrite some of |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
5062 Org-mode's key bindings. |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
5063 |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5064 You can also call @code{org-remember} in a special way from the agenda, |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5065 using the @kbd{k r} key combination. With this access, any time stamps |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5066 inserted by the selected remember template (see below) will default to |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5067 the cursor date in the agenda, rather than to the current date. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5068 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5069 @node Remember templates, Storing notes, Setting up Remember, Remember |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5070 @subsection Remember templates |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5071 @cindex templates, for remember |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5072 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5073 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
|
5074 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
|
5075 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
|
5076 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
|
5077 use: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5078 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5079 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5080 (setq org-remember-templates |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5081 '(("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
|
5082 ("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
|
5083 ("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
|
5084 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5085 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5086 @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
|
5087 character specifies how to select the template. It is useful if the |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5088 character is also the first letter of the name. The next string specifies |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5089 the template. Two more (optional) strings give the file in which, and the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5090 headline under which the new note should be stored. The file (if not present |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5091 or @code{nil}) defaults to @code{org-default-notes-file}, the heading to |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5092 @code{org-remember-default-headline}. If the file name is not an absolute |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5093 path, it will be interpreted relative to @code{org-directory}. The heading |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5094 can also be the symbols @code{top} or @code{bottom} to send note as level 1 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5095 entries to the beginning or end of the file, respectively. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5096 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5097 An optional sixth element specifies the contexts in which the user can select |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5098 the template. This element can be a list of major modes or a function. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5099 @code{org-remember} will first check whether the function returns @code{t} or |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5100 if we are in any of the listed major mode, and exclude templates fo which |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5101 this condition is not fulfilled. Templates that do not specify this element |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5102 at all, or that use @code{nil} or @code{t} as a value will always be |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5103 selectable. |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5104 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5105 So for example: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5106 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5107 @example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5108 (setq org-remember-templates |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5109 '(("Bug" ?b "* BUG %?\n %i\n %a" "~/org/BUGS.org" "Bugs" (emacs-lisp-mode)) |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5110 ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org" "X" my-check) |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5111 ("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
|
5112 @end example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5113 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5114 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
|
5115 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
|
5116 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
|
5117 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
|
5118 |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5119 When you call @kbd{M-x org-remember} (or @kbd{M-x remember}) to remember |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5120 something, Org will prompt for a key to select the template (if you have |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5121 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
|
5122 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5123 * TODO |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5124 [[file:link to where you called remember]] |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5125 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5126 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5127 @noindent |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5128 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
|
5129 insertion of content: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5130 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5131 %^@{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
|
5132 @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
|
5133 @r{%^@{prompt|default|completion2|completion3...@}} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5134 @r{The arrow keys access a prompt-specific history.} |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5135 %a @r{annotation, normally the link created with @code{org-store-link}} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5136 %A @r{like @code{%a}, but prompt for the description part} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5137 %i @r{initial content, the region when remember is called with C-u.} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5138 @r{The entire text will be indented like @code{%i} itself.} |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5139 %t @r{time stamp, date only} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5140 %T @r{time stamp with date and time} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5141 %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
|
5142 %^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
|
5143 @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
|
5144 %n @r{user name (taken from @code{user-full-name})} |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5145 %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
|
5146 %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
|
5147 %^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
|
5148 %^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
|
5149 %^g @r{prompt for tags, with completion on tags in target file.} |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5150 %k @r{title of currently clocked task} |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5151 %K @r{link to currently clocked task} |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5152 %^G @r{prompt for tags, with completion all tags in all agenda files.} |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5153 %^@{prop@}p @r{Prompt the user for a value for property @code{prop}} |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5154 %: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
|
5155 %[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
|
5156 %(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
|
5157 %! @r{immediately store note after completing the template} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5158 @r{(skipping the @kbd{C-c C-c} that normally triggers storing)} |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5159 %& @r{jump to target location immediately after storing note} |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5160 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5161 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5162 @noindent |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5163 For specific link types, the following keywords will be |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5164 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
|
5165 hyperlink types}), any property you store with |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5166 @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
|
5167 similar way.}: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5168 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5169 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5170 Link type | Available keywords |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5171 -------------------+---------------------------------------------- |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5172 bbdb | %:name %:company |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5173 bbdb | %::server %:port %:nick |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5174 vm, wl, mh, rmail | %:type %:subject %:message-id |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5175 | %:from %:fromname %:fromaddress |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5176 | %:to %:toname %:toaddress |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5177 | %: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
|
5178 gnus | %:group, @r{for messages also all email fields} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5179 w3, w3m | %:url |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5180 info | %:file %:node |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5181 calendar | %:date" |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5182 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5183 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5184 @noindent |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5185 To place the cursor after template expansion use: |
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 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5188 %? @r{After completing the template, position cursor here.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5189 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5190 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5191 @noindent |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5192 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
|
5193 @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
|
5194 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
|
5195 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5196 @node Storing notes, Refiling notes, Remember templates, Remember |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5197 @subsection Storing notes |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5198 |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5199 When you are finished preparing a note with @i{remember}, you have to press |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5200 @kbd{C-c C-c} to file the note away. If you have started the clock in the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5201 remember buffer, you will first be asked if you want to clock out |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5202 now@footnote{To avoid this query, configure the variable |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5203 @code{org-remember-clock-out-on-exit}.}. If you answer @kbd{n}, the clock |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
5204 will continue to run after the note was filed away. |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5205 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5206 The handler will then store the note in the file and under the headline |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5207 specified in the template, or it will use the default file and headlines. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5208 The window configuration will be restored, sending you back to the working |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5209 context before the call to @code{remember}. To re-use the location found |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5210 during the last call to @code{remember}, exit the remember buffer with |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5211 @kbd{C-0 C-c C-c}, i.e. specify a zero prefix argument to @kbd{C-c C-c}. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5212 Another special case is @kbd{C-2 C-c C-c} which files the note as a child of |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5213 the currently clocked item. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5214 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5215 If you want to store the note directly to a different place, use |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5216 @kbd{C-1 C-c C-c} instead to exit remember@footnote{Configure the |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5217 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
|
5218 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
|
5219 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
|
5220 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
|
5221 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
|
5222 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
|
5223 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
|
5224 location: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5225 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5226 @key{TAB} @r{Cycle visibility.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5227 @key{down} / @key{up} @r{Next/previous visible headline.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5228 n / p @r{Next/previous visible headline.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5229 f / b @r{Next/previous headline same level.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5230 u @r{One level up.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5231 @c 0-9 @r{Digit argument.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5232 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5233 @noindent |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5234 Pressing @key{RET} or @key{left} or @key{right} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5235 then leads to the following result. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5236 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5237 @multitable @columnfractions 0.2 0.15 0.65 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5238 @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
|
5239 @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
|
5240 @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
|
5241 @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
|
5242 @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
|
5243 @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
|
5244 @item not on headline @tab @key{RET} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5245 @tab at cursor position, level taken from context. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5246 @end multitable |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5247 |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5248 Before inserting the text into a tree, the function ensures that the text has |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5249 a headline, i.e. a first line that starts with a @samp{*}. If not, a |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5250 headline is constructed from the current date. If you have indented the text |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5251 of the note below the headline, the indentation will be adapted if inserting |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5252 the note into the tree requires demotion from level 1. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5253 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5254 @node Refiling notes, , Storing notes, Remember |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5255 @subsection Refiling notes |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5256 @cindex refiling notes |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5257 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5258 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
|
5259 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
|
5260 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
|
5261 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
|
5262 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
|
5263 special command: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5264 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5265 @table @kbd |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5266 @kindex C-c C-w |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5267 @item C-c C-w |
99503
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
5268 Refile the entry or region at point. This command offers possible locations |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
5269 for refiling the entry and lets you select one with completion. The item (or |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
5270 all items in the region) is filed below the target heading as a subitem. |
99868
404f28130174
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
99851
diff
changeset
|
5271 Depending on @code{org-reverse-note-order}, it will be either the first or |
99503
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
5272 last subitem.@* |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
5273 By default, all level 1 headlines in the current buffer are considered to be |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
5274 targets, but you can have more complex definitions across a number of files. |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
5275 See the variable @code{org-refile-targets} for details. If you would like to |
99868
404f28130174
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
99851
diff
changeset
|
5276 select a location via a file-path-like completion along the outline path, see |
404f28130174
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
99851
diff
changeset
|
5277 the variables @code{org-refile-use-outline-path} and |
404f28130174
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
99851
diff
changeset
|
5278 @code{org-outline-path-complete-in-steps}. |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5279 @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
|
5280 @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
|
5281 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
|
5282 @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
|
5283 @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
|
5284 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
|
5285 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5286 |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5287 @node Attachments, , Remember, Capture |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5288 @section Attachments |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5289 @cindex attachments |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5290 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5291 It is often useful to associate reference material with an outline node/task. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5292 Small chunks of plain text can simply be stored in the subtree of a project. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5293 Hyperlinks (@pxref{Hyperlinks}) can be used to establish associations with |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5294 files that live elsewhere on your computer or in the cloud, like emails or |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5295 source code files belonging to a project. Another method is @i{attachments}, |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5296 which are files located in a directory belonging to an outline node. Org |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5297 uses directories named by the unique ID of each entry. These directories are |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5298 located in the @file{data} directory which lives in the same directory where |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5299 your org-file lives@footnote{If you move entries or Org-files from one |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5300 directory to the next, you may want to configure @code{org-attach-directory} |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5301 to contain an absolute path.}. If you initialize this directory with |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5302 @code{git-init}, Org will automatically commit changes when it sees them. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5303 The attachment system has been contributed to Org by John Wiegley. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5304 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5305 @noindent The following commands deal with attachments. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5306 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5307 @table @kbd |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5308 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5309 @kindex C-c C-a |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5310 @item C-c C-a |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5311 The dispatcher for commands related to the attachment system. After these |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5312 keys, a list of commands is displayed and you need to press an additional key |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5313 to select a command: |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5314 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5315 @table @kbd |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
5316 @kindex C-c C-a a |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
5317 @item a |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5318 Select a file and move it into the task's attachment directory. The file |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5319 will be copied, moved, or linked, depending on @code{org-attach-method}. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5320 Note that hard links are not supported on all systems. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5321 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5322 @kindex C-c C-a c |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
5323 @kindex C-c C-a m |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
5324 @kindex C-c C-a l |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5325 @item c/m/l |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5326 Attach a file using the copy/move/link method. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5327 Note that hard links are not supported on all systems. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5328 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5329 @kindex C-c C-a n |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5330 @item n |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5331 Create a new attachment as an Emacs buffer. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5332 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5333 @kindex C-c C-a z |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5334 @item z |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5335 Synchronize the current task with its attachment directory, in case you added |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5336 attachments yourself. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5337 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5338 @kindex C-c C-a o |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5339 @item o |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5340 Open current task's attachment. If there are more than one, prompt for a |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5341 file name first. Opening will follow the rules set by @code{org-file-apps}. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5342 For more details, see the information on following hyperlings |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5343 (@pxref{Handling links}). |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5344 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5345 @kindex C-c C-a O |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5346 @item O |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5347 Also open the attachment, but force opening the file in Emacs. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5348 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5349 @kindex C-c C-a f |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5350 @item f |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5351 Open the current task's attachment directory. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5352 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5353 @kindex C-c C-a F |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5354 @item F |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5355 Also open the directory, but force using @code{dired} in Emacs. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5356 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5357 @kindex C-c C-a d |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5358 @item d |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5359 Select and delete a single attachment. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5360 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5361 @kindex C-c C-a D |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5362 @item D |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5363 Delete all of a task's attachments. A safer way is to open the directory in |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5364 dired and delete from there. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5365 @end table |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5366 @end table |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5367 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5368 @node Agenda Views, Embedded LaTeX, Capture, Top |
84308 | 5369 @chapter Agenda Views |
5370 @cindex agenda views | |
5371 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5372 Due to the way Org works, TODO items, time-stamped items, and |
84308 | 5373 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
|
5374 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
|
5375 important for a particular date, this information must be collected, |
84308 | 5376 sorted and displayed in an organized way. |
5377 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5378 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
|
5379 in a separate buffer. Seven different view types are provided: |
84308 | 5380 |
5381 @itemize @bullet | |
5382 @item | |
5383 an @emph{agenda} that is like a calendar and shows information | |
5384 for specific dates, | |
5385 @item | |
5386 a @emph{TODO list} that covers all unfinished | |
5387 action items, | |
5388 @item | |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5389 a @emph{match view}, showings headlines based on the tags, properties and |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5390 TODO state associated with them, |
84308 | 5391 @item |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5392 a @emph{timeline view} that shows all events in a single Org file, |
84308 | 5393 in time-sorted view, |
5394 @item | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5395 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
|
5396 that contain specified keywords. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5397 @item |
84308 | 5398 a @emph{stuck projects view} showing projects that currently don't move |
5399 along, and | |
5400 @item | |
5401 @emph{custom views} that are special tag/keyword searches and | |
5402 combinations of different views. | |
5403 @end itemize | |
5404 | |
5405 @noindent | |
5406 The extracted information is displayed in a special @emph{agenda | |
5407 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
|
5408 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
|
5409 edit these files remotely. |
84308 | 5410 |
5411 Two variables control how the agenda buffer is displayed and whether the | |
5412 window configuration is restored when the agenda exits: | |
5413 @code{org-agenda-window-setup} and | |
5414 @code{org-agenda-restore-windows-after-quit}. | |
5415 | |
5416 @menu | |
5417 * Agenda files:: Files being searched for agenda information | |
5418 * Agenda dispatcher:: Keyboard access to agenda views | |
5419 * Built-in agenda views:: What is available out of the box? | |
5420 * 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
|
5421 * Agenda commands:: Remote editing of Org trees |
84308 | 5422 * 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
|
5423 * Agenda column view:: Using column view for collected entries |
84308 | 5424 @end menu |
5425 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5426 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views |
84308 | 5427 @section Agenda files |
5428 @cindex agenda files | |
5429 @cindex files for agenda | |
5430 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5431 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
|
5432 files}, the files listed in the variable |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5433 @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
|
5434 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
|
5435 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
|
5436 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
|
5437 of the list. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5438 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5439 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
|
5440 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
|
5441 @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
|
5442 the current file, and ignore @code{org-agenda-files} until the next |
84308 | 5443 dispatcher command.}. You can customize @code{org-agenda-files}, but |
5444 the easiest way to maintain it is through the following commands | |
5445 | |
5446 @cindex files, adding to agenda list | |
5447 @table @kbd | |
5448 @kindex C-c [ | |
5449 @item C-c [ | |
5450 Add current file to the list of agenda files. The file is added to | |
5451 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
|
5452 the front. With a prefix argument, file is added/moved to the end. |
84308 | 5453 @kindex C-c ] |
5454 @item C-c ] | |
5455 Remove current file from the list of agenda files. | |
5456 @kindex C-, | |
5457 @kindex C-' | |
5458 @item C-, | |
5459 @itemx C-' | |
5460 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
|
5461 @kindex M-x org-iswitchb |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5462 @item M-x org-iswitchb |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5463 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
|
5464 buffers. |
84308 | 5465 @end table |
5466 | |
5467 @noindent | |
5468 The Org menu contains the current list of files and can be used | |
5469 to visit any of them. | |
5470 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5471 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
|
5472 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
|
5473 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
|
5474 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
|
5475 (@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
|
5476 extended period, use the following commands: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5477 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5478 @table @kbd |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5479 @kindex C-c C-x < |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5480 @item C-c C-x < |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5481 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
|
5482 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
|
5483 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
|
5484 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
|
5485 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
|
5486 agenda view, the new restriction takes effect immediately. |
100450
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
5487 @kindex C-c C-x > |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
5488 @item C-c C-x > |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5489 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
|
5490 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5491 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5492 @noindent |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5493 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
|
5494 the Speedbar frame: |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5495 @table @kbd |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5496 @kindex < |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5497 @item < @r{in the speedbar frame} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5498 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
|
5499 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
|
5500 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
|
5501 effect immediately. |
100450
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
5502 @kindex > |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5503 @item > @r{in the speedbar frame} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5504 Lift the restriction again. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5505 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5506 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5507 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views |
84308 | 5508 @section The agenda dispatcher |
5509 @cindex agenda dispatcher | |
5510 @cindex dispatching agenda commands | |
5511 The views are created through a dispatcher that should be bound to a | |
5512 global key, for example @kbd{C-c a} (@pxref{Installation}). In the | |
5513 following we will assume that @kbd{C-c a} is indeed how the dispatcher | |
5514 is accessed and list keyboard access to commands accordingly. After | |
5515 pressing @kbd{C-c a}, an additional letter is required to execute a | |
5516 command. The dispatcher offers the following default commands: | |
5517 @table @kbd | |
5518 @item a | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5519 Create the calendar-like agenda (@pxref{Weekly/daily agenda}). |
84308 | 5520 @item t @r{/} T |
5521 Create a list of all TODO items (@pxref{Global TODO list}). | |
5522 @item m @r{/} M | |
5523 Create a list of headlines matching a TAGS expression (@pxref{Matching | |
5524 tags and properties}). | |
5525 @item L | |
5526 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
|
5527 @item s |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5528 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
|
5529 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
|
5530 @item / |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5531 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
|
5532 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
|
5533 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
|
5534 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
|
5535 1. |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5536 @item # @r{/} ! |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5537 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
|
5538 @item < |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5539 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
|
5540 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
|
5541 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
|
5542 selecting the command. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5543 @item < < |
84308 | 5544 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
|
5545 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
|
5546 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
|
5547 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
|
5548 character selecting the command. |
84308 | 5549 @end table |
5550 | |
5551 You can also define custom commands that will be accessible through the | |
5552 dispatcher, just like the default commands. This includes the | |
5553 possibility to create extended agenda buffers that contain several | |
5554 blocks together, for example the weekly agenda, the global TODO list and | |
5555 a number of special tags matches. @xref{Custom agenda views}. | |
5556 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5557 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views |
84308 | 5558 @section The built-in agenda views |
5559 | |
5560 In this section we describe the built-in views. | |
5561 | |
5562 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5563 * Weekly/daily agenda:: The calendar page with current tasks |
84308 | 5564 * Global TODO list:: All unfinished action items |
5565 * Matching tags and properties:: Structured information with fine-tuned search | |
5566 * 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
|
5567 * Keyword search:: Finding entries by keyword |
84308 | 5568 * Stuck projects:: Find projects you need to review |
5569 @end menu | |
5570 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5571 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views |
84308 | 5572 @subsection The weekly/daily agenda |
5573 @cindex agenda | |
5574 @cindex weekly agenda | |
5575 @cindex daily agenda | |
5576 | |
5577 The purpose of the weekly/daily @emph{agenda} is to act like a page of a | |
5578 paper agenda, showing all the tasks for the current week or day. | |
5579 | |
5580 @table @kbd | |
5581 @cindex org-agenda, command | |
5582 @kindex C-c a a | |
5583 @item C-c a a | |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5584 Compile an agenda for the current week from a list of org files. The agenda |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5585 shows the entries for each day. With a numeric prefix@footnote{For backward |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5586 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5587 listed before the agenda. This feature is deprecated, use the dedicated TODO |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5588 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5589 C-c a a}) you may set the number of days to be displayed (see also the |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5590 variable @code{org-agenda-ndays}) |
84308 | 5591 @end table |
5592 | |
5593 Remote editing from the agenda buffer means, for example, that you can | |
5594 change the dates of deadlines and appointments from the agenda buffer. | |
5595 The commands available in the Agenda buffer are listed in @ref{Agenda | |
5596 commands}. | |
5597 | |
5598 @subsubheading Calendar/Diary integration | |
5599 @cindex calendar integration | |
5600 @cindex diary integration | |
5601 | |
5602 Emacs contains the calendar and diary by Edward M. Reingold. The | |
5603 calendar displays a three-month calendar with holidays from different | |
5604 countries and cultures. The diary allows you to keep track of | |
5605 anniversaries, lunar phases, sunrise/set, recurrent appointments | |
5606 (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
|
5607 Org. It can be very useful to combine output from Org with |
84308 | 5608 the diary. |
5609 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5610 In order to include entries from the Emacs diary into Org mode's |
84308 | 5611 agenda, you only need to customize the variable |
5612 | |
5613 @lisp | |
5614 (setq org-agenda-include-diary t) | |
5615 @end lisp | |
5616 | |
5617 @noindent After that, everything will happen automatically. All diary | |
5618 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
|
5619 agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and |
84308 | 5620 @key{RET} can be used from the agenda buffer to jump to the diary |
5621 file in order to edit existing diary entries. The @kbd{i} command to | |
5622 insert new entries for the current date works in the agenda buffer, as | |
5623 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display | |
5624 Sunrise/Sunset times, show lunar phases and to convert to other | |
5625 calendars, respectively. @kbd{c} can be used to switch back and forth | |
5626 between calendar and agenda. | |
5627 | |
5628 If you are using the diary only for sexp entries and holidays, it is | |
5629 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
|
5630 the entries into an Org file. Org mode evaluates diary-style sexp |
84308 | 5631 entries, and does it faster because there is no overhead for first |
5632 creating the diary display. Note that the sexp entries must start at | |
5633 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
|
5634 the following segment of an Org file will be processed and entries |
84308 | 5635 will be made in the agenda: |
5636 | |
5637 @example | |
5638 * Birthdays and similar stuff | |
5639 #+CATEGORY: Holiday | |
5640 %%(org-calendar-holiday) ; special function for holiday names | |
5641 #+CATEGORY: Ann | |
5642 %%(diary-anniversary 14 5 1956) Arthur Dent is %d years old | |
5643 %%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old | |
5644 @end example | |
5645 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5646 @subsubheading Appointment reminders |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5647 @cindex @file{appt.el} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5648 @cindex appointment reminders |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5649 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5650 Org can interact with Emacs appointments notification facility. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5651 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5652 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
|
5653 @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
|
5654 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
|
5655 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
|
5656 details. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5657 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5658 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views |
84308 | 5659 @subsection The global TODO list |
5660 @cindex global TODO list | |
5661 @cindex TODO list, global | |
5662 | |
5663 The global TODO list contains all unfinished TODO items, formatted and | |
5664 collected into a single place. | |
5665 | |
5666 @table @kbd | |
5667 @kindex C-c a t | |
5668 @item C-c a t | |
5669 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
|
5670 agenda files (@pxref{Agenda Views}) into a single buffer. The buffer is in |
84308 | 5671 @code{agenda-mode}, so there are commands to examine and manipulate |
5672 the TODO entries directly from that buffer (@pxref{Agenda commands}). | |
5673 @kindex C-c a T | |
5674 @item C-c a T | |
5675 @cindex TODO keyword matching | |
5676 Like the above, but allows selection of a specific TODO keyword. You | |
5677 can also do this by specifying a prefix argument to @kbd{C-c a t}. With | |
5678 a @kbd{C-u} prefix you are prompted for a keyword, and you may also | |
5679 specify several keywords by separating them with @samp{|} as boolean OR | |
5680 operator. With a numeric prefix, the Nth keyword in | |
5681 @code{org-todo-keywords} is selected. | |
5682 @kindex r | |
5683 The @kbd{r} key in the agenda buffer regenerates it, and you can give | |
5684 a prefix argument to this command to change the selected TODO keyword, | |
5685 for example @kbd{3 r}. If you often need a search for a specific | |
5686 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@* | |
5687 Matching specific TODO keywords can also be done as part of a tags | |
5688 search (@pxref{Tag searches}). | |
5689 @end table | |
5690 | |
5691 Remote editing of TODO items means that you can change the state of a | |
5692 TODO entry with a single key press. The commands available in the | |
5693 TODO list are described in @ref{Agenda commands}. | |
5694 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5695 @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
|
5696 Normally the global TODO list simply shows all headlines with TODO |
84308 | 5697 keywords. This list can become very long. There are two ways to keep |
5698 it more compact: | |
5699 @itemize @minus | |
5700 @item | |
5701 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
|
5702 execution (@pxref{Timestamps}) as no longer @emph{open}. Configure the |
84308 | 5703 variable @code{org-agenda-todo-ignore-scheduled} to exclude scheduled |
5704 items from the global TODO list. | |
5705 @item | |
5706 TODO items may have sublevels to break up the task into subtasks. In | |
5707 such cases it may be enough to list only the highest level TODO headline | |
5708 and omit the sublevels from the global list. Configure the variable | |
5709 @code{org-agenda-todo-list-sublevels} to get this behavior. | |
5710 @end itemize | |
5711 | |
5712 @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
|
5713 @subsection Matching tags and properties |
84308 | 5714 @cindex matching, of tags |
5715 @cindex matching, of properties | |
5716 @cindex tags view | |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5717 @cindex match view |
84308 | 5718 |
5719 If headlines in the agenda files are marked with @emph{tags} | |
5720 (@pxref{Tags}), you can select headlines based on the tags that apply | |
5721 to them and collect them into an agenda buffer. | |
5722 | |
5723 @table @kbd | |
5724 @kindex C-c a m | |
5725 @item C-c a m | |
5726 Produce a list of all headlines that match a given set of tags. The | |
5727 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
|
5728 expression with tags, like @samp{+work+urgent-withboss} or |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5729 @samp{work|home} (@pxref{Tags}). If you often need a specific search, |
84308 | 5730 define a custom command for it (@pxref{Agenda dispatcher}). |
5731 @kindex C-c a M | |
5732 @item C-c a M | |
5733 Like @kbd{C-c a m}, but only select headlines that are also TODO items | |
5734 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
|
5735 @code{org-tags-match-list-sublevels}). Matching specific TODO keywords |
84308 | 5736 together with a tags match is also possible, see @ref{Tag searches}. |
5737 @end table | |
5738 | |
5739 The commands available in the tags list are described in @ref{Agenda | |
5740 commands}. | |
5741 | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5742 @node Timeline, Keyword search, Matching tags and properties, Built-in agenda views |
84308 | 5743 @subsection Timeline for a single file |
5744 @cindex timeline, single file | |
5745 @cindex time-sorted view | |
5746 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5747 The timeline summarizes all time-stamped items from a single Org mode |
84308 | 5748 file in a @emph{time-sorted view}. The main purpose of this command is |
5749 to give an overview over events in a project. | |
5750 | |
5751 @table @kbd | |
5752 @kindex C-c a L | |
5753 @item C-c a L | |
5754 Show a time-sorted view of the org file, with all time-stamped items. | |
5755 When called with a @kbd{C-u} prefix, all unfinished TODO entries | |
5756 (scheduled or not) are also listed under the current date. | |
5757 @end table | |
5758 | |
5759 @noindent | |
5760 The commands available in the timeline buffer are listed in | |
5761 @ref{Agenda commands}. | |
5762 | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5763 @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
|
5764 @subsection Keyword search |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5765 @cindex keyword search |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5766 @cindex searching, for keywords |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5767 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5768 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
|
5769 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
|
5770 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5771 @table @kbd |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5772 @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
|
5773 @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
|
5774 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
|
5775 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
|
5776 string |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5777 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5778 @example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5779 +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
|
5780 @end example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5781 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5782 @noindent |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5783 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
|
5784 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
|
5785 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
|
5786 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
|
5787 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5788 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
|
5789 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
|
5790 @end table |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5791 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5792 @node Stuck projects, , Keyword search, Built-in agenda views |
84308 | 5793 @subsection Stuck projects |
5794 | |
5795 If you are following a system like David Allen's GTD to organize your | |
5796 work, one of the ``duties'' you have is a regular review to make sure | |
5797 that all projects move along. A @emph{stuck} project is a project that | |
5798 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
|
5799 Org mode produces. During the review, you need to identify such |
84308 | 5800 projects and define next actions for them. |
5801 | |
5802 @table @kbd | |
5803 @kindex C-c a # | |
5804 @item C-c a # | |
5805 List projects that are stuck. | |
5806 @kindex C-c a ! | |
5807 @item C-c a ! | |
5808 Customize the variable @code{org-stuck-projects} to define what a stuck | |
5809 project is and how to find it. | |
5810 @end table | |
5811 | |
5812 You almost certainly will have to configure this view before it will | |
5813 work for you. The built-in default assumes that all your projects are | |
5814 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
|
5815 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
|
5816 |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5817 Let's assume that you, in your own way of using Org mode, identify |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5818 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
5819 indicate a project that should not be considered yet. Let's further |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5820 assume that the TODO keyword DONE marks finished projects, and that NEXT |
84308 | 5821 and TODO indicate next actions. The tag @@SHOP indicates shopping and |
5822 is a next action even without the NEXT tag. Finally, if the project | |
5823 contains the special word IGNORE anywhere, it should not be listed | |
5824 either. In this case you would start by identifying eligible projects | |
5825 with a tags/todo match @samp{+PROJECT/-MAYBE-DONE}, and then check for | |
5826 TODO, NEXT, @@SHOP, and IGNORE in the subtree to identify projects that | |
5827 are not stuck. The correct customization for this is | |
5828 | |
5829 @lisp | |
5830 (setq org-stuck-projects | |
5831 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP") | |
5832 "\\<IGNORE\\>")) | |
5833 @end lisp | |
5834 | |
5835 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5836 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views |
84308 | 5837 @section Presentation and sorting |
5838 @cindex presentation, of agenda items | |
5839 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5840 Before displaying items in an agenda view, Org mode visually prepares |
84308 | 5841 the items and sorts them. Each item occupies a single line. The line |
5842 starts with a @emph{prefix} that contains the @emph{category} | |
5843 (@pxref{Categories}) of the item and other important information. You can | |
5844 customize the prefix using the option @code{org-agenda-prefix-format}. | |
5845 The prefix is followed by a cleaned-up version of the outline headline | |
5846 associated with the item. | |
5847 | |
5848 @menu | |
5849 * Categories:: Not all tasks are equal | |
5850 * Time-of-day specifications:: How the agenda knows the time | |
5851 * Sorting of agenda items:: The order of things | |
5852 @end menu | |
5853 | |
5854 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting | |
5855 @subsection Categories | |
5856 | |
5857 @cindex category | |
5858 The category is a broad label assigned to each agenda item. By default, | |
5859 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
|
5860 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
|
5861 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
|
5862 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
|
5863 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
|
5864 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
|
5865 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
|
5866 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
|
5867 property.}: |
84308 | 5868 |
5869 @example | |
5870 #+CATEGORY: Thesis | |
5871 @end example | |
5872 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5873 @noindent |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5874 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
|
5875 (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
|
5876 as the value (@pxref{Properties and Columns}). |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5877 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5878 @noindent |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5879 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
|
5880 longer than 10 characters. |
84308 | 5881 |
5882 @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
|
5883 @subsection Time-of-day specifications |
84308 | 5884 @cindex time-of-day specification |
5885 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5886 Org mode checks each agenda item for a time-of-day specification. The |
84308 | 5887 time can be part of the time stamp that triggered inclusion into the |
5888 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time | |
5889 ranges can be specified with two time stamps, like | |
5890 @c | |
5891 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}. | |
5892 | |
5893 In the headline of the entry itself, a time(range) may also appear as | |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
5894 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
|
5895 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time |
84308 | 5896 specifications in diary entries are recognized as well. |
5897 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5898 For agenda display, Org mode extracts the time and displays it in a |
84308 | 5899 standard 24 hour format as part of the prefix. The example times in |
5900 the previous paragraphs would end up in the agenda like this: | |
5901 | |
5902 @example | |
5903 8:30-13:00 Arthur Dent lies in front of the bulldozer | |
5904 12:45...... Ford Prefect arrives and takes Arthur to the pub | |
5905 19:00...... The Vogon reads his poem | |
5906 20:30-22:15 Marwin escorts the Hitchhikers to the bridge | |
5907 @end example | |
5908 | |
5909 @cindex time grid | |
5910 If the agenda is in single-day mode, or for the display of today, the | |
5911 timed entries are embedded in a time grid, like | |
5912 | |
5913 @example | |
5914 8:00...... ------------------ | |
5915 8:30-13:00 Arthur Dent lies in front of the bulldozer | |
5916 10:00...... ------------------ | |
5917 12:00...... ------------------ | |
5918 12:45...... Ford Prefect arrives and takes Arthur to the pub | |
5919 14:00...... ------------------ | |
5920 16:00...... ------------------ | |
5921 18:00...... ------------------ | |
5922 19:00...... The Vogon reads his poem | |
5923 20:00...... ------------------ | |
5924 20:30-22:15 Marwin escorts the Hitchhikers to the bridge | |
5925 @end example | |
5926 | |
5927 The time grid can be turned on and off with the variable | |
5928 @code{org-agenda-use-time-grid}, and can be configured with | |
5929 @code{org-agenda-time-grid}. | |
5930 | |
5931 @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting | |
5932 @subsection Sorting of agenda items | |
5933 @cindex sorting, of agenda items | |
5934 @cindex priorities, of agenda items | |
5935 Before being inserted into a view, the items are sorted. How this is | |
5936 done depends on the type of view. | |
5937 @itemize @bullet | |
5938 @item | |
5939 For the daily/weekly agenda, the items for each day are sorted. The | |
5940 default order is to first collect all items containing an explicit | |
5941 time-of-day specification. These entries will be shown at the beginning | |
5942 of the list, as a @emph{schedule} for the day. After that, items remain | |
5943 grouped in categories, in the sequence given by @code{org-agenda-files}. | |
5944 Within each category, items are sorted by priority (@pxref{Priorities}), | |
5945 which is composed of the base priority (2000 for priority @samp{A}, 1000 | |
5946 for @samp{B}, and 0 for @samp{C}), plus additional increments for | |
5947 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
|
5948 @item |
84308 | 5949 For the TODO list, items remain in the order of categories, but within |
5950 each category, sorting takes place according to priority | |
5951 (@pxref{Priorities}). | |
5952 @item | |
5953 For tags matches, items are not sorted at all, but just appear in the | |
5954 sequence in which they are found in the agenda files. | |
5955 @end itemize | |
5956 | |
5957 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
|
5958 @code{org-agenda-sorting-strategy}, and may also include criteria based on |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
5959 the estimated effort of an entry (@pxref{Effort estimates}). |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5960 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5961 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views |
84308 | 5962 @section Commands in the agenda buffer |
5963 @cindex commands, in agenda buffer | |
5964 | |
5965 Entries in the agenda buffer are linked back to the org file or diary | |
5966 file where they originate. You are not allowed to edit the agenda | |
5967 buffer itself, but commands are provided to show and jump to the | |
5968 original entry location, and to edit the org-files ``remotely'' from | |
5969 the agenda buffer. In this way, all information is stored only once, | |
5970 removing the risk that your agenda and note files may diverge. | |
5971 | |
5972 Some commands can be executed with mouse clicks on agenda lines. For | |
5973 the other commands, the cursor needs to be in the desired line. | |
5974 | |
5975 @table @kbd | |
5976 @tsubheading{Motion} | |
5977 @cindex motion commands in agenda | |
5978 @kindex n | |
5979 @item n | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5980 Next line (same as @key{up} and @kbd{C-p}). |
84308 | 5981 @kindex p |
5982 @item p | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5983 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
|
5984 @tsubheading{View/Go to org file} |
84308 | 5985 @kindex mouse-3 |
5986 @kindex @key{SPC} | |
5987 @item mouse-3 | |
5988 @itemx @key{SPC} | |
5989 Display the original location of the item in another window. | |
100607
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
5990 With prefix arg, make sure that the entire entry is made visible in the |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
5991 outline, not only the heading. |
84308 | 5992 @c |
5993 @kindex L | |
5994 @item L | |
5995 Display original location and recenter that window. | |
5996 @c | |
5997 @kindex mouse-2 | |
5998 @kindex mouse-1 | |
5999 @kindex @key{TAB} | |
6000 @item mouse-2 | |
6001 @itemx mouse-1 | |
6002 @itemx @key{TAB} | |
6003 Go to the original location of the item in another window. Under Emacs | |
6004 22, @kbd{mouse-1} will also works for this. | |
6005 @c | |
6006 @kindex @key{RET} | |
6007 @itemx @key{RET} | |
6008 Go to the original location of the item and delete other windows. | |
6009 @c | |
6010 @kindex f | |
6011 @item f | |
6012 Toggle Follow mode. In Follow mode, as you move the cursor through | |
6013 the agenda buffer, the other window always shows the corresponding | |
6014 location in the org file. The initial setting for this mode in new | |
6015 agenda buffers can be set with the variable | |
6016 @code{org-agenda-start-with-follow-mode}. | |
6017 @c | |
6018 @kindex b | |
6019 @item b | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6020 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
|
6021 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
|
6022 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
|
6023 previously used indirect buffer. |
84308 | 6024 @c |
6025 @kindex l | |
6026 @item l | |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
6027 Toggle Logbook mode. In Logbook mode, entries that where marked DONE while |
99503
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
6028 logging was on (variable @code{org-log-done}) are shown in the agenda, as are |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
6029 entries that have been clocked on that day. You can configure the entry |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
6030 types that should be included in log mode using the variable |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
6031 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
6032 all possible logbook entries, including state changes. When called with two |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
6033 prefix args @kbd{C-u C-u}, show only logging information, nothing else. |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6034 @c |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
6035 @kindex v |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
6036 @item v |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
6037 Toggle Archives mode. In archives mode, trees that are marked are also |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
6038 scanned when producing the agenda. When you call this command with a |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
6039 @kbd{C-u} prefix argument, even all archive files are included. To exit |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
6040 archives mode, press @kbd{v} again. |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
6041 @c |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6042 @kindex R |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6043 @item R |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6044 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
|
6045 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
|
6046 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
|
6047 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
|
6048 @code{org-agenda-start-with-clockreport-mode}. |
84308 | 6049 |
6050 @tsubheading{Change display} | |
6051 @cindex display changing, in agenda | |
6052 @kindex o | |
6053 @item o | |
6054 Delete other windows. | |
6055 @c | |
6056 @kindex d | |
6057 @kindex w | |
6058 @kindex m | |
6059 @kindex y | |
6060 @item d w m y | |
6061 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
|
6062 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
|
6063 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
|
6064 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
|
6065 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
|
6066 @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
|
6067 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
|
6068 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
|
6069 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
|
6070 be mapped to the interval 1938-2037. |
84308 | 6071 @c |
6072 @kindex D | |
6073 @item D | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6074 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}. |
84308 | 6075 @c |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6076 @kindex G |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6077 @item G |
84308 | 6078 Toggle the time grid on and off. See also the variables |
6079 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}. | |
6080 @c | |
6081 @kindex r | |
6082 @item r | |
6083 Recreate the agenda buffer, for example to reflect the changes | |
6084 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
|
6085 S-@key{right}. When the buffer is the global TODO list, a prefix |
84308 | 6086 argument is interpreted to create a selective list for a specific TODO |
6087 keyword. | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6088 @kindex g |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6089 @item g |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6090 Same as @kbd{r}. |
84308 | 6091 @c |
6092 @kindex s | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6093 @kindex C-x C-s |
84308 | 6094 @item s |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6095 @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
|
6096 Save all Org buffers in the current Emacs session. |
84308 | 6097 @c |
6098 @kindex @key{right} | |
6099 @item @key{right} | |
6100 Display the following @code{org-agenda-ndays} days. For example, if | |
6101 the display covers a week, switch to the following week. With prefix | |
6102 arg, go forward that many times @code{org-agenda-ndays} days. | |
6103 @c | |
6104 @kindex @key{left} | |
6105 @item @key{left} | |
6106 Display the previous dates. | |
6107 @c | |
6108 @kindex . | |
6109 @item . | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6110 Go to today. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6111 @c |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6112 @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
|
6113 @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
|
6114 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
|
6115 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
|
6116 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
|
6117 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
|
6118 @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
|
6119 @code{org-columns-default-format}), will be used in the agenda. |
84308 | 6120 |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
6121 @tsubheading{Secondary filtering and query editing} |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6122 @cindex filtering, by tag and effort, in agenda |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6123 @cindex tag filtering, in agenda |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6124 @cindex effort filtering, in agenda |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6125 @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
|
6126 |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
6127 @kindex / |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
6128 @item / |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6129 Filter the current agenda view with respect to a tag and/or effort estimates. |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6130 The difference between this and a custom agenda commands is that filtering is |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6131 very fast, so that you can switch quickly between different filters without |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6132 having to recreate the agenda. |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6133 |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6134 You will be prompted for a tag selection letter. Pressing @key{TAB} at that |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6135 prompt will offer use completion to select a tag (including any tags that do |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6136 not have a selection character). The command then hides all entries that do |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6137 not contain or inherit this tag. When called with prefix arg, remove the |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6138 entries that @emph{do} have the tag. A second @kbd{/} at the prompt will |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6139 turn off the filter and unhide any hidden entries. If the first key you |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6140 press is either @kbd{+} or @kbd{-}, the previous filter will be narrowed by |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6141 requiring or forbidding the selected additional tag. Instead of pressing |
99851
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
6142 @kbd{+} or @kbd{-} after @kbd{/}, you can also immediately use the @kbd{\} |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
6143 command. |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6144 |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6145 In order to filter for effort estimates, you should set-up allowed |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6146 efforts globally, for example |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6147 @lisp |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6148 (setq org-global-properties |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6149 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00"))) |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6150 @end lisp |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6151 You can then filter for an effort by first typing an operator, one of @kbd{<}, |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6152 @kbd{>}, and @kbd{=}, and then the one-digit index of an effort estimate in |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6153 your array of allowed values, where @kbd{0} means the 10th value. The filter |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6154 will then restrict to entries with effort smaller-or-equal, equal, or |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6155 larger-or-equal than the selected value. If the digits 0-9 are not used as |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6156 fast access keys to tags, you can also simply press the index digit directly |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6157 without an operator. In this case, @kbd{<} will be assumed. |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6158 |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6159 @kindex \ |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6160 @item \ |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6161 Narrow the current agenda filter by an additional condition. When called with |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6162 prefix arg, remove the entries that @emph{do} have the tag, or that do match |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6163 the effort criterion. You can achieve the same effect by pressing @kbd{+} or |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6164 @kbd{-} as the first key after the @kbd{/} command. |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
6165 |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6166 @kindex [ |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6167 @kindex ] |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6168 @kindex @{ |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6169 @kindex @} |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6170 @item [ ] @{ @} |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
6171 In the @i{search view} (@pxref{Keyword search}), these keys add new search |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
6172 words (@kbd{[} and @kbd{]}) or new regular expressions (@kbd{@{} and |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
6173 @kbd{@}}) to the query string. The opening bracket/brace will add a positive |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
6174 search term prefixed by @samp{+}, indicating that this search term @i{must} |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
6175 occur/match in the entry. The closing bracket/brace will add a negative |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
6176 search term which @i{must not} occur/match in the entry for it to be |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
6177 selected. |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6178 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6179 |
84308 | 6180 @tsubheading{Remote editing} |
6181 @cindex remote editing, from agenda | |
6182 | |
6183 @item 0-9 | |
6184 Digit argument. | |
6185 @c | |
6186 @cindex undoing remote-editing events | |
6187 @cindex remote editing, undo | |
6188 @kindex C-_ | |
6189 @item C-_ | |
6190 Undo a change due to a remote editing command. The change is undone | |
6191 both in the agenda buffer and in the remote buffer. | |
6192 @c | |
6193 @kindex t | |
6194 @item t | |
6195 Change the TODO state of the item, both in the agenda and in the | |
6196 original org file. | |
6197 @c | |
6198 @kindex C-k | |
6199 @item C-k | |
6200 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
|
6201 to it in the original Org file. If the text to be deleted remotely |
84308 | 6202 is longer than one line, the kill needs to be confirmed by the user. See |
6203 variable @code{org-agenda-confirm-kill}. | |
6204 @c | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6205 @kindex a |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6206 @item a |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6207 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
|
6208 @c |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6209 @kindex A |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6210 @item A |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6211 Move the subtree corresponding to the current entry to its @emph{Archive |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6212 Sibling}. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6213 @c |
84308 | 6214 @kindex $ |
6215 @item $ | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6216 Archive the subtree corresponding to the current headline. This means the |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6217 entry will be moved to the configured archive location, most likely a |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6218 different file. |
84308 | 6219 @c |
6220 @kindex T | |
6221 @item T | |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
6222 Show all tags associated with the current item. This is useful if you have |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
6223 turned off @code{org-agenda-show-inherited-tags}, but still want to see all |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
6224 tags of a headline occasionally. |
84308 | 6225 @c |
6226 @kindex : | |
6227 @item : | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6228 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
|
6229 agenda, change a tag for all headings in the region. |
84308 | 6230 @c |
6231 @kindex , | |
6232 @item , | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6233 Set the priority for the current item. Org mode prompts for the |
84308 | 6234 priority character. If you reply with @key{SPC}, the priority cookie |
6235 is removed from the entry. | |
6236 @c | |
6237 @kindex P | |
6238 @item P | |
6239 Display weighted priority of current item. | |
6240 @c | |
6241 @kindex + | |
6242 @kindex S-@key{up} | |
6243 @item + | |
6244 @itemx S-@key{up} | |
6245 Increase the priority of the current item. The priority is changed in | |
6246 the original buffer, but the agenda is not resorted. Use the @kbd{r} | |
6247 key for this. | |
6248 @c | |
6249 @kindex - | |
6250 @kindex S-@key{down} | |
6251 @item - | |
6252 @itemx S-@key{down} | |
6253 Decrease the priority of the current item. | |
6254 @c | |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
6255 @kindex C-c C-a |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
6256 @item C-c C-a |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
6257 Dispatcher for all command related to attachments. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
6258 @c |
84308 | 6259 @kindex C-c C-s |
6260 @item C-c C-s | |
6261 Schedule this item | |
6262 @c | |
6263 @kindex C-c C-d | |
6264 @item C-c C-d | |
6265 Set a deadline for this item. | |
6266 @c | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6267 @kindex k |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6268 @item k |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6269 Agenda actions, to set dates for selected items to the cursor date. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6270 This command also works in the calendar! The command prompts for an |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6271 additonal key: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6272 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6273 m @r{Mark the entry at point for action. You can also make entries} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6274 @r{in Org files with @kbd{C-c C-x C-k}.} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6275 d @r{Set the deadline of the marked entry to the date at point.} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6276 s @r{Schedule the marked entry at the date at point.} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6277 r @r{Call @code{org-remember} with the cursor date as default date.} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6278 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6279 Press @kbd{r} afterwards to refresh the agenda and see the effect of the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6280 command. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6281 @c |
84308 | 6282 @kindex S-@key{right} |
6283 @item S-@key{right} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6284 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
|
6285 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
|
6286 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
|
6287 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
|
6288 the agenda buffer. Use the @kbd{r} key to update the buffer. |
84308 | 6289 @c |
6290 @kindex S-@key{left} | |
6291 @item S-@key{left} | |
6292 Change the time stamp associated with the current line by one day | |
6293 into the past. | |
6294 @c | |
6295 @kindex > | |
6296 @item > | |
6297 Change the time stamp associated with the current line to today. | |
6298 The key @kbd{>} has been chosen, because it is the same as @kbd{S-.} | |
6299 on my keyboard. | |
6300 @c | |
6301 @kindex I | |
6302 @item I | |
6303 Start the clock on the current item. If a clock is running already, it | |
6304 is stopped first. | |
6305 @c | |
6306 @kindex O | |
6307 @item O | |
6308 Stop the previously started clock. | |
6309 @c | |
6310 @kindex X | |
6311 @item X | |
6312 Cancel the currently running clock. | |
6313 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6314 @kindex J |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6315 @item J |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6316 Jump to the running clock in another window. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6317 |
84308 | 6318 @tsubheading{Calendar commands} |
6319 @cindex calendar commands, from agenda | |
6320 @kindex c | |
6321 @item c | |
6322 Open the Emacs calendar and move to the date at the agenda cursor. | |
6323 @c | |
6324 @item c | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6325 When in the calendar, compute and show the Org mode agenda for the |
84308 | 6326 date at the cursor. |
6327 @c | |
6328 @cindex diary entries, creating from agenda | |
6329 @kindex i | |
6330 @item i | |
6331 Insert a new entry into the diary. Prompts for the type of entry | |
6332 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new | |
6333 entry in the diary, just as @kbd{i d} etc. would do in the calendar. | |
6334 The date is taken from the cursor position. | |
6335 @c | |
6336 @kindex M | |
6337 @item M | |
6338 Show the phases of the moon for the three months around current date. | |
6339 @c | |
6340 @kindex S | |
6341 @item S | |
6342 Show sunrise and sunset times. The geographical location must be set | |
6343 with calendar variables, see documentation of the Emacs calendar. | |
6344 @c | |
6345 @kindex C | |
6346 @item C | |
6347 Convert the date at cursor into many other cultural and historic | |
6348 calendars. | |
6349 @c | |
6350 @kindex H | |
6351 @item H | |
6352 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
|
6353 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6354 @item M-x org-export-icalendar-combine-agenda-files |
84308 | 6355 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
|
6356 This is a globally available command, and also available in the agenda menu. |
84308 | 6357 |
6358 @tsubheading{Exporting to a file} | |
6359 @kindex C-x C-w | |
6360 @item C-x C-w | |
6361 @cindex exporting agenda views | |
6362 @cindex agenda views, exporting | |
6363 Write the agenda view to a file. Depending on the extension of the | |
6364 selected file name, the view will be exported as HTML (extension | |
6365 @file{.html} or @file{.htm}), Postscript (extension @file{.ps}), or | |
6366 plain text (any other extension). Use the variable | |
6367 @code{org-agenda-exporter-settings} to set options for @file{ps-print} | |
6368 and for @file{htmlize} to be used during export. | |
6369 | |
6370 @tsubheading{Quit and Exit} | |
6371 @kindex q | |
6372 @item q | |
6373 Quit agenda, remove the agenda buffer. | |
6374 @c | |
6375 @kindex x | |
6376 @cindex agenda files, removing buffers | |
6377 @item x | |
6378 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs | |
6379 for the compilation of the agenda. Buffers created by the user to | |
6380 visit org files will not be removed. | |
6381 @end table | |
6382 | |
6383 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6384 @node Custom agenda views, Agenda column view, Agenda commands, Agenda Views |
84308 | 6385 @section Custom agenda views |
6386 @cindex custom agenda views | |
6387 @cindex agenda views, custom | |
6388 | |
6389 Custom agenda commands serve two purposes: to store and quickly access | |
6390 frequently used TODO and tags searches, and to create special composite | |
6391 agenda buffers. Custom agenda commands will be accessible through the | |
6392 dispatcher (@pxref{Agenda dispatcher}), just like the default commands. | |
6393 | |
6394 @menu | |
6395 * Storing searches:: Type once, use often | |
6396 * Block agenda:: All the stuff you need in a single buffer | |
6397 * 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
|
6398 * 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
|
6399 * Using the agenda elsewhere:: Using agenda information in other programs |
84308 | 6400 @end menu |
6401 | |
6402 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views | |
6403 @subsection Storing searches | |
6404 | |
6405 The first application of custom searches is the definition of keyboard | |
6406 shortcuts for frequently used searches, either creating an agenda | |
6407 buffer, or a sparse tree (the latter covering of course only the current | |
6408 buffer). | |
6409 @kindex C-c a C | |
6410 Custom commands are configured in the variable | |
6411 @code{org-agenda-custom-commands}. You can customize this variable, for | |
6412 example by pressing @kbd{C-c a C}. You can also directly set it with | |
6413 Emacs Lisp in @file{.emacs}. The following example contains all valid | |
6414 search types: | |
6415 | |
6416 @lisp | |
6417 @group | |
6418 (setq org-agenda-custom-commands | |
6419 '(("w" todo "WAITING") | |
6420 ("W" todo-tree "WAITING") | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6421 ("u" tags "+boss-urgent") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6422 ("v" tags-todo "+boss-urgent") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6423 ("U" tags-tree "+boss-urgent") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6424 ("f" occur-tree "\\<FIXME\\>") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6425 ("h" . "HOME+Name tags searches") ; description for "h" prefix |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6426 ("hl" tags "+home+Lisa") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6427 ("hp" tags "+home+Peter") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6428 ("hk" tags "+home+Kim"))) |
84308 | 6429 @end group |
6430 @end lisp | |
6431 | |
6432 @noindent | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6433 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
|
6434 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
|
6435 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
|
6436 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
|
6437 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
|
6438 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
|
6439 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
|
6440 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
|
6441 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
|
6442 therefore define: |
84308 | 6443 |
6444 @table @kbd | |
6445 @item C-c a w | |
6446 as a global search for TODO entries with @samp{WAITING} as the TODO | |
6447 keyword | |
6448 @item C-c a W | |
6449 as the same search, but only in the current buffer and displaying the | |
6450 results as a sparse tree | |
6451 @item C-c a u | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6452 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
|
6453 @samp{:urgent:} |
84308 | 6454 @item C-c a v |
6455 as the same search as @kbd{C-c a u}, but limiting the search to | |
6456 headlines that are also TODO items | |
6457 @item C-c a U | |
6458 as the same search as @kbd{C-c a u}, but only in the current buffer and | |
6459 displaying the result as a sparse tree | |
6460 @item C-c a f | |
6461 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
|
6462 containing the word @samp{FIXME} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6463 @item C-c a h |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6464 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
|
6465 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
|
6466 Peter, or Kim) as additional tag to match. |
84308 | 6467 @end table |
6468 | |
6469 @node Block agenda, Setting Options, Storing searches, Custom agenda views | |
6470 @subsection Block agenda | |
6471 @cindex block agenda | |
6472 @cindex agenda, with block views | |
6473 | |
6474 Another possibility is the construction of agenda views that comprise | |
6475 the results of @emph{several} commands, each of which creates a block in | |
6476 the agenda buffer. The available commands include @code{agenda} for the | |
6477 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
|
6478 for the global TODO list (as constructed with @kbd{C-c a t}), and the |
84308 | 6479 matching commands discussed above: @code{todo}, @code{tags}, and |
6480 @code{tags-todo}. Here are two examples: | |
6481 | |
6482 @lisp | |
6483 @group | |
6484 (setq org-agenda-custom-commands | |
6485 '(("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
|
6486 ((agenda "") |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6487 (tags-todo "home") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6488 (tags "garden"))) |
84308 | 6489 ("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
|
6490 ((agenda "") |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6491 (tags-todo "work") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6492 (tags "office"))))) |
84308 | 6493 @end group |
6494 @end lisp | |
6495 | |
6496 @noindent | |
6497 This will define @kbd{C-c a h} to create a multi-block view for stuff | |
6498 you need to attend to at home. The resulting agenda buffer will contain | |
6499 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
|
6500 @samp{home}, and also all lines tagged with @samp{garden}. Finally the |
84308 | 6501 command @kbd{C-c a o} provides a similar view for office tasks. |
6502 | |
6503 @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
|
6504 @subsection Setting options for custom commands |
84308 | 6505 @cindex options, for custom agenda views |
6506 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6507 Org mode contains a number of variables regulating agenda construction |
84308 | 6508 and display. The global variables define the behavior for all agenda |
6509 commands, including the custom commands. However, if you want to change | |
6510 some settings just for a single custom view, you can do so. Setting | |
6511 options requires inserting a list of variable names and values at the | |
6512 right spot in @code{org-agenda-custom-commands}. For example: | |
6513 | |
6514 @lisp | |
6515 @group | |
6516 (setq org-agenda-custom-commands | |
6517 '(("w" todo "WAITING" | |
6518 ((org-agenda-sorting-strategy '(priority-down)) | |
6519 (org-agenda-prefix-format " Mixed: "))) | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6520 ("U" tags-tree "+boss-urgent" |
84308 | 6521 ((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
|
6522 (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
|
6523 ("N" search "" |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6524 ((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
|
6525 (org-agenda-text-search-extra-files nil))))) |
84308 | 6526 @end group |
6527 @end lisp | |
6528 | |
6529 @noindent | |
6530 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
|
6531 priority, and the prefix format is modified to just say @samp{ Mixed: } |
84308 | 6532 instead of giving the category of the entry. The sparse tags tree of |
6533 @kbd{C-c a U} will now turn out ultra-compact, because neither the | |
6534 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
|
6535 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
|
6536 to only a single file. |
84308 | 6537 |
6538 For command sets creating a block agenda, | |
6539 @code{org-agenda-custom-commands} has two separate spots for setting | |
6540 options. You can add options that should be valid for just a single | |
6541 command in the set, and options that should be valid for all commands in | |
6542 the set. The former are just added to the command entry, the latter | |
6543 must come after the list of command entries. Going back to the block | |
6544 agenda example (@pxref{Block agenda}), let's change the sorting strategy | |
6545 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort | |
6546 the results for GARDEN tags query in the opposite order, | |
6547 @code{priority-up}. This would look like this: | |
6548 | |
6549 @lisp | |
6550 @group | |
6551 (setq org-agenda-custom-commands | |
6552 '(("h" "Agenda and Home-related tasks" | |
6553 ((agenda) | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6554 (tags-todo "home") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6555 (tags "garden" |
84308 | 6556 ((org-agenda-sorting-strategy '(priority-up))))) |
6557 ((org-agenda-sorting-strategy '(priority-down)))) | |
6558 ("o" "Agenda and Office-related tasks" | |
6559 ((agenda) | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6560 (tags-todo "work") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6561 (tags "office"))))) |
84308 | 6562 @end group |
6563 @end lisp | |
6564 | |
6565 As you see, the values and parenthesis setting is a little complex. | |
6566 When in doubt, use the customize interface to set this variable - it | |
6567 fully supports its structure. Just one caveat: When setting options in | |
6568 this interface, the @emph{values} are just lisp expressions. So if the | |
6569 value is a string, you need to add the double quotes around the value | |
6570 yourself. | |
6571 | |
6572 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6573 @node Exporting Agenda Views, Using the agenda elsewhere, Setting Options, Custom agenda views |
84308 | 6574 @subsection Exporting Agenda Views |
6575 @cindex agenda views, exporting | |
6576 | |
6577 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
|
6578 printed version of some agenda views to carry around. Org mode can |
84308 | 6579 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
|
6580 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
|
6581 files. If you want to do this only occasionally, use the command |
84308 | 6582 |
6583 @table @kbd | |
6584 @kindex C-x C-w | |
6585 @item C-x C-w | |
6586 @cindex exporting agenda views | |
6587 @cindex agenda views, exporting | |
6588 Write the agenda view to a file. Depending on the extension of the | |
6589 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
|
6590 @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
|
6591 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
|
6592 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
|
6593 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
|
6594 export, for example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6595 |
84308 | 6596 @lisp |
6597 (setq org-agenda-exporter-settings | |
6598 '((ps-number-of-columns 2) | |
6599 (ps-landscape-mode t) | |
6600 (htmlize-output-type 'css))) | |
6601 @end lisp | |
6602 @end table | |
6603 | |
6604 If you need to export certain agenda views frequently, you can associate | |
6605 any custom agenda command with a list of output file names | |
6606 @footnote{If you want to store standard views like the weekly agenda | |
6607 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
|
6608 them in order to be able to specify file names.}. Here is an example |
84308 | 6609 that first does define custom commands for the agenda and the global |
6610 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
|
6611 Then we define two block agenda commands and specify file names for them |
84308 | 6612 as well. File names can be relative to the current working directory, |
6613 or absolute. | |
6614 | |
6615 @lisp | |
6616 @group | |
6617 (setq org-agenda-custom-commands | |
6618 '(("X" agenda "" nil ("agenda.html" "agenda.ps")) | |
6619 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps")) | |
6620 ("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
|
6621 ((agenda "") |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6622 (tags-todo "home") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6623 (tags "garden")) |
84308 | 6624 nil |
6625 ("~/views/home.html")) | |
6626 ("o" "Agenda and Office-related tasks" | |
6627 ((agenda) | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6628 (tags-todo "work") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6629 (tags "office")) |
84308 | 6630 nil |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6631 ("~/views/office.ps" "~/calendars/office.ics")))) |
84308 | 6632 @end group |
6633 @end lisp | |
6634 | |
6635 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
|
6636 @file{.html}, Org mode will use the @file{htmlize.el} package to convert |
84308 | 6637 the buffer to HTML and save it to this file name. If the extension is |
6638 @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
|
6639 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
|
6640 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
|
6641 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
|
6642 extension produces a plain ASCII file. |
84308 | 6643 |
6644 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
|
6645 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
|
6646 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
|
6647 files in one step: |
84308 | 6648 |
6649 @table @kbd | |
6650 @kindex C-c a e | |
6651 @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
|
6652 Export all agenda views that have export file names associated with |
84308 | 6653 them. |
6654 @end table | |
6655 | |
6656 You can use the options section of the custom agenda commands to also | |
6657 set options for the export commands. For example: | |
6658 | |
6659 @lisp | |
6660 (setq org-agenda-custom-commands | |
6661 '(("X" agenda "" | |
6662 ((ps-number-of-columns 2) | |
6663 (ps-landscape-mode t) | |
6664 (org-agenda-prefix-format " [ ] ") | |
6665 (org-agenda-with-colors nil) | |
6666 (org-agenda-remove-tags t)) | |
6667 ("theagenda.ps")))) | |
6668 @end lisp | |
6669 | |
6670 @noindent | |
6671 This command sets two options for the postscript exporter, to make it | |
6672 print in two columns in landscape format - the resulting page can be cut | |
6673 in two and then used in a paper agenda. The remaining settings modify | |
6674 the agenda prefix to omit category and scheduling information, and | |
6675 instead include a checkbox to check off items. We also remove the tags | |
6676 to make the lines compact, and we don't want to use colors for the | |
6677 black-and-white printer. Settings specified in | |
6678 @code{org-agenda-exporter-settings} will also apply, but the settings | |
6679 in @code{org-agenda-custom-commands} take precedence. | |
6680 | |
6681 @noindent | |
6682 From the command line you may also use | |
6683 @example | |
6684 emacs -f org-batch-store-agenda-views -kill | |
6685 @end example | |
6686 @noindent | |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6687 or, if you need to modify some parameters@footnote{Quoting may depend on the |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
6688 system you use, please check th FAQ for examples.} |
84308 | 6689 @example |
6690 emacs -eval '(org-batch-store-agenda-views \ | |
6691 org-agenda-ndays 30 \ | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6692 org-agenda-start-day "2007-11-01" \ |
84308 | 6693 org-agenda-include-diary nil \ |
6694 org-agenda-files (quote ("~/org/project.org")))' \ | |
6695 -kill | |
6696 @end example | |
6697 @noindent | |
6698 which will create the agenda views restricted to the file | |
6699 @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
|
6700 extent. |
84308 | 6701 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6702 @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
|
6703 @subsection Using agenda information outside of Org |
84308 | 6704 @cindex agenda, pipe |
6705 @cindex Scripts, for agenda processing | |
6706 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6707 Org provides commands to access agenda information for the command |
84308 | 6708 line in emacs batch mode. This extracted information can be sent |
6709 directly to a printer, or it can be read by a program that does further | |
6710 processing of the data. The first of these commands is the function | |
6711 @code{org-batch-agenda}, that produces an agenda view and sends it as | |
6712 ASCII text to STDOUT. The command takes a single string as parameter. | |
6713 If the string has length 1, it is used as a key to one of the commands | |
6714 you have configured in @code{org-agenda-custom-commands}, basically any | |
6715 key you can use after @kbd{C-c a}. For example, to directly print the | |
6716 current TODO list, you could use | |
6717 | |
6718 @example | |
6719 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr | |
6720 @end example | |
6721 | |
6722 If the parameter is a string with 2 or more characters, it is used as a | |
6723 tags/todo match string. For example, to print your local shopping list | |
6724 (all items with the tag @samp{shop}, but excluding the tag | |
6725 @samp{NewYork}), you could use | |
6726 | |
6727 @example | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6728 emacs -batch -l ~/.emacs \ |
84308 | 6729 -eval '(org-batch-agenda "+shop-NewYork")' | lpr |
6730 @end example | |
6731 | |
6732 @noindent | |
6733 You may also modify parameters on the fly like this: | |
6734 | |
6735 @example | |
6736 emacs -batch -l ~/.emacs \ | |
6737 -eval '(org-batch-agenda "a" \ | |
6738 org-agenda-ndays 30 \ | |
6739 org-agenda-include-diary nil \ | |
6740 org-agenda-files (quote ("~/org/project.org")))' \ | |
6741 | lpr | |
6742 @end example | |
6743 | |
6744 @noindent | |
6745 which will produce a 30 day agenda, fully restricted to the Org file | |
6746 @file{~/org/projects.org}, not even including the diary. | |
6747 | |
6748 If you want to process the agenda data in more sophisticated ways, you | |
6749 can use the command @code{org-batch-agenda-csv} to get a comma-separated | |
6750 list of values for each agenda item. Each line in the output will | |
6751 contain a number of fields separated by commas. The fields in a line | |
6752 are: | |
6753 | |
6754 @example | |
6755 category @r{The category of the item} | |
6756 head @r{The headline, without TODO kwd, TAGS and PRIORITY} | |
6757 type @r{The type of the agenda entry, can be} | |
6758 todo @r{selected in TODO match} | |
6759 tagsmatch @r{selected in tags match} | |
6760 diary @r{imported from diary} | |
6761 deadline @r{a deadline} | |
6762 scheduled @r{scheduled} | |
6763 timestamp @r{appointment, selected by timestamp} | |
6764 closed @r{entry was closed on date} | |
6765 upcoming-deadline @r{warning about nearing deadline} | |
6766 past-scheduled @r{forwarded scheduled item} | |
6767 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
|
6768 todo @r{The TODO keyword, if any} |
84308 | 6769 tags @r{All tags including inherited ones, separated by colons} |
6770 date @r{The relevant date, like 2007-2-14} | |
6771 time @r{The time, like 15:00-16:50} | |
6772 extra @r{String with extra planning info} | |
6773 priority-l @r{The priority letter if any was given} | |
6774 priority-n @r{The computed numerical priority} | |
6775 @end example | |
6776 | |
6777 @noindent | |
6778 Time and date will only be given if a timestamp (or deadline/scheduled) | |
6779 lead to the selection of the item. | |
6780 | |
6781 A CSV list like this is very easy to use in a post processing script. | |
6782 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
|
6783 Emacs/Org and prints all the items, preceded by a checkbox: |
84308 | 6784 |
6785 @example | |
6786 @group | |
6787 #!/usr/bin/perl | |
6788 | |
6789 # define the Emacs command to run | |
6790 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'"; | |
6791 | |
6792 # run it and capture the output | |
6793 $agenda = qx@{$cmd 2>/dev/null@}; | |
6794 | |
6795 # loop over all lines | |
6796 foreach $line (split(/\n/,$agenda)) @{ | |
6797 | |
6798 # get the individual values | |
6799 ($category,$head,$type,$todo,$tags,$date,$time,$extra, | |
6800 $priority_l,$priority_n) = split(/,/,$line); | |
6801 | |
6802 # proccess and print | |
6803 print "[ ] $head\n"; | |
6804 @} | |
6805 @end group | |
6806 @end example | |
6807 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6808 @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
|
6809 @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
|
6810 @cindex column view, in agenda |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6811 @cindex agenda, column view |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6812 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6813 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
|
6814 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
|
6815 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
|
6816 collected by certain criteria. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6817 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6818 @table @kbd |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6819 @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
|
6820 @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
|
6821 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
|
6822 @end table |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6823 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6824 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
|
6825 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
|
6826 This causes the following issues: |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6827 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6828 @enumerate |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6829 @item |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6830 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
|
6831 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
|
6832 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
|
6833 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
|
6834 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
|
6835 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
|
6836 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
|
6837 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
|
6838 @item |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6839 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
|
6840 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
|
6841 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
|
6842 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
|
6843 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
|
6844 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
|
6845 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
|
6846 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
|
6847 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
|
6848 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
|
6849 some values will count double. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6850 @item |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6851 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
|
6852 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
|
6853 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
|
6854 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
|
6855 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
|
6856 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
|
6857 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
|
6858 the agenda). |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6859 @end enumerate |
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 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6862 @node Embedded LaTeX, Exporting, Agenda Views, Top |
84308 | 6863 @chapter Embedded LaTeX |
6864 @cindex @TeX{} interpretation | |
6865 @cindex La@TeX{} interpretation | |
6866 | |
6867 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
|
6868 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
|
6869 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
|
6870 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
|
6871 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
|
6872 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
|
6873 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
|
6874 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
|
6875 because it can be readily processed into images for HTML production. |
84308 | 6876 |
6877 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
|
6878 If you observe a few conventions, Org mode knows how to find it and what |
84308 | 6879 to do with it. |
6880 | |
6881 @menu | |
6882 * 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
|
6883 * Subscripts and superscripts:: Simple syntax for raising/lowering text |
84308 | 6884 * LaTeX fragments:: Complex formulas made easy |
6885 * Processing LaTeX fragments:: Previewing LaTeX processing | |
6886 * CDLaTeX mode:: Speed up entering of formulas | |
6887 @end menu | |
6888 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6889 @node Math symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX |
84308 | 6890 @section Math symbols |
6891 @cindex math symbols | |
6892 @cindex TeX macros | |
6893 | |
6894 You can use La@TeX{} macros to insert special symbols like @samp{\alpha} | |
6895 to indicate the Greek letter, or @samp{\to} to indicate an arrow. | |
6896 Completion for these macros is available, just type @samp{\} and maybe a | |
6897 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
|
6898 Unlike La@TeX{} code, Org mode allows these macros to be present |
84308 | 6899 without surrounding math delimiters, for example: |
6900 | |
6901 @example | |
6902 Angles are written as Greek letters \alpha, \beta and \gamma. | |
6903 @end example | |
6904 | |
6905 During HTML export (@pxref{HTML export}), these symbols are translated | |
6906 into the proper syntax for HTML, for the above examples this is | |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
6907 @samp{α} and @samp{→}, respectively. If you need such a symbol |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
6908 inside a word, terminate it like this: @samp{\Aacute@{@}stor}. |
84308 | 6909 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6910 @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
|
6911 @section Subscripts and superscripts |
84308 | 6912 @cindex subscript |
6913 @cindex superscript | |
6914 | |
6915 Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super- | |
6916 and subscripts. Again, these can be used without embedding them in | |
6917 math-mode delimiters. To increase the readability of ASCII text, it is | |
6918 not necessary (but OK) to surround multi-character sub- and superscripts | |
6919 with curly braces. For example | |
6920 | |
6921 @example | |
6922 The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of | |
6923 the sun is R_@{sun@} = 6.96 x 10^8 m. | |
6924 @end example | |
6925 | |
6926 To avoid interpretation as raised or lowered text, you can quote | |
6927 @samp{^} and @samp{_} with a backslash: @samp{\_} and @samp{\^}. | |
6928 | |
6929 During HTML export (@pxref{HTML export}), subscript and superscripts | |
6930 are surrounded with @code{<sub>} and @code{<sup>} tags, respectively. | |
6931 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6932 @node LaTeX fragments, Processing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX |
84308 | 6933 @section LaTeX fragments |
6934 @cindex LaTeX fragments | |
6935 | |
6936 With symbols, sub- and superscripts, HTML is pretty much at its end when | |
6937 it comes to representing mathematical formulas@footnote{Yes, there is | |
6938 MathML, but that is not yet fully supported by many browsers, and there | |
6939 is no decent converter for turning La@TeX{} or ASCII representations of | |
6940 formulas into MathML. So for the time being, converting formulas into | |
6941 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
|
6942 formula processor. To this end, Org mode can contain arbitrary La@TeX{} |
84308 | 6943 fragments. It provides commands to preview the typeset result of these |
6944 fragments, and upon export to HTML, all fragments will be converted to | |
6945 images and inlined into the HTML document@footnote{The La@TeX{} export | |
6946 will not use images for displaying La@TeX{} fragments but include these | |
6947 fragments directly into the La@TeX{} code.}. For this to work you | |
6948 need to be on a system with a working La@TeX{} installation. You also | |
6949 need the @file{dvipng} program, available at | |
6950 @url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that | |
6951 will be used when processing a fragment can be configured with the | |
6952 variable @code{org-format-latex-header}. | |
6953 | |
6954 La@TeX{} fragments don't need any special marking at all. The following | |
6955 snippets will be identified as La@TeX{} source code: | |
6956 @itemize @bullet | |
6957 @item | |
6958 Environments of any kind. The only requirement is that the | |
6959 @code{\begin} statement appears on a new line, preceded by only | |
6960 whitespace. | |
6961 @item | |
6962 Text within the usual La@TeX{} math delimiters. To avoid conflicts with | |
6963 currency specifications, single @samp{$} characters are only recognized | |
6964 as math delimiters if the enclosed text contains at most two line breaks, | |
6965 is directly attached to the @samp{$} characters with no whitespace in | |
6966 between, and if the closing @samp{$} is followed by whitespace or | |
6967 punctuation. For the other delimiters, there is no such restriction, so | |
6968 when in doubt, use @samp{\(...\)} as inline math delimiters. | |
6969 @end itemize | |
6970 | |
6971 @noindent For example: | |
6972 | |
6973 @example | |
6974 \begin@{equation@} % arbitrary environments, | |
6975 x=\sqrt@{b@} % even tables, figures | |
6976 \end@{equation@} % etc | |
6977 | |
6978 If $a^2=b$ and \( b=2 \), then the solution must be | |
6979 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \]. | |
6980 @end example | |
6981 | |
6982 @noindent | |
6983 If you need any of the delimiter ASCII sequences for other purposes, you | |
6984 can configure the option @code{org-format-latex-options} to deselect the | |
6985 ones you do not wish to have interpreted by the La@TeX{} converter. | |
6986 | |
6987 @node Processing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX | |
6988 @section Processing LaTeX fragments | |
6989 @cindex LaTeX fragments, preview | |
6990 | |
6991 La@TeX{} fragments can be processed to produce a preview images of the | |
6992 typeset expressions: | |
6993 | |
6994 @table @kbd | |
6995 @kindex C-c C-x C-l | |
6996 @item C-c C-x C-l | |
6997 Produce a preview image of the La@TeX{} fragment at point and overlay it | |
6998 over the source code. If there is no fragment at point, process all | |
6999 fragments in the current entry (between two headlines). When called | |
7000 with a prefix argument, process the entire subtree. When called with | |
7001 two prefix arguments, or when the cursor is before the first headline, | |
7002 process the entire buffer. | |
7003 @kindex C-c C-c | |
7004 @item C-c C-c | |
7005 Remove the overlay preview images. | |
7006 @end table | |
7007 | |
7008 During HTML export (@pxref{HTML export}), all La@TeX{} fragments are | |
7009 converted into images and inlined into the document if the following | |
7010 setting is active: | |
7011 | |
7012 @lisp | |
7013 (setq org-export-with-LaTeX-fragments t) | |
7014 @end lisp | |
7015 | |
7016 @node CDLaTeX mode, , Processing LaTeX fragments, Embedded LaTeX | |
7017 @section Using CDLaTeX to enter math | |
7018 @cindex CDLaTeX | |
7019 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7020 CDLaTeX mode is a minor mode that is normally used in combination with a |
84308 | 7021 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
|
7022 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
|
7023 some of the features of CDLaTeX mode. You need to install |
84308 | 7024 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with |
7025 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
|
7026 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
|
7027 version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it |
84308 | 7028 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
|
7029 Org files with |
84308 | 7030 |
7031 @lisp | |
7032 (add-hook 'org-mode-hook 'turn-on-org-cdlatex) | |
7033 @end lisp | |
7034 | |
7035 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
|
7036 details see the documentation of CDLaTeX mode): |
84308 | 7037 @itemize @bullet |
7038 @kindex C-c @{ | |
7039 @item | |
7040 Environment templates can be inserted with @kbd{C-c @{}. | |
7041 @item | |
7042 @kindex @key{TAB} | |
7043 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
|
7044 La@TeX{} fragment@footnote{Org mode has a method to test if the cursor is |
84308 | 7045 inside such a fragment, see the documentation of the function |
7046 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will | |
7047 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor | |
7048 correctly inside the first brace. Another @key{TAB} will get you into | |
7049 the second brace. Even outside fragments, @key{TAB} will expand | |
7050 environment abbreviations at the beginning of a line. For example, if | |
7051 you write @samp{equ} at the beginning of a line and press @key{TAB}, | |
7052 this abbreviation will be expanded to an @code{equation} environment. | |
7053 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}. | |
7054 @item | |
7055 @kindex _ | |
7056 @kindex ^ | |
7057 Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these | |
7058 characters together with a pair of braces. If you use @key{TAB} to move | |
7059 out of the braces, and if the braces surround only a single character or | |
7060 macro, they are removed again (depending on the variable | |
7061 @code{cdlatex-simplify-sub-super-scripts}). | |
7062 @item | |
7063 @kindex ` | |
7064 Pressing the backquote @kbd{`} followed by a character inserts math | |
7065 macros, also outside La@TeX{} fragments. If you wait more than 1.5 seconds | |
7066 after the backquote, a help window will pop up. | |
7067 @item | |
7068 @kindex ' | |
7069 Pressing the normal quote @kbd{'} followed by another character modifies | |
7070 the symbol before point with an accent or a font. If you wait more than | |
7071 1.5 seconds after the backquote, a help window will pop up. Character | |
7072 modification will work only inside La@TeX{} fragments, outside the quote | |
7073 is normal. | |
7074 @end itemize | |
7075 | |
7076 @node Exporting, Publishing, Embedded LaTeX, Top | |
7077 @chapter Exporting | |
7078 @cindex exporting | |
7079 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7080 Org mode documents can be exported into a variety of other formats. For |
84308 | 7081 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
|
7082 simple version of an Org file. HTML export allows you to publish a |
84308 | 7083 notes file on the web, while the XOXO format provides a solid base for |
7084 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
|
7085 you use Org mode and its structured editing functions to easily create |
84308 | 7086 La@TeX{} files. To incorporate entries with associated times like |
7087 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
|
7088 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
|
7089 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
|
7090 |
100607
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7091 Org supports export of selected regions when @code{transient-mark-mode} is |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7092 enabled (default in Emacs 23). |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7093 |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7094 @menu |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7095 * Markup rules:: Which structures are recognized? |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7096 * Selective export:: Using tags to select and exclude trees |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7097 * Export options:: Per-file export settings |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7098 * The export dispatcher:: How to access exporter commands |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7099 * ASCII export:: Exporting to plain ASCII |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7100 * HTML export:: Exporting to HTML |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
7101 * LaTeX and PDF export:: Exporting to LaTeX, and processing to PDF |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7102 * XOXO export:: Exporting to XOXO |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7103 * iCalendar export:: Exporting in iCalendar format |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7104 @end menu |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7105 |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7106 @node Markup rules, Selective export, Exporting, Exporting |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7107 @section Markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7108 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7109 When exporting Org mode documents, the exporter tries to reflect the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7110 structure of the document as accurately as possible in the back-end. Since |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7111 export targets like HTML or La@TeX{} allow much richer formatting, Org mode |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7112 has rules how to prepare text for rich export. This section summarizes the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7113 markup rule used in an Org mode buffer. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7114 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7115 @menu |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7116 * Document title:: How the document title is determined |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7117 * Headings and sections:: The main structure of the exported document |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7118 * Table of contents:: If, where, how to create a table of contents |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7119 * Initial text:: Text before the first headline |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7120 * Lists:: Plain lists are exported |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7121 * Paragraphs:: What determines beginning and ending |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7122 * Literal examples:: Source code and other examples |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7123 * Include files:: Include the contents of a file during export |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7124 * Tables exported:: Tables are exported richly |
100450
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7125 * Inlined images:: How to inline images during export |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7126 * Footnotes:: Numbers like [1] |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7127 * Emphasis and monospace:: To bold or not to bold |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7128 * TeX macros and LaTeX fragments:: Create special, rich export. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7129 * Horizontal rules:: A line across the page |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7130 * Comment lines:: Some lines will not be exported |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7131 @end menu |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7132 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7133 @node Document title, Headings and sections, Markup rules, Markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7134 @subheading Document title |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7135 @cindex document title, markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7136 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7137 @noindent |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7138 The title of the exported document is taken from the special line |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7139 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7140 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7141 #+TITLE: This is the title of the document |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7142 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7143 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7144 @noindent |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7145 If this line does not exist, the title is derived from the first non-empty, |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7146 non-comment line in the buffer. If no such line exists, or if you have |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7147 turned off exporting of the text before the first headline (see below), the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7148 title will be the file name without extension. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7149 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7150 If you are exporting only a subtree by marking is as the region, the heading |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7151 of the subtree will become the title of the document. If the subtree has a |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7152 property @code{EXPORT_TITLE}, that will take precedence. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7153 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7154 @node Headings and sections, Table of contents, Document title, Markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7155 @subheading Headings and sections |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7156 @cindex headings and sections, markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7157 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7158 The outline structure of the document as described in @ref{Document |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7159 Structure} forms the basis for defining sections of the exported document. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7160 However, since the outline structure is also used for (for example) lists of |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7161 tasks, only the first three outline levels will be used as headings. Deeper |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7162 levels will become itemized lists. You can change the location of this |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7163 switch, globally by setting the variable @code{org-headline-levels}, or on a |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7164 per file basis with a line |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7165 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7166 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7167 #+OPTIONS: H:4 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7168 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7169 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7170 @node Table of contents, Initial text, Headings and sections, Markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7171 @subheading Table of contents |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7172 @cindex table of contents, markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7173 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7174 The table of contents is normally inserted directly before the first headline |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7175 of the file. If you would like to get it to a different location, insert the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7176 string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7177 location. The depth of the table of contents is by default the same as the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7178 number of headline levels, but you can choose a smaller number or turn off |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7179 the table of contents entirely by configuring the variable |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7180 @code{org-export-with-toc}, or on a per-file basis with a line like |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7181 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7182 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7183 #+OPTIONS: toc:2 (only to two levels in TOC) |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7184 #+OPTIONS: toc:nil (no TOC at all) |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7185 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7186 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7187 @node Initial text, Lists, Table of contents, Markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7188 @subheading Text before the first headline |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7189 @cindex text before first headline, markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7190 @cindex #+TEXT |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7191 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7192 Org mode normally exports the text before the first headline, and even uses |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7193 the first line as the document title. The text will be fully marked up. If |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7194 you need to include literal HTML or La@TeX{} code, use the special constructs |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7195 described below in the sections for the individual exporters. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7196 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7197 Some people like to use the space before the first headline for setup and |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7198 internal links and therefore would like to control the exported text before |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7199 the first headline in a different way. You can do so by setting the variable |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7200 @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7201 basis, you can get the same effect with @samp{#+OPTIONS: skip:t}. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7202 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7203 @noindent |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7204 If you still want to have some text before the first headline, use the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7205 @code{#+TEXT} construct: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7206 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7207 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7208 #+OPTIONS: skip:t |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7209 #+TEXT: This text will go before the *first* headline. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7210 #+TEXT: [TABLE-OF-CONTENTS] |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7211 #+TEXT: This goes between the table of contents and the first headline |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7212 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7213 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7214 @node Lists, Paragraphs, Initial text, Markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7215 @subheading Lists |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7216 @cindex lists, markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7217 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7218 Plain lists as described in @ref{Plain lists} are translated to the back-ends |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7219 syntax for such lists. Most back-ends support unordered, ordered, and |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7220 description lists. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7221 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7222 @node Paragraphs, Literal examples, Lists, Markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7223 @subheading Paragraphs, line breaks, and quoting |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7224 @cindex paragraphs, markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7225 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7226 Paragraphs are separated by at least one empty line. If you need to enforce |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7227 a line break within a paragraph, use @samp{\\} at the end of a line. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7228 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7229 To keep the line breaks in a region, but otherwise use normal formatting, you |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7230 can use this construct, which can also be used to format poetry. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7231 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7232 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7233 #+BEGIN_VERSE |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7234 Great clouds overhead |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7235 Tiny black birds rise and fall |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7236 Snow covers Emacs |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
7237 |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7238 -- AlexSchroeder |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7239 #+END_VERSE |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7240 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7241 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7242 When quoting a passage from another document, it is customary to format this |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7243 as a paragraph that is indented on both the left and the right margin. You |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7244 can include quotations in Org mode documents like this: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7245 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7246 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7247 #+BEGIN_QUOTE |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7248 Everything should be made as simple as possible, |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7249 but not any simpler -- Albert Einstein |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7250 #+END_QUOTE |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7251 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7252 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7253 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7254 @node Literal examples, Include files, Paragraphs, Markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7255 @subheading Literal examples |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7256 @cindex literal examples, markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7257 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7258 You can include literal examples that should not be subjected to |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7259 markup. Such examples will be typeset in monospace, so this is well suited |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7260 for source code and similar examples. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7261 @cindex #+BEGIN_EXAMPLE |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7262 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7263 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7264 #+BEGIN_EXAMPLE |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7265 Some example from a text file. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7266 #+END_EXAMPLE |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7267 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7268 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7269 For simplicity when using small examples, you can also start the example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7270 lines with a colon: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7271 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7272 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7273 : Some example from a text file. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7274 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7275 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7276 @cindex formatting source code, markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7277 If the example is source code from a programming language, or any other text |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7278 that can be marked up by font-lock in Emacs, you can ask for the example to |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7279 look like the fontified Emacs buffer@footnote{Currently this works only for |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7280 the HTML back-end, and requires the @file{htmlize.el} package version 1.34 or |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7281 later.}. This is done with the @samp{src} block, where you also need to |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7282 specify the name of the major mode that should be used to fontify the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7283 example: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7284 @cindex #+BEGIN_SRC |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7285 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7286 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7287 #+BEGIN_SRC emacs-lisp |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7288 (defun org-xor (a b) |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7289 "Exclusive or." |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7290 (if a (not b) b)) |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7291 #+END_SRC |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7292 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7293 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7294 @table @kbd |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7295 @kindex C-c ' |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7296 @item C-c ' |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7297 Edit the source code example at point in its native mode. This works by |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7298 switching to an indirect buffer, narrowing the buffer and switching to the |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7299 other mode. You need to exit by pressing @kbd{C-c '} again@footnote{Upon |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7300 exit, lines starting with @samp{*} or @samp{#} will get a comma prepended, to |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7301 keep them from being interpreted by Org as outline nodes or special |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7302 comments. These commas will be striped for editing with @kbd{C-c '}, and |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7303 also for export.}. Fixed-width |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7304 regions (where each line starts with a colon followed by a space) will be |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7305 edited using @code{artist-mode}@footnote{You may select a different-mode with |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7306 the variable @code{org-edit-fixed-width-region-mode}.} to allow creating |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7307 ASCII drawings easily. Using this command in an empty line will create a new |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7308 fixed-width region. |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7309 @end table |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7310 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7311 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7312 @node Include files, Tables exported, Literal examples, Markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7313 @subheading Include files |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7314 @cindex include files, markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7315 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7316 During export, you can include the content of another file. For example, to |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7317 include your .emacs file, you could use: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7318 @cindex #+INCLUDE |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7319 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7320 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7321 #+INCLUDE: "~/.emacs" src emacs-lisp |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7322 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7323 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7324 The optional second and third parameter are the markup (@samp{quote}, |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7325 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7326 language for formatting the contents. The markup is optional, if it is not |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7327 given, the text will be assumed to be in Org mode format and will be |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
7328 processed normally. The include line will also allow additional keyword |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
7329 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
7330 first line and for each following line. For example, to include a file as an |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
7331 item, use |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
7332 |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
7333 @example |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
7334 #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " " |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
7335 @end example |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7336 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7337 @table @kbd |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7338 @kindex C-c ' |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7339 @item C-c ' |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7340 Visit the include file at point. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7341 @end table |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7342 |
100450
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7343 @node Tables exported, Inlined images, Include files, Markup rules |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7344 @subheading Tables |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7345 @cindex tables, markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7346 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7347 Both the native Org mode tables (@pxref{Tables}) and tables formatted with |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7348 the @file{table.el} package will be exported properly. For Org mode tables, |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7349 the lines before the first horizontal separator line will become table header |
100450
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7350 lines. You can use the following lines somewhere before the table to asssign |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7351 a caption and a label for cross references: |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7352 |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7353 @example |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7354 #+CAPTION: This is the caption for the next table (or link) |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7355 #+LABEL: tbl:basic-data |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7356 @end example |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7357 |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7358 @node Inlined images, Footnotes, Tables exported, Markup rules |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7359 @subheading Inlined Images |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7360 @cindex inlined images, markup rules |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7361 |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7362 Some backends (HTML and LaTeX) allow to directly include images into the |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7363 exported document. Org does this, if a link to an image files does not have |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7364 a description part, for example @code{[[./img/a.jpg]]}. If you wish to |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7365 define a caption for the image and maybe a label for internal cross |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7366 references, you can use (before, but close to the link) |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7367 |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7368 @example |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7369 #+CAPTION: This is the caption for the next figure link (or table) |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7370 #+LABEL: fig:SED-HR4049 |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7371 @end example |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7372 |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7373 You may also define additional attributes for the figure. As this is |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7374 backend-specific, see the sections about the individual backends for more |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7375 information. |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7376 |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7377 @node Footnotes, Emphasis and monospace, Inlined images, Markup rules |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7378 @subheading Footnotes |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7379 @cindex footnotes, markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7380 @cindex @file{footnote.el} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7381 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7382 @kindex C-c ! |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7383 Numbers in square brackets are treated as footnote markers, and lines |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7384 starting with such a marker are interpreted as the footnote itself. You can |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7385 use the Emacs package @file{footnote.el} to create footnotes@footnote{The |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7386 @file{footnote} package uses @kbd{C-c !} to invoke its commands. This |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7387 binding conflicts with the Org mode command for inserting inactive time |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7388 stamps. You could use the variable @code{footnote-prefix} to switch |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7389 footnotes commands to another key. Or, if you are too used to this binding, |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7390 you could use @code{org-replace-disputed-keys} and @code{org-disputed-keys} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7391 to change the settings in Org.}. For example: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7392 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7393 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7394 The Org homepage[1] now looks a lot better than it used to. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7395 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7396 [1] The link is: http://orgmode.org |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7397 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7398 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7399 @node Emphasis and monospace, TeX macros and LaTeX fragments, Footnotes, Markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7400 @subheading Emphasis and monospace |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7401 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7402 @cindex underlined text, markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7403 @cindex bold text, markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7404 @cindex italic text, markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7405 @cindex verbatim text, markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7406 @cindex code text, markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7407 @cindex strike-through text, markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7408 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7409 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7410 in the code and verbatim string is not processed for Org mode specific |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7411 syntax, it is exported verbatim. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7412 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7413 @node TeX macros and LaTeX fragments, Horizontal rules, Emphasis and monospace, Markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7414 @subheading @TeX{} macros and La@TeX{} fragments |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7415 @cindex LaTeX fragments, markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7416 @cindex TeX macros, markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7417 @cindex HTML entities |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7418 @cindex LaTeX entities |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7419 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7420 A @TeX{}-like syntax is used to specify special characters. Where possible, |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7421 these will be transformed into the native format of the exporter back-end. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7422 Strings like @code{\alpha} will be exported as @code{α} in the HTML |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7423 output, and as @code{$\alpha$} in the La@TeX{} output. Similarly, |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7424 @code{\nbsp} will become @code{ } in HTML and @code{~} in La@TeX{}. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7425 This applies for a large number of entities, with names taken from both HTML |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7426 and La@TeX{}, see the variable @code{org-html-entities} for the complete |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7427 list. If you are unsure about a name, use @kbd{M-@key{TAB}} for completion |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7428 after having types the backslash and maybe a few characters |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7429 (@pxref{Completion}). |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7430 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7431 La@TeX{} fragments are converted into images for HTML export, and they are |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7432 written literally into the La@TeX{} export. See also @ref{Embedded LaTeX}. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7433 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7434 Finally, @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7435 @samp{...} are all converted into special commands creating hyphens of |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7436 different lengths or a compact set of dots. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7437 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7438 @node Horizontal rules, Comment lines, TeX macros and LaTeX fragments, Markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7439 @subheading Horizontal rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7440 @cindex horizontal rules, markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7441 A line consisting of only dashes, and at least 5 of them, will be |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7442 exported as a horizontal line (@samp{<hr/>} in HTML). |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7443 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7444 @node Comment lines, , Horizontal rules, Markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7445 @subheading Comment lines |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7446 @cindex comment lines |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7447 @cindex exporting, not |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7448 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7449 Lines starting with @samp{#} in column zero are treated as comments and will |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7450 never be exported. Also entire subtrees starting with the word |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7451 @samp{COMMENT} will never be exported. Finally, regions surrounded by |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7452 @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7453 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7454 @table @kbd |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7455 @kindex C-c ; |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7456 @item C-c ; |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7457 Toggle the COMMENT keyword at the beginning of an entry. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7458 @end table |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7459 |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7460 @node Selective export, Export options, Markup rules, Exporting |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7461 @section Selective export |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7462 @cindex export, selective by tags |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7463 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7464 You may use tags to select the parts of a document that should be exported, |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7465 or to exclude parts from export. This behavior is governed by two variables: |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7466 @code{org-export-select-tags} and @code{org-export-exclude-tags}. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7467 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7468 Org first checks if any of the @emph{select} tags is present in the buffer. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7469 If yes, all trees that do not carry one of these tags will be excluded. If a |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7470 selected tree is a subtree, the heading hierarchy above it will also be |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7471 selected for export, but not the text below those headings. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7472 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7473 @noindent |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7474 If none of the select tags is found, the whole buffer will be selected for |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7475 export. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7476 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7477 @noindent |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7478 Finally, all subtrees that are marked by any of the @emph{exclude} tags will |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7479 be removed from the export buffer. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7480 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7481 @node Export options, The export dispatcher, Selective export, Exporting |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7482 @section Export options |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7483 @cindex options, for export |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7484 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7485 @cindex completion, of option keywords |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7486 The exporter recognizes special lines in the buffer which provide |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7487 additional information. These lines may be put anywhere in the file. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7488 The whole set of lines can be inserted into the buffer with @kbd{C-c |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7489 C-e t}. For individual lines, a good way to make sure the keyword is |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7490 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7491 (@pxref{Completion}). |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7492 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7493 @table @kbd |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7494 @kindex C-c C-e t |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7495 @item C-c C-e t |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7496 Insert template with export options, see example below. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7497 @end table |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7498 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7499 @cindex #+TITLE: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7500 @cindex #+AUTHOR: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7501 @cindex #+DATE: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7502 @cindex #+EMAIL: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7503 @cindex #+LANGUAGE: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7504 @cindex #+TEXT: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7505 @cindex #+OPTIONS: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7506 @cindex #+LINK_UP: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7507 @cindex #+LINK_HOME: |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7508 @cindex #+EXPORT_SELECT_TAGS: |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7509 @cindex #+EXPORT_EXCLUDE_TAGS: |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7510 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7511 #+TITLE: the title to be shown (default is the buffer name) |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7512 #+AUTHOR: the author (default taken from @code{user-full-name}) |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7513 #+DATE: A date, fixed, of a format string for @code{format-time-string} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7514 #+EMAIL: his/her email address (default from @code{user-mail-address}) |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7515 #+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language}) |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7516 #+TEXT: Some descriptive text to be inserted at the beginning. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7517 #+TEXT: Several lines may be given. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7518 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ... |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7519 #+LINK_UP: the ``up'' link of an exported page |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7520 #+LINK_HOME: the ``home'' link of an exported page |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7521 #+EXPORT_SELECT_TAGS: Tags that select a tree for export |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7522 #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7523 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7524 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7525 @noindent |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7526 The OPTIONS line is a compact@footnote{If you want to configure many options |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7527 this way, you can use several OPTIONS lines.} form to specify export settings. Here |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7528 you can: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7529 @cindex headline levels |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7530 @cindex section-numbers |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7531 @cindex table of contents |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7532 @cindex line-break preservation |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7533 @cindex quoted HTML tags |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7534 @cindex fixed-width sections |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7535 @cindex tables |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7536 @cindex @TeX{}-like syntax for sub- and superscripts |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7537 @cindex footnotes |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7538 @cindex special strings |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7539 @cindex emphasized text |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7540 @cindex @TeX{} macros |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7541 @cindex La@TeX{} fragments |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7542 @cindex author info, in export |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7543 @cindex time info, in export |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7544 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7545 H: @r{set the number of headline levels for export} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7546 num: @r{turn on/off section-numbers} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7547 toc: @r{turn on/off table of contents, or set level limit (integer)} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7548 \n: @r{turn on/off line-break-preservation} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7549 @@: @r{turn on/off quoted HTML tags} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7550 :: @r{turn on/off fixed-width sections} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7551 |: @r{turn on/off tables} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7552 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7553 @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7554 @r{the simple @code{a_b} will be left as it is.} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7555 -: @r{turn on/off conversion of special strings.} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7556 f: @r{turn on/off footnotes like this[1].} |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
7557 todo: @r{turn on/off inclusion of TODO keywords into exported text} |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
7558 pri: @r{turn on/off priority cookies} |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
7559 tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}} |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
7560 <: @r{turn on/off inclusion of any time/date stamps like DEADLINES} |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7561 *: @r{turn on/off emphasized text (bold, italic, underlined)} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7562 TeX: @r{turn on/off simple @TeX{} macros in plain text} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7563 LaTeX: @r{turn on/off La@TeX{} fragments} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7564 skip: @r{turn on/off skipping the text before the first heading} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7565 author: @r{turn on/off inclusion of author name/email into exported file} |
97028
70c4b1cbc9e3
2008-07-25 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
96976
diff
changeset
|
7566 creator: @r{turn on/off inclusion of creator info into exported file} |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7567 timestamp: @r{turn on/off inclusion creation time into exported file} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7568 d: @r{turn on/off inclusion of drawers} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7569 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7570 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7571 These options take effect in both the HTML and La@TeX{} export, except |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7572 for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7573 @code{nil} for the La@TeX{} export. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7574 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7575 When exporting only a single subtree by selecting it with @kbd{C-c @@} before |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7576 calling an export command, the subtree can overrule some of the file's export |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7577 settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE}, |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7578 @code{EXPORT_TEXT}, and @code{EXPORT_OPTIONS}. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7579 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7580 @node The export dispatcher, ASCII export, Export options, Exporting |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7581 @section The export dispatcher |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7582 @cindex dispatcher, for export commands |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7583 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7584 All export commands can be reached using the export dispatcher, which is a |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7585 prefix key that prompts for an additional key specifying the command. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7586 Normally the entire file is exported, but if there is an active region that |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7587 contains one outline tree, the first heading is used as document title and |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7588 the subtrees are exported. |
84308 | 7589 |
7590 @table @kbd | |
7591 @kindex C-c C-e | |
7592 @item C-c C-e | |
7593 Dispatcher for export and publishing commands. Displays a help-window | |
7594 listing the additional key(s) needed to launch an export or publishing | |
99851
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
7595 command. The prefix arg is passed through to the exporter. A double prefix |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
7596 @kbd{C-u C-u} causes most commands to be executed in the background, in a |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
7597 separate emacs process@footnote{To make this behavior the default, customize |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
7598 the variable @code{org-export-run-in-background}.}. |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7599 @kindex C-c C-e v |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7600 @item C-c C-e v |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7601 Like @kbd{C-c C-e}, but only export the text that is currently visible |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7602 (i.e. not hidden by outline visibility). |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7603 @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
|
7604 @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
|
7605 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
|
7606 @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
|
7607 not set, or force processing in the current Emacs process if st. |
84308 | 7608 @end table |
7609 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7610 @node ASCII export, HTML export, The export dispatcher, Exporting |
84308 | 7611 @section ASCII export |
7612 @cindex ASCII export | |
7613 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7614 ASCII export produces a simple and very readable version of an Org mode |
84308 | 7615 file. |
7616 | |
7617 @cindex region, active | |
7618 @cindex active region | |
100607
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7619 @cindex transient-mark-mode |
84308 | 7620 @table @kbd |
7621 @kindex C-c C-e a | |
7622 @item C-c C-e a | |
7623 Export as ASCII file. For an org file @file{myfile.org}, the ASCII file | |
7624 will be @file{myfile.txt}. The file will be overwritten without | |
100607
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7625 warning. If there is an active region@footnote{this requires |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7626 @code{transient-mark-mode} to be turned on}, only the region will be |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7627 exported. If the selected region is a single tree@footnote{To select the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7628 current subtree, use @kbd{C-c @@}.}, the tree head will |
84308 | 7629 become the document title. If the tree head entry has or inherits an |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7630 @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
|
7631 export. |
84308 | 7632 @kindex C-c C-e v a |
7633 @item C-c C-e v a | |
7634 Export only the visible part of the document. | |
7635 @end table | |
7636 | |
7637 @cindex headline levels, for exporting | |
7638 In the exported version, the first 3 outline levels will become | |
7639 headlines, defining a general document structure. Additional levels | |
7640 will be exported as itemized lists. If you want that transition to occur | |
7641 at a different level, specify it with a prefix argument. For example, | |
7642 | |
7643 @example | |
7644 @kbd{C-1 C-c C-e a} | |
7645 @end example | |
7646 | |
7647 @noindent | |
7648 creates only top level headlines and does the rest as items. When | |
7649 headlines are converted to items, the indentation of the text following | |
7650 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
|
7651 the assumption that the first body line indicates the base indentation of |
84308 | 7652 the body text. Any indentation larger than this is adjusted to preserve |
7653 the layout relative to the first line. Should there be lines with less | |
7654 indentation than the first, these are left alone. | |
7655 | |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
7656 @node HTML export, LaTeX and PDF export, ASCII export, Exporting |
84308 | 7657 @section HTML export |
7658 @cindex HTML export | |
7659 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7660 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive |
100607
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7661 HTML formatting, in ways similar to John Gruber's @emph{markdown} |
84308 | 7662 language, but with additional support for tables. |
7663 | |
7664 @menu | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7665 * HTML Export commands:: How to invoke HTML export |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7666 * Quoting HTML tags:: Using direct HTML in Org mode |
84308 | 7667 * Links:: Transformation of links for HTML |
100450
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7668 * Images in HTML export:: |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7669 * 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
|
7670 * Javascript support:: Info and Folding in a web browser |
84308 | 7671 @end menu |
7672 | |
7673 @node HTML Export commands, Quoting HTML tags, HTML export, HTML export | |
7674 @subsection HTML export commands | |
7675 | |
7676 @cindex region, active | |
7677 @cindex active region | |
100607
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7678 @cindex transient-mark-mode |
84308 | 7679 @table @kbd |
7680 @kindex C-c C-e h | |
7681 @item C-c C-e h | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7682 Export as HTML file @file{myfile.html}. For an org file @file{myfile.org}, |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7683 the ASCII file will be @file{myfile.html}. The file will be overwritten |
100607
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7684 without warning. If there is an active region@footnote{this requires |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7685 @code{transient-mark-mode} to be turned on}, only the region will be |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7686 exported. If the selected region is a single tree@footnote{To select the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7687 current subtree, use @kbd{C-c @@}.}, the tree head will become the document |
100607
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7688 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME} |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7689 property, that name will be used for the export. |
84308 | 7690 @kindex C-c C-e b |
7691 @item C-c C-e b | |
7692 Export as HTML file and immediately open it with a browser. | |
7693 @kindex C-c C-e H | |
7694 @item C-c C-e H | |
7695 Export to a temporary buffer, do not create a file. | |
7696 @kindex C-c C-e R | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7697 @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
|
7698 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
|
7699 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
|
7700 the region. This is good for cut-and-paste operations. |
84308 | 7701 @kindex C-c C-e v h |
7702 @kindex C-c C-e v b | |
7703 @kindex C-c C-e v H | |
7704 @kindex C-c C-e v R | |
7705 @item C-c C-e v h | |
7706 @item C-c C-e v b | |
7707 @item C-c C-e v H | |
7708 @item C-c C-e v R | |
7709 Export only the visible part of the document. | |
7710 @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
|
7711 Convert the region to HTML under the assumption that it was Org mode |
84308 | 7712 syntax before. This is a global command that can be invoked in any |
7713 buffer. | |
7714 @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
|
7715 Replace the active region (assumed to be in Org mode syntax) by HTML |
84308 | 7716 code. |
7717 @end table | |
7718 | |
7719 @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
|
7720 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
|
7721 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
|
7722 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
|
7723 specify it with a numeric prefix argument. For example, |
84308 | 7724 |
7725 @example | |
7726 @kbd{C-2 C-c C-e b} | |
7727 @end example | |
7728 | |
7729 @noindent | |
7730 creates two levels of headings and does the rest as items. | |
7731 | |
7732 @node Quoting HTML tags, Links, HTML Export commands, HTML export | |
7733 @subsection Quoting HTML tags | |
7734 | |
7735 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and | |
7736 @samp{>} in HTML export. If you want to include simple HTML tags | |
7737 which should be interpreted as such, mark them with @samp{@@} as in | |
7738 @samp{@@<b>bold text@@</b>}. Note that this really works only for | |
7739 simple tags. For more extensive HTML that should be copied verbatim to | |
7740 the exported file use either | |
7741 | |
7742 @example | |
7743 #+HTML: Literal HTML code for export | |
7744 @end example | |
7745 | |
7746 @noindent or | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7747 @cindex #+BEGIN_HTML |
84308 | 7748 |
7749 @example | |
7750 #+BEGIN_HTML | |
7751 All lines between these markers are exported literally | |
7752 #+END_HTML | |
7753 @end example | |
7754 | |
7755 | |
100450
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7756 @node Links, Images in HTML export, Quoting HTML tags, HTML export |
84308 | 7757 @subsection Links |
7758 | |
7759 @cindex links, in HTML export | |
7760 @cindex internal links, in HTML export | |
7761 @cindex external links, in HTML export | |
100450
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7762 Internal links (@pxref{Internal links}) will continue to work in HTML. |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7763 Automatic links created by radio targets (@pxref{Radio targets}) will also |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7764 work in the HTML file. Links to external files will still work if the HTML |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7765 file is in the same directory as the Org file. Links to other @file{.org} |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7766 files will be translated into HTML links under the assumption that an HTML |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7767 version also exists of the linked file. For information related to linking |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7768 files while publishing them to a publishing directory see @ref{Publishing |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7769 links}. |
84308 | 7770 |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
7771 If you want to specify attributes for links, you can do so using a special |
100450
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7772 @code{#+ATTR_HTML} line to define attributes that wil be added to the |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7773 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{alt} and |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7774 @code{title} attributes for an inlined image: |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7775 |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7776 @example |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7777 #+ATTR_HTML: alt="This is image A" title="Image with no action" |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7778 [[./img/a.jpg]] |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7779 @end example |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7780 |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7781 @node Images in HTML export, CSS support, Links, HTML export |
84308 | 7782 @subsection Images |
7783 | |
7784 @cindex images, inline in HTML | |
7785 @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
|
7786 HTML export can inline images given as links in the Org file, and |
84308 | 7787 it can make an image the clickable part of a link. By |
7788 default@footnote{but see the variable | |
7789 @code{org-export-html-inline-images}}, images are inlined if a link does | |
7790 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined, | |
7791 while @samp{[[file:myimg.jpg][the image]]} will just produce a link | |
7792 @samp{the image} that points to the image. If the description part | |
7793 itself is a @code{file:} link or a @code{http:} URL pointing to an | |
7794 image, this image will be inlined and activated so that clicking on the | |
7795 image will activate the link. For example, to include a thumbnail that | |
7796 will link to a high resolution version of the image, you could use: | |
7797 | |
7798 @example | |
7799 [[file:highres.jpg][file:thumb.jpg]] | |
7800 @end example | |
7801 | |
7802 @noindent | |
7803 and you could use @code{http} addresses just as well. | |
7804 | |
100450
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7805 @node CSS support, Javascript support, Images in HTML export, HTML export |
84308 | 7806 @subsection CSS support |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7807 @cindex CSS, for HTML export |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7808 @cindex HTML export, CSS |
84308 | 7809 |
7810 You can also give style information for the exported file. The HTML | |
7811 exporter assigns the following CSS classes to appropriate parts of the | |
7812 document - your style specifications may change these: | |
7813 @example | |
7814 .todo @r{TODO keywords} | |
7815 .done @r{the DONE keyword} | |
7816 .timestamp @r{time stamp} | |
7817 .timestamp-kwd @r{keyword associated with a time stamp, like SCHEDULED} | |
7818 .tag @r{tag in a headline} | |
7819 .target @r{target for links} | |
7820 @end example | |
7821 | |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
7822 Each exported files contains a compact default style that defines these |
99503
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
7823 classes in a basic way@footnote{This style is defined in the constant |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
7824 @code{org-export-html-style-default}, which you should not modify. To turn |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
7825 inclusion of these defaults off, customize |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
7826 @code{org-export-html-style-include-default}}. You may overwrite these |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
7827 settings, or add to them by using the variables @code{org-export-html-style} |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
7828 (for Org-wide settings) and @code{org-export-html-style-extra} (for more |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
7829 granular settings, like file-local settings). To set the latter variable |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
7830 individually for each file, you can use |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7831 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7832 @example |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7833 #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" /> |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7834 @end example |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7835 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
7836 @noindent |
99503
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
7837 For longer style definitions, you can use several such lines. You could also |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
7838 directly write a @code{<style>} @code{</style>} section in this way, without |
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
7839 referring to an external file. |
84308 | 7840 |
7841 @c FIXME: More about header and footer styles | |
7842 @c FIXME: Talk about links and targets. | |
7843 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7844 @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
|
7845 @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
|
7846 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7847 @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
|
7848 enhance the web viewing experience of HTML files created with Org. This |
100607
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7849 program allows you to view large files in two different ways. The first one is |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7850 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
|
7851 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
|
7852 as well, press @kbd{?} for an overview of the available keys). The second |
100607
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7853 view type is a @emph{folding} view much like Org provides inside Emacs. |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7854 The script is available at @url{http://orgmode.org/org-info.js} and you can |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7855 find the documentation for it at |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7856 @url{http://orgmode.org/worg/code/org-info-js/org-info.js.html}. We are |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7857 serving the script from our site, but if you use it a lot, you might not want |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7858 to be dependent on @url{orgmode.org} and prefer to install a local copy on |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7859 your own web server. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7860 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7861 To use the script, you need to make sure that the @file{org-jsinfo.el} module |
100607
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7862 gets loaded. It should be loaded by default, but you can try @kbd{M-x |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7863 customize-variable @key{RET} org-modules @key{RET}} to convince yourself that |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7864 this is indeed the case. All it then takes to make use of the program is |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7865 adding a single line to the Org file: |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7866 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7867 @example |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7868 #+INFOJS_OPT: view:info toc:nil |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7869 @end example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7870 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7871 @noindent |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7872 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
|
7873 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
|
7874 viewing options: |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7875 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7876 @example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7877 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
|
7878 @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
|
7879 @r{a local copy and use a path like @samp{../scripts/org-info.js}.} |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7880 view: @r{Initial view when website is first shown. Possible values are:} |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7881 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
|
7882 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
|
7883 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
|
7884 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
|
7885 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
|
7886 @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
|
7887 @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
|
7888 @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
|
7889 @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
|
7890 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
|
7891 @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
|
7892 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
|
7893 @r{the variables @code{org-headline-levels} and @code{org-export-with-toc}.} |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7894 ftoc: @r{Does the css of the page specify a fixed position for the toc?} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7895 @r{If yes, the toc will never be displayed as a section.} |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7896 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
|
7897 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
|
7898 @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
|
7899 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
|
7900 @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
|
7901 @end example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7902 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7903 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
|
7904 @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
|
7905 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
|
7906 |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
7907 @node LaTeX and PDF export, XOXO export, HTML export, Exporting |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
7908 @section LaTeX and PDF export |
84308 | 7909 @cindex LaTeX export |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
7910 @cindex PDF export |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
7911 |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
7912 Org mode contains a La@TeX{} exporter written by Bastien Guerry. With |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
7913 further processing, this backend is also used to produce PDF output. Since |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
7914 the LaTeX output uses @file{hyperref} to implement links and cross |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
7915 references, the PDF output file will be fully linked. |
84308 | 7916 |
7917 @menu | |
100450
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7918 * LaTeX/PDF export commands:: Which key invode which commands |
84308 | 7919 * 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
|
7920 * Sectioning structure:: Changing sectioning in LaTeX output |
100450
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7921 * Tables in LaTeX export:: Options for exporting tables to LaTeX |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
7922 * Images in LaTeX export:: How to insert figures into LaTeX output |
84308 | 7923 @end menu |
7924 | |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
7925 @node LaTeX/PDF export commands, Quoting LaTeX code, LaTeX and PDF export, LaTeX and PDF export |
84308 | 7926 @subsection LaTeX export commands |
7927 | |
100607
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7928 @cindex region, active |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7929 @cindex active region |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7930 @cindex transient-mark-mode |
84308 | 7931 @table @kbd |
7932 @kindex C-c C-e l | |
7933 @item C-c C-e l | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7934 Export as La@TeX{} file @file{myfile.tex}. For an org file |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7935 @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will |
100607
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7936 be overwritten without warning. If there is an active region@footnote{this |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7937 requires @code{transient-mark-mode} to be turned on}, only the region will be |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7938 exported. If the selected region is a single tree@footnote{To select the |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7939 current subtree, use @kbd{C-c @@}.}, the tree head will become the document |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7940 title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME} |
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
7941 property, that name will be used for the export. |
84308 | 7942 @kindex C-c C-e L |
7943 @item C-c C-e L | |
7944 Export to a temporary buffer, do not create a file. | |
7945 @kindex C-c C-e v l | |
7946 @kindex C-c C-e v L | |
7947 @item C-c C-e v l | |
7948 @item C-c C-e v L | |
7949 Export only the visible part of the document. | |
7950 @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
|
7951 Convert the region to La@TeX{} under the assumption that it was Org mode |
84308 | 7952 syntax before. This is a global command that can be invoked in any |
7953 buffer. | |
7954 @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
|
7955 Replace the active region (assumed to be in Org mode syntax) by La@TeX{} |
84308 | 7956 code. |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
7957 @kindex C-c C-e p |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
7958 @item C-c C-e p |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
7959 Export as LaTeX and then process to PDF. |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
7960 @kindex C-c C-e d |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
7961 @item C-c C-e d |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
7962 Export as LaTeX and then process to PDF, then open the resulting PDF file. |
84308 | 7963 @end table |
7964 | |
7965 @cindex headline levels, for exporting | |
7966 In the exported version, the first 3 outline levels will become | |
7967 headlines, defining a general document structure. Additional levels | |
7968 will be exported as description lists. The exporter can ignore them or | |
7969 convert them to a custom string depending on | |
7970 @code{org-latex-low-levels}. | |
7971 | |
7972 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
|
7973 with a numeric prefix argument. For example, |
84308 | 7974 |
7975 @example | |
7976 @kbd{C-2 C-c C-e l} | |
7977 @end example | |
7978 | |
7979 @noindent | |
7980 creates two levels of headings and does the rest as items. | |
7981 | |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
7982 @node Quoting LaTeX code, Sectioning structure, LaTeX/PDF export commands, LaTeX and PDF export |
84308 | 7983 @subsection Quoting LaTeX code |
7984 | |
7985 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
|
7986 inserted into the La@TeX{} file. Furthermore, you can add special code |
84308 | 7987 that should only be present in La@TeX{} export with the following |
7988 constructs: | |
7989 | |
7990 @example | |
7991 #+LaTeX: Literal LaTeX code for export | |
7992 @end example | |
7993 | |
7994 @noindent or | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7995 @cindex #+BEGIN_LaTeX |
84308 | 7996 |
7997 @example | |
7998 #+BEGIN_LaTeX | |
7999 All lines between these markers are exported literally | |
8000 #+END_LaTeX | |
8001 @end example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8002 |
100450
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8003 @node Sectioning structure, Tables in LaTeX export, Quoting LaTeX code, LaTeX and PDF export |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8004 @subsection Sectioning structure |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8005 @cindex LaTeX class |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8006 @cindex LaTeX sectioning structure |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8007 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8008 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
|
8009 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8010 You can change this globally by setting a different value for |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
8011 @code{org-export-latex-default-class} or locally by adding an option like |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
8012 @code{#+LaTeX_CLASS: myclass} in your file. The class should be listed in |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
8013 @code{org-export-latex-classes}, where you can also define the sectioning |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
8014 structure for each class, as well as defining additonal classes. |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
8015 |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
8016 |
100450
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8017 @node Tables in LaTeX export, Images in LaTeX export, Sectioning structure, LaTeX and PDF export |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8018 @subsection Tables in LaTeX export |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8019 @cindex tables, in LaTeX export |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8020 |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8021 For LaTeX export of a table, you can specify a label and a caption |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8022 (@pxref{Tables exported}). You can also use the @code{ATTR_LaTeX} line to |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8023 request a longtable environment for the table, so that it may span several |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8024 pages: |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8025 |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8026 @example |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8027 #+CAPTION: A long table |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8028 #+LABEL: tbl:long |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8029 #+ATTR_LaTeX: longtable |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8030 | ..... | ..... | |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8031 | ..... | ..... | |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8032 @end example |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8033 |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8034 |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8035 @node Images in LaTeX export, , Tables in LaTeX export, LaTeX and PDF export |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8036 @subsection Images in LaTeX export |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8037 @cindex images, inline in LaTeX |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8038 @cindex inlining images in LaTeX |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8039 |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8040 Images that are linked to without a description part in the link, like |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8041 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8042 output files resulting from LaTeX output. Org will use an |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8043 @code{\includegraphics} macro to insert the image. If you have specified a |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8044 caption and/or a label as described in @ref{Markup rules}, the figure will |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8045 be wrappend into a @code{figure} environment and thus become a floating |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8046 element. Finally, you can use an @code{#+ATTR_LaTeX:} line to specify the |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8047 options that can be used in the optional argument of the |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8048 @code{\includegraphics} macro. |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8049 |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8050 @example |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8051 #+CAPTION: The black-body emission of the disk around HR 4049 |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8052 #+LABEL: fig:SED-HR4049 |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8053 #+ATTR_LaTeX: width=5cm,angle=90 |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8054 [[./img/sed-hr4049.pdf]] |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8055 @end example |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8056 |
76e8764c5225
2008-12-16 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100271
diff
changeset
|
8057 |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
8058 @node XOXO export, iCalendar export, LaTeX and PDF export, Exporting |
84308 | 8059 @section XOXO export |
8060 @cindex XOXO export | |
8061 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8062 Org mode contains an exporter that produces XOXO-style output. |
84308 | 8063 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
|
8064 does not interpret any additional Org mode features. |
84308 | 8065 |
8066 @table @kbd | |
8067 @kindex C-c C-e x | |
8068 @item C-c C-e x | |
8069 Export as XOXO file @file{myfile.html}. | |
8070 @kindex C-c C-e v | |
8071 @item C-c C-e v x | |
8072 Export only the visible part of the document. | |
8073 @end table | |
8074 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8075 @node iCalendar export, , XOXO export, Exporting |
84308 | 8076 @section iCalendar export |
8077 @cindex iCalendar export | |
8078 | |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
8079 Some people like to use Org mode for keeping track of projects, but still |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
8080 prefer a standard calendar application for anniversaries and appointments. |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
8081 In this case it can be useful to have deadlines and other time-stamped items |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
8082 in Org files show up in the calendar application. Org mode can export |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
8083 calendar information in the standard iCalendar format. If you also want to |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
8084 have TODO entries included in the export, configure the variable |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
8085 @code{org-icalendar-include-todo}. iCalendar export will export plain time |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
8086 stamps as VEVENT, and TODO items as VTODO. It will also create events from |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
8087 deadlines that are in non-TODO items. Deadlines and scheduling dates in TODO |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
8088 items will be used to set the start and due dates for the todo |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
8089 entry@footnote{See the variables @code{org-icalendar-use-deadline} and |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
8090 @code{org-icalendar-use-scheduled}.}. As categories, it will use the tags |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
8091 locally defined in the heading, and the file/tree category@footnote{To add |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
8092 inherited tags or the TODO state, configure the variable |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
8093 @code{org-icalendar-categories}.}. |
84308 | 8094 |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8095 The iCalendar standard requires each entry to have a globally unique |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8096 identifier (UID). Org creates these identifiers during export. If you set |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8097 the variable @code{org-icalendar-store-UID}, the UID will be stored in the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8098 @code{:ID:} property of the entry and re-used next time you report this |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8099 entry. Since a single entry can give rise to multiple iCalendar entries (as |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8100 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8101 prefixes to the UID, depending on what triggered the inclusion of the entry. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8102 In this way the UID remains unique, but a synchronization program can still |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8103 figure out from which entry all the different instances originate. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8104 |
84308 | 8105 @table @kbd |
8106 @kindex C-c C-e i | |
8107 @item C-c C-e i | |
8108 Create iCalendar entries for the current file and store them in the same | |
8109 directory, using a file extension @file{.ics}. | |
8110 @kindex C-c C-e I | |
8111 @item C-c C-e I | |
8112 Like @kbd{C-c C-e i}, but do this for all files in | |
8113 @code{org-agenda-files}. For each of these files, a separate iCalendar | |
8114 file will be written. | |
8115 @kindex C-c C-e c | |
8116 @item C-c C-e c | |
8117 Create a single large iCalendar file from all files in | |
8118 @code{org-agenda-files} and write it to the file given by | |
8119 @code{org-combined-agenda-icalendar-file}. | |
8120 @end table | |
8121 | |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
8122 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
8123 property can be inherited from higher in the hierarchy if you configure |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
8124 @code{org-use-property-inheritance} accordingly.} properties if the selected |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
8125 entries have them. If not, the summary will be derived from the headline, |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
8126 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
|
8127 @code{org-icalendar-include-body} characters). |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8128 |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
8129 How this calendar is best read and updated, that depends on the application |
84308 | 8130 you are using. The FAQ covers this issue. |
8131 | |
8132 @node Publishing, Miscellaneous, Exporting, Top | |
8133 @chapter Publishing | |
8134 @cindex publishing | |
8135 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8136 Org includes@footnote{@file{org-publish.el} is not distributed with |
84308 | 8137 Emacs 21, if you are still using Emacs 21, you need you need to download |
8138 this file separately.} a publishing management system that allows you to | |
8139 configure automatic HTML conversion of @emph{projects} composed of | |
8140 interlinked org files. This system is called @emph{org-publish}. You can | |
8141 also configure org-publish to automatically upload your exported HTML | |
8142 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
|
8143 a web server. Org-publish turns Org into a web-site authoring tool. |
84308 | 8144 |
8145 You can also use Org-publish to convert files into La@TeX{}, or even | |
8146 combine HTML and La@TeX{} conversion so that files are available in both | |
8147 formats on the server@footnote{Since La@TeX{} files on a server are not | |
8148 that helpful, you surely want to perform further conversion on them -- | |
8149 e.g. convert them to @code{PDF} format.}. | |
8150 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8151 Org-publish has been contributed to Org by David O'Toole. |
84308 | 8152 |
8153 @menu | |
8154 * Configuration:: Defining projects | |
8155 * Sample configuration:: Example projects | |
8156 * Triggering publication:: Publication commands | |
8157 @end menu | |
8158 | |
8159 @node Configuration, Sample configuration, Publishing, Publishing | |
8160 @section Configuration | |
8161 | |
8162 Publishing needs significant configuration to specify files, destination | |
8163 and many other properties of a project. | |
8164 | |
8165 @menu | |
8166 * Project alist:: The central configuration variable | |
8167 * Sources and destinations:: From here to there | |
8168 * Selecting files:: What files are part of the project? | |
8169 * Publishing action:: Setting the function doing the publishing | |
8170 * Publishing options:: Tweaking HTML export | |
8171 * Publishing links:: Which links keep working after publishing? | |
8172 * Project page index:: Publishing a list of project files | |
8173 @end menu | |
8174 | |
8175 @node Project alist, Sources and destinations, Configuration, Configuration | |
8176 @subsection The variable @code{org-publish-project-alist} | |
8177 @cindex org-publish-project-alist | |
8178 @cindex projects, for publishing | |
8179 | |
8180 Org-publish is configured almost entirely through setting the value of | |
8181 one variable, called @code{org-publish-project-alist}. | |
8182 Each element of the list configures one project, and may be in one of | |
8183 the two following forms: | |
8184 | |
8185 @lisp | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8186 ("project-name" :property value :property value ...) |
84308 | 8187 |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
8188 @r{or} |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
8189 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8190 ("project-name" :components ("project-name" "project-name" ...)) |
84308 | 8191 |
8192 @end lisp | |
8193 | |
8194 In both cases, projects are configured by specifying property values. | |
8195 A project defines the set of files that will be published, as well as | |
8196 the publishing configuration to use when publishing those files. When | |
8197 a project takes the second form listed above, the individual members | |
8198 of the ``components'' property are taken to be components of the | |
8199 project, which group together files requiring different publishing | |
8200 options. When you publish such a ``meta-project'' all the components | |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
8201 will also publish. The @code{:components} are published in the sequence |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
8202 provided. |
84308 | 8203 |
8204 @node Sources and destinations, Selecting files, Project alist, Configuration | |
8205 @subsection Sources and destinations for files | |
8206 @cindex directories, for publishing | |
8207 | |
8208 Most properties are optional, but some should always be set. In | |
8209 particular, org-publish needs to know where to look for source files, | |
8210 and where to put published files. | |
8211 | |
8212 @multitable @columnfractions 0.3 0.7 | |
8213 @item @code{:base-directory} | |
8214 @tab Directory containing publishing source files | |
8215 @item @code{:publishing-directory} | |
8216 @tab Directory (possibly remote) where output files will be published. | |
8217 @item @code{:preparation-function} | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8218 @tab Function called before starting the publishing process, for example to |
84308 | 8219 run @code{make} for updating files to be published. |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8220 @item @code{:completion-function} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8221 @tab Function called after finishing the publishing process, for example to |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8222 change permissions of the resulting files. |
84308 | 8223 @end multitable |
8224 @noindent | |
8225 | |
8226 @node Selecting files, Publishing action, Sources and destinations, Configuration | |
8227 @subsection Selecting files | |
8228 @cindex files, selecting for publishing | |
8229 | |
8230 By default, all files with extension @file{.org} in the base directory | |
8231 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
|
8232 properties |
84308 | 8233 @multitable @columnfractions 0.25 0.75 |
8234 @item @code{:base-extension} | |
8235 @tab Extension (without the dot!) of source files. This actually is a | |
8236 regular expression. | |
8237 | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
8238 @item @code{:exclude} |
84308 | 8239 @tab Regular expression to match file names that should not be |
8240 published, even though they have been selected on the basis of their | |
8241 extension. | |
8242 | |
8243 @item @code{:include} | |
8244 @tab List of files to be included regardless of @code{:base-extension} | |
8245 and @code{:exclude}. | |
8246 @end multitable | |
8247 | |
8248 @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
|
8249 @subsection Publishing action |
84308 | 8250 @cindex action, for publishing |
8251 | |
8252 Publishing means that a file is copied to the destination directory and | |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
8253 possibly transformed in the process. The default transformation is to export |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
8254 Org files as HTML files, and this is done by the function |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
8255 @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
8256 export}). But you also can publish your files in La@TeX{} by using the |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
8257 function @code{org-publish-org-to-latex} instead, or as PDF files using |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
8258 @code{org-publish-org-to-pdf}. Other files like images only need to be |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
8259 copied to the publishing destination. For non-Org files, you need to provide |
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
8260 your own publishing function: |
84308 | 8261 |
8262 @multitable @columnfractions 0.3 0.7 | |
8263 @item @code{:publishing-function} | |
8264 @tab Function executing the publication of a file. This may also be a | |
8265 list of functions, which will all be called in turn. | |
8266 @end multitable | |
8267 | |
8268 The function must accept two arguments: a property list containing at | |
8269 least a @code{:publishing-directory} property, and the name of the file | |
8270 to be published. It should take the specified file, make the necessary | |
8271 transformation (if any) and place the result into the destination folder. | |
8272 You can write your own publishing function, but @code{org-publish} | |
8273 provides one for attachments (files that only need to be copied): | |
8274 @code{org-publish-attachment}. | |
8275 | |
8276 @node Publishing options, Publishing links, Publishing action, Configuration | |
8277 @subsection Options for the HTML/LaTeX exporters | |
8278 @cindex options, for publishing | |
8279 | |
8280 The property list can be used to set many export options for the HTML | |
8281 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
|
8282 variables in Org. The table below lists these properties along |
84308 | 8283 with the variable they belong to. See the documentation string for the |
8284 respective variable for details. | |
8285 | |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
8286 @multitable @columnfractions 0.32 0.68 |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
8287 @item @code{:link-up} @tab @code{org-export-html-link-up} |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
8288 @item @code{:link-home} @tab @code{org-export-html-link-home} |
84308 | 8289 @item @code{:language} @tab @code{org-export-default-language} |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
8290 @item @code{:customtime} @tab @code{org-display-custom-times} |
84308 | 8291 @item @code{:headline-levels} @tab @code{org-export-headline-levels} |
8292 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers} | |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
8293 @item @code{:section-number-format} @tab @code{org-export-section-number-format} |
84308 | 8294 @item @code{:table-of-contents} @tab @code{org-export-with-toc} |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
8295 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks} |
84308 | 8296 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees} |
8297 @item @code{:emphasize} @tab @code{org-export-with-emphasize} | |
8298 @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
|
8299 @item @code{:special-strings} @tab @code{org-export-with-special-strings} |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
8300 @item @code{:footnotes} @tab @code{org-export-with-footnotes} |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
8301 @item @code{:drawers} @tab @code{org-export-with-drawers} |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
8302 @item @code{:tags} @tab @code{org-export-with-tags} |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
8303 @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords} |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
8304 @item @code{:priority} @tab @code{org-export-with-priority} |
84308 | 8305 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros} |
8306 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments} | |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
8307 @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading} |
84308 | 8308 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width} |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
8309 @item @code{:timestamps} @tab @code{org-export-with-timestamps} |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
8310 @item @code{:author-info} @tab @code{org-export-author-info} |
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
8311 @item @code{:creator-info} @tab @code{org-export-creator-info} |
84308 | 8312 @item @code{:tables} @tab @code{org-export-with-tables} |
8313 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line} | |
99503
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
8314 @item @code{:style-include-default} @tab @code{org-export-html-style-include-default} |
84308 | 8315 @item @code{:style} @tab @code{org-export-html-style} |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
8316 @item @code{:style-extra} @tab @code{org-export-html-style-extra} |
84308 | 8317 @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html} |
8318 @item @code{:inline-images} @tab @code{org-export-html-inline-images} | |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
8319 @item @code{:html-extension} @tab @code{org-export-html-extension} |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
8320 @item @code{:html-table-tag} @tab @code{org-export-html-table-tag} |
84308 | 8321 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand} |
8322 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp} | |
8323 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory} | |
8324 @item @code{:preamble} @tab @code{org-export-html-preamble} | |
8325 @item @code{:postamble} @tab @code{org-export-html-postamble} | |
8326 @item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble} | |
8327 @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble} | |
8328 @item @code{:author} @tab @code{user-full-name} | |
8329 @item @code{:email} @tab @code{user-mail-address} | |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
8330 @item @code{:select-tags} @tab @code{org-export-select-tags} |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
8331 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags} |
84308 | 8332 @end multitable |
8333 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8334 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
|
8335 |
84308 | 8336 Most of the @code{org-export-with-*} variables have the same effect in |
8337 both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and | |
8338 @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the | |
8339 La@TeX{} export. | |
8340 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8341 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
|
8342 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
|
8343 any) during publishing. Options set within a file (@pxref{Export |
84308 | 8344 options}), however, override everything. |
8345 | |
8346 @node Publishing links, Project page index, Publishing options, Configuration | |
8347 @subsection Links between published files | |
8348 @cindex links, publishing | |
8349 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8350 To create a link from one Org file to another, you would use |
84308 | 8351 something like @samp{[[file:foo.org][The foo]]} or simply |
8352 @samp{file:foo.org.} (@pxref{Hyperlinks}). Upon publishing this link | |
8353 becomes a link to @file{foo.html}. In this way, you can interlink the | |
8354 pages of your "org web" project and the links will work as expected when | |
8355 you publish them to HTML. | |
8356 | |
8357 You may also link to related files, such as images. Provided you are | |
8358 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
|
8359 @code{org-publish} to upload the related files, these links will work |
100607
87dcbbf4f5fa
2008-12-20 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
100508
diff
changeset
|
8360 too. See @ref{Complex example} for an example of this usage. |
84308 | 8361 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8362 Sometime an Org file to be published may contain links that are |
84308 | 8363 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
|
8364 location. In this case, use the property |
84308 | 8365 |
8366 @multitable @columnfractions 0.4 0.6 | |
8367 @item @code{:link-validation-function} | |
8368 @tab Function to validate links | |
8369 @end multitable | |
8370 | |
8371 @noindent | |
8372 to define a function for checking link validity. This function must | |
8373 accept two arguments, the file name and a directory relative to which | |
8374 the file name is interpreted in the production environment. If this | |
8375 function returns @code{nil}, then the HTML generator will only insert a | |
8376 description into the HTML file, but no link. One option for this | |
8377 function is @code{org-publish-validate-link} which checks if the given | |
8378 file is part of any project in @code{org-publish-project-alist}. | |
8379 | |
8380 @node Project page index, , Publishing links, Configuration | |
8381 @subsection Project page index | |
8382 @cindex index, of published pages | |
8383 | |
8384 The following properties may be used to control publishing of an | |
8385 index of files or summary page for a given project. | |
8386 | |
8387 @multitable @columnfractions 0.25 0.75 | |
8388 @item @code{:auto-index} | |
8389 @tab When non-nil, publish an index during org-publish-current-project or | |
8390 org-publish-all. | |
8391 | |
8392 @item @code{:index-filename} | |
8393 @tab Filename for output of index. Defaults to @file{index.org} (which | |
8394 becomes @file{index.html}). | |
8395 | |
8396 @item @code{:index-title} | |
8397 @tab Title of index page. Defaults to name of file. | |
8398 | |
8399 @item @code{:index-function} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8400 @tab Plug-in function to use for generation of index. |
84308 | 8401 Defaults to @code{org-publish-org-index}, which generates a plain list |
8402 of links to all files in the project. | |
8403 @end multitable | |
8404 | |
8405 @node Sample configuration, Triggering publication, Configuration, Publishing | |
8406 @section Sample configuration | |
8407 | |
8408 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
|
8409 project publishing only a set of Org files. The second example is |
84308 | 8410 more complex, with a multi-component project. |
8411 | |
8412 @menu | |
8413 * Simple example:: One-component publishing | |
8414 * Complex example:: A multi-component publishing example | |
8415 @end menu | |
8416 | |
8417 @node Simple example, Complex example, Sample configuration, Sample configuration | |
8418 @subsection Example: simple publishing configuration | |
8419 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8420 This example publishes a set of Org files to the @file{public_html} |
84308 | 8421 directory on the local machine. |
8422 | |
8423 @lisp | |
8424 (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
|
8425 '(("org" |
84308 | 8426 :base-directory "~/org/" |
8427 :publishing-directory "~/public_html" | |
8428 :section-numbers nil | |
8429 :table-of-contents nil | |
99503
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
8430 :style "<link rel=\"stylesheet\" |
84308 | 8431 href=\"../other/mystyle.css\" |
8432 type=\"text/css\">"))) | |
8433 @end lisp | |
8434 | |
8435 @node Complex example, , Simple example, Sample configuration | |
8436 @subsection Example: complex publishing configuration | |
8437 | |
8438 This more complicated example publishes an entire website, including | |
8439 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
|
8440 style sheets. The publishing-directory is remote and private files are |
84308 | 8441 excluded. |
8442 | |
8443 To ensure that links are preserved, care should be taken to replicate | |
8444 your directory structure on the web server, and to use relative file | |
8445 paths. For example, if your org files are kept in @file{~/org} and your | |
8446 publishable images in @file{~/images}, you'd link to an image with | |
8447 @c | |
8448 @example | |
8449 file:../images/myimage.png | |
8450 @end example | |
8451 @c | |
8452 On the web server, the relative path to the image should be the | |
8453 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
|
8454 right place on the web server, and publishing images to it. |
84308 | 8455 |
8456 @lisp | |
8457 (setq org-publish-project-alist | |
8458 '(("orgfiles" | |
8459 :base-directory "~/org/" | |
8460 :base-extension "org" | |
8461 :publishing-directory "/ssh:user@@host:~/html/notebook/" | |
8462 :publishing-function org-publish-org-to-html | |
8463 :exclude "PrivatePage.org" ;; regexp | |
8464 :headline-levels 3 | |
8465 :section-numbers nil | |
8466 :table-of-contents nil | |
99503
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
8467 :style "<link rel=\"stylesheet\" |
84308 | 8468 href=\"../other/mystyle.css\" type=\"text/css\">" |
8469 :auto-preamble t | |
8470 :auto-postamble nil) | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
8471 |
84308 | 8472 ("images" |
8473 :base-directory "~/images/" | |
8474 :base-extension "jpg\\|gif\\|png" | |
8475 :publishing-directory "/ssh:user@@host:~/html/images/" | |
8476 :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
|
8477 |
84308 | 8478 ("other" |
8479 :base-directory "~/other/" | |
8480 :base-extension "css\\|el" | |
8481 :publishing-directory "/ssh:user@@host:~/html/other/" | |
8482 :publishing-function org-publish-attachment) | |
8483 ("website" :components ("orgfiles" "images" "other")))) | |
8484 @end lisp | |
8485 | |
8486 @node Triggering publication, , Sample configuration, Publishing | |
8487 @section Triggering publication | |
8488 | |
8489 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
|
8490 following functions: |
84308 | 8491 |
8492 @table @kbd | |
8493 @item C-c C-e C | |
8494 Prompt for a specific project and publish all files that belong to it. | |
8495 @item C-c C-e P | |
8496 Publish the project containing the current file. | |
8497 @item C-c C-e F | |
8498 Publish only the current file. | |
8499 @item C-c C-e A | |
8500 Publish all projects. | |
8501 @end table | |
8502 | |
8503 Org uses timestamps to track when a file has changed. The above | |
8504 functions normally only publish changed files. You can override this and | |
8505 force publishing of all files by giving a prefix argument. | |
8506 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8507 @node Miscellaneous, Extensions, Publishing, Top |
84308 | 8508 @chapter Miscellaneous |
8509 | |
8510 @menu | |
8511 * 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
|
8512 * Customization:: Adapting Org to your taste |
84308 | 8513 * In-buffer settings:: Overview of the #+KEYWORDS |
8514 * The very busy C-c C-c key:: When in doubt, press C-c C-c | |
8515 * 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
|
8516 * TTY keys:: Using Org on a tty |
84308 | 8517 * Interaction:: Other Emacs packages |
8518 * Bugs:: Things which do not work perfectly | |
8519 @end menu | |
8520 | |
8521 @node Completion, Customization, Miscellaneous, Miscellaneous | |
8522 @section Completion | |
8523 @cindex completion, of @TeX{} symbols | |
8524 @cindex completion, of TODO keywords | |
8525 @cindex completion, of dictionary words | |
8526 @cindex completion, of option keywords | |
8527 @cindex completion, of tags | |
8528 @cindex completion, of property keys | |
8529 @cindex completion, of link abbreviations | |
8530 @cindex @TeX{} symbol completion | |
8531 @cindex TODO keywords completion | |
8532 @cindex dictionary word completion | |
8533 @cindex option keyword completion | |
8534 @cindex tag completion | |
8535 @cindex link abbreviations, completion of | |
8536 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8537 Org supports in-buffer completion. This type of completion does |
84308 | 8538 not make use of the minibuffer. You simply type a few letters into |
8539 the buffer and use the key to complete text right there. | |
8540 | |
8541 @table @kbd | |
8542 @kindex M-@key{TAB} | |
8543 @item M-@key{TAB} | |
8544 Complete word at point | |
8545 @itemize @bullet | |
8546 @item | |
8547 At the beginning of a headline, complete TODO keywords. | |
8548 @item | |
8549 After @samp{\}, complete @TeX{} symbols supported by the exporter. | |
8550 @item | |
8551 After @samp{*}, complete headlines in the current buffer so that they | |
8552 can be used in search links like @samp{[[*find this headline]]}. | |
8553 @item | |
8554 After @samp{:} in a headline, complete tags. The list of tags is taken | |
8555 from the variable @code{org-tag-alist} (possibly set through the | |
8556 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created | |
8557 dynamically from all tags used in the current buffer. | |
8558 @item | |
8559 After @samp{:} and not in a headline, complete property keys. The list | |
8560 of keys is constructed dynamically from all keys used in the current | |
8561 buffer. | |
8562 @item | |
8563 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}). | |
8564 @item | |
8565 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
|
8566 @samp{OPTIONS} which set file-specific options for Org mode. When the |
84308 | 8567 option keyword is already complete, pressing @kbd{M-@key{TAB}} again |
8568 will insert example settings for this keyword. | |
8569 @item | |
8570 In the line after @samp{#+STARTUP: }, complete startup keywords, | |
8571 i.e. valid keys for this line. | |
8572 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8573 Elsewhere, complete dictionary words using Ispell. |
84308 | 8574 @end itemize |
8575 @end table | |
8576 | |
8577 @node Customization, In-buffer settings, Completion, Miscellaneous | |
8578 @section Customization | |
8579 @cindex customization | |
8580 @cindex options, for customization | |
8581 @cindex variables, for customization | |
8582 | |
8583 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
|
8584 Org. For the sake of compactness of the manual, I am not |
84308 | 8585 describing the variables here. A structured overview of customization |
8586 variables is available with @kbd{M-x org-customize}. Or select | |
8587 @code{Browse Org Group} from the @code{Org->Customization} menu. Many | |
8588 settings can also be activated on a per-file basis, by putting special | |
8589 lines into the buffer (@pxref{In-buffer settings}). | |
8590 | |
8591 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous | |
8592 @section Summary of in-buffer settings | |
8593 @cindex in-buffer settings | |
8594 @cindex special keywords | |
8595 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8596 Org mode uses special lines in the buffer to define settings on a |
84308 | 8597 per-file basis. These lines start with a @samp{#+} followed by a |
8598 keyword, a colon, and then individual words defining a setting. Several | |
8599 setting words can be in the same line, but you can also have multiple | |
8600 lines for the keyword. While these settings are described throughout | |
8601 the manual, here is a summary. After changing any of those lines in the | |
8602 buffer, press @kbd{C-c C-c} with the cursor still in the line to | |
8603 activate the changes immediately. Otherwise they become effective only | |
8604 when the file is visited again in a new Emacs session. | |
8605 | |
8606 @table @kbd | |
8607 @item #+ARCHIVE: %s_done:: | |
8608 This line sets the archive location for the agenda file. It applies for | |
8609 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end | |
8610 of the file. The first such line also applies to any entries before it. | |
8611 The corresponding variable is @code{org-archive-location}. | |
8612 @item #+CATEGORY: | |
8613 This line sets the category for the agenda file. The category applies | |
8614 for all subsequent lines until the next @samp{#+CATEGORY} line, or the | |
8615 end of the file. The first such line also applies to any entries before it. | |
8616 @item #+COLUMNS: %25ITEM ..... | |
8617 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
|
8618 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
|
8619 applies. |
84308 | 8620 @item #+CONSTANTS: name1=value1 ... |
8621 Set file-local values for constants to be used in table formulas. This | |
8622 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
|
8623 The global version of this variable is |
84308 | 8624 @code{org-table-formula-constants}. |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8625 @item #+FILETAGS: :tag1:tag2:tag3: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8626 Set tags that can be inherited by any entry in the file, including the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8627 top-level entries. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8628 @item #+DRAWERS: NAME1 ..... |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8629 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
|
8630 @code{org-drawers}. |
84308 | 8631 @item #+LINK: linkword replace |
8632 These lines (several are allowed) specify link abbreviations. | |
8633 @xref{Link abbreviations}. The corresponding variable is | |
8634 @code{org-link-abbrev-alist}. | |
8635 @item #+PRIORITIES: highest lowest default | |
8636 This line sets the limits and the default for the priorities. All three | |
8637 must be either letters A-Z or numbers 0-9. The highest priority must | |
8638 have a lower ASCII number that the lowest priority. | |
8639 @item #+PROPERTY: Property_Name Value | |
8640 This line sets a default inheritance value for entries in the current | |
8641 buffer, most useful for specifying the allowed values of a property. | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8642 @item #+SETUPFILE: file |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8643 This line defines a file that holds more in-buffer setup. Normally this is |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8644 entirely ignored. Only when the buffer is parsed for option-setting lines |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8645 (i.e. when starting Org mode for a file, when pressing @kbd{C-c C-c} in a |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8646 settings line, or when exporting), then the contents of this file are parsed |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8647 as if they had been included in the buffer. In particlar, the file can be |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8648 any other Org mode file with internal setup. You can visit the file the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8649 cursor is in the line with @kbd{C-c '}. |
84308 | 8650 @item #+STARTUP: |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8651 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
|
8652 Org file is being visited. The first set of options deals with the |
84308 | 8653 initial visibility of the outline tree. The corresponding variable for |
8654 global default settings is @code{org-startup-folded}, with a default | |
8655 value @code{t}, which means @code{overview}. | |
8656 @cindex @code{overview}, STARTUP keyword | |
8657 @cindex @code{content}, STARTUP keyword | |
8658 @cindex @code{showall}, STARTUP keyword | |
8659 @example | |
8660 overview @r{top-level headlines only} | |
8661 content @r{all headlines} | |
8662 showall @r{no folding at all, show everything} | |
8663 @end example | |
8664 Then there are options for aligning tables upon visiting a file. This | |
8665 is useful in files containing narrowed table columns. The corresponding | |
8666 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
|
8667 @code{nil}. |
84308 | 8668 @cindex @code{align}, STARTUP keyword |
8669 @cindex @code{noalign}, STARTUP keyword | |
8670 @example | |
8671 align @r{align all tables} | |
8672 noalign @r{don't align tables on startup} | |
8673 @end example | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
8674 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
|
8675 (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
|
8676 @code{org-log-repeat}) can be configured using these options. |
84308 | 8677 @cindex @code{logdone}, STARTUP keyword |
8678 @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
|
8679 @cindex @code{nologdone}, STARTUP keyword |
84308 | 8680 @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
|
8681 @cindex @code{nolognoteclock-out}, STARTUP keyword |
84308 | 8682 @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
|
8683 @cindex @code{lognoterepeat}, STARTUP keyword |
84308 | 8684 @cindex @code{nologrepeat}, STARTUP keyword |
8685 @example | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
8686 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
|
8687 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
|
8688 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
|
8689 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
|
8690 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
|
8691 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
|
8692 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
|
8693 nolognoteclock-out @r{don't record a note when clocking out} |
84308 | 8694 @end example |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8695 Here are the options for hiding leading stars in outline headings, and for |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8696 indenting outlines. The corresponding variables are |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8697 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8698 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}). |
84308 | 8699 @cindex @code{hidestars}, STARTUP keyword |
8700 @cindex @code{showstars}, STARTUP keyword | |
8701 @cindex @code{odd}, STARTUP keyword | |
8702 @cindex @code{even}, STARTUP keyword | |
8703 @example | |
8704 hidestars @r{make all but one of the stars starting a headline invisible.} | |
8705 showstars @r{show all stars starting a headline} | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8706 indent @r{virtual indentation according to outline level} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8707 noindent @r{no virtual indentation according to outline level} |
84308 | 8708 odd @r{allow only odd outline levels (1,3,...)} |
8709 oddeven @r{allow all outline levels} | |
8710 @end example | |
8711 To turn on custom format overlays over time stamps (variables | |
8712 @code{org-put-time-stamp-overlays} and | |
8713 @code{org-time-stamp-overlay-formats}), use | |
8714 @cindex @code{customtime}, STARTUP keyword | |
8715 @example | |
8716 customtime @r{overlay custom time format} | |
8717 @end example | |
8718 The following options influence the table spreadsheet (variable | |
8719 @code{constants-unit-system}). | |
8720 @cindex @code{constcgs}, STARTUP keyword | |
8721 @cindex @code{constSI}, STARTUP keyword | |
8722 @example | |
8723 constcgs @r{@file{constants.el} should use the c-g-s unit system} | |
8724 constSI @r{@file{constants.el} should use the SI unit system} | |
8725 @end example | |
8726 @item #+TAGS: TAG1(c1) TAG2(c2) | |
92148 | 8727 These lines (several such lines are allowed) specify the valid tags in |
84308 | 8728 this file, and (potentially) the corresponding @emph{fast tag selection} |
8729 keys. The corresponding variable is @code{org-tag-alist}. | |
8730 @item #+TBLFM: | |
8731 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
|
8732 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS, #+DATE: |
84308 | 8733 These lines provide settings for exporting files. For more details see |
8734 @ref{Export options}. | |
8735 @item #+SEQ_TODO: #+TYP_TODO: | |
8736 These lines set the TODO keywords and their interpretation in the | |
8737 current file. The corresponding variables are @code{org-todo-keywords} | |
8738 and @code{org-todo-interpretation}. | |
8739 @end table | |
8740 | |
8741 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous | |
8742 @section The very busy C-c C-c key | |
8743 @kindex C-c C-c | |
8744 @cindex C-c C-c, overview | |
8745 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8746 The key @kbd{C-c C-c} has many purposes in Org, which are all |
84308 | 8747 mentioned scattered throughout this manual. One specific function of |
8748 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
|
8749 other circumstances it means something like @emph{Hey Org, look |
84308 | 8750 here and update according to what you see here}. Here is a summary of |
8751 what this means in different contexts. | |
8752 | |
8753 @itemize @minus | |
8754 @item | |
8755 If there are highlights in the buffer from the creation of a sparse | |
8756 tree, or from clock display, remove these highlights. | |
8757 @item | |
8758 If the cursor is in one of the special @code{#+KEYWORD} lines, this | |
8759 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
|
8760 information. |
84308 | 8761 @item |
8762 If the cursor is inside a table, realign the table. This command | |
8763 works even if the automatic table editor has been turned off. | |
8764 @item | |
8765 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to | |
8766 the entire table. | |
8767 @item | |
8768 If the cursor is inside a table created by the @file{table.el} package, | |
8769 activate that table. | |
8770 @item | |
8771 If the current buffer is a remember buffer, close the note and file it. | |
8772 With a prefix argument, file it, without further interaction, to the | |
8773 default location. | |
8774 @item | |
8775 If the cursor is on a @code{<<<target>>>}, update radio targets and | |
8776 corresponding links in this buffer. | |
8777 @item | |
8778 If the cursor is in a property line or at the start or end of a property | |
8779 drawer, offer property commands. | |
8780 @item | |
8781 If the cursor is in a plain list item with a checkbox, toggle the status | |
8782 of the checkbox. | |
8783 @item | |
8784 If the cursor is on a numbered item in a plain list, renumber the | |
8785 ordered list. | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8786 @item |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8787 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
|
8788 block is updated. |
84308 | 8789 @end itemize |
8790 | |
8791 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous | |
8792 @section A cleaner outline view | |
8793 @cindex hiding leading stars | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8794 @cindex dynamic indentation |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8795 @cindex odd-levels-only outlines |
84308 | 8796 @cindex clean outline view |
8797 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8798 Some people find it noisy and distracting that the Org headlines are starting |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8799 with a potentially large number of stars, and that text below the headlines |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8800 is not indented. This is not really a problem when you are writing a book |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8801 where the outline headings are really section headlines. However, in a more |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8802 list-oriented outline, it is clear that an indented structure is a lot |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8803 cleaner, as can be seen by comparing the two columns in the following |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
8804 example: |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8805 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8806 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8807 @group |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8808 * Top level headline | * Top level headline |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8809 ** Second level | * Second level |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8810 *** 3rd level | * 3rd level |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8811 some text | some text |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8812 *** 3rd level | * 3rd level |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8813 more text | more text |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8814 * Another top level headline | * Another top level headline |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8815 @end group |
84308 | 8816 @end example |
8817 | |
8818 @noindent | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8819 It is non-trivial to make such a look work in Emacs, but Org contains three |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8820 separate features that, combined, achieve just that. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8821 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8822 @enumerate |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
8823 @item |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8824 @emph{Indentation of text below headlines}@* |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8825 You may indent text below each headline to make the left boundary line up |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8826 with the headline, like |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8827 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8828 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8829 *** 3rd level |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8830 more text, now indented |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8831 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8832 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8833 A good way to get this indentation is by hand, and Org supports this with |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8834 paragraph filling, line wrapping, and structure editing@footnote{See also the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8835 variable @code{org-adapt-indentation}.} preserving or adapting the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8836 indentation appropriate. A different approach would be to have a way to |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8837 automatically indent lines according to outline structure by adding overlays |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8838 or text properties. But I have not yet found a robust and efficient way to |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8839 do this in large files. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8840 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8841 @item |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8842 @emph{Hiding leading stars}@* You can modify the display in such a way that |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8843 all leading stars become invisible. To do this in a global way, configure |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8844 the variable @code{org-hide-leading-stars} or change this on a per-file basis |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8845 with |
84308 | 8846 |
8847 @example | |
8848 #+STARTUP: hidestars | |
8849 @end example | |
8850 | |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
8851 @noindent |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
8852 Note that the opposite behavior is selected with @code{showstars}. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
8853 |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8854 With hidden stars, the tree becomes: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8855 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8856 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8857 @group |
84308 | 8858 * Top level headline |
8859 * Second level | |
8860 * 3rd level | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8861 ... |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8862 @end group |
84308 | 8863 @end example |
8864 | |
8865 @noindent | |
8866 Note that the leading stars are not truly replaced by whitespace, they | |
8867 are only fontified with the face @code{org-hide} that uses the | |
8868 background color as font color. If you are not using either white or | |
8869 black background, you may have to customize this face to get the wanted | |
8870 effect. Another possibility is to set this font such that the extra | |
8871 stars are @i{almost} invisible, for example using the color | |
8872 @code{grey90} on a white background. | |
8873 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8874 @item |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8875 Things become cleaner still if you skip all the even levels and use only odd |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8876 levels 1, 3, 5..., effectively adding two stars to go from one outline level |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8877 to the next. In this way we get the outline view shown at the beginning of |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8878 this section. In order to make the structure editing and export commands |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8879 handle this convention correctly, configure the variable |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8880 @code{org-odd-levels-only}, or set this on a per-file basis with one of the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8881 following lines: |
84308 | 8882 |
8883 @example | |
8884 #+STARTUP: odd | |
8885 #+STARTUP: oddeven | |
8886 @end example | |
8887 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8888 You can convert an Org file from single-star-per-level to the |
84308 | 8889 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels |
8890 RET} in that file. The reverse operation is @kbd{M-x | |
8891 org-convert-to-oddeven-levels}. | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8892 @end enumerate |
84308 | 8893 |
8894 @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
|
8895 @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
|
8896 @cindex tty key bindings |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8897 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8898 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
|
8899 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
|
8900 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
|
8901 @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
|
8902 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
|
8903 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
|
8904 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
|
8905 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
|
8906 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
|
8907 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
|
8908 tty you would rather use @kbd{C-c .} to re-insert the timestamp. |
84308 | 8909 |
8910 @multitable @columnfractions 0.15 0.2 0.2 | |
8911 @item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2} | |
8912 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab | |
8913 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{@key{Esc} @key{left}} | |
8914 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab | |
99139
8fa7ef477c04
2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
98649
diff
changeset
|
8915 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x i} @tab @kbd{@key{Esc} @key{right}} |
84308 | 8916 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab |
8917 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{@key{Esc} @key{up}} | |
8918 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab | |
8919 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{@key{Esc} @key{down}} | |
8920 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab | |
8921 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab | |
8922 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{@key{Esc} @key{RET}} | |
8923 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab | |
8924 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab | |
8925 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab | |
8926 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab | |
8927 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab | |
8928 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab | |
8929 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab | |
8930 @end multitable | |
8931 | |
8932 @node Interaction, Bugs, TTY keys, Miscellaneous | |
8933 @section Interaction with other packages | |
8934 @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
|
8935 Org lives in the world of GNU Emacs and interacts in various ways |
84308 | 8936 with other code out there. |
8937 | |
8938 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8939 * Cooperation:: Packages Org cooperates with |
84308 | 8940 * Conflicts:: Packages that lead to conflicts |
8941 @end menu | |
8942 | |
8943 @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
|
8944 @subsection Packages that Org cooperates with |
84308 | 8945 |
8946 @table @asis | |
8947 @cindex @file{calc.el} | |
8948 @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
|
8949 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
|
8950 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
|
8951 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
|
8952 @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
|
8953 been installed properly. As of Emacs 22, Calc is part of the Emacs |
84308 | 8954 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
|
8955 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
|
8956 , Embedded Mode, Calc, GNU Emacs Calc Manual}. |
84308 | 8957 @cindex @file{constants.el} |
8958 @item @file{constants.el} by Carsten Dominik | |
8959 In a table formula (@pxref{The spreadsheet}), it is possible to use | |
8960 names for natural constants or units. Instead of defining your own | |
8961 constants in the variable @code{org-table-formula-constants}, install | |
8962 the @file{constants} package which defines a large number of constants | |
8963 and units, and lets you use unit prefixes like @samp{M} for | |
8964 @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
|
8965 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for |
84308 | 8966 the function @code{constants-get}, which has to be autoloaded in your |
8967 setup. See the installation instructions in the file | |
8968 @file{constants.el}. | |
8969 @item @file{cdlatex.el} by Carsten Dominik | |
8970 @cindex @file{cdlatex.el} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8971 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
|
8972 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
|
8973 @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
|
8974 @cindex @file{imenu.el} |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8975 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
|
8976 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
|
8977 @lisp |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
8978 (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
|
8979 (lambda () (imenu-add-to-menubar "Imenu"))) |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8980 @end lisp |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8981 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
|
8982 the option @code{org-imenu-depth}. |
84308 | 8983 @item @file{remember.el} by John Wiegley |
8984 @cindex @file{remember.el} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8985 Org cooperates with remember, see @ref{Remember}. |
84308 | 8986 @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
|
8987 @item @file{speedbar.el} by Eric M. Ludlam |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8988 @cindex @file{speedbar.el} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8989 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
|
8990 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
|
8991 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
|
8992 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
|
8993 the command @kbd{<} in the Speedbar frame. |
84308 | 8994 @cindex @file{table.el} |
8995 @item @file{table.el} by Takaaki Ota | |
8996 @kindex C-c C-c | |
8997 @cindex table editor, @file{table.el} | |
8998 @cindex @file{table.el} | |
8999 | |
9000 Complex ASCII tables with automatic line wrapping, column- and | |
9001 row-spanning, and alignment can be created using the Emacs table | |
9002 package by Takaaki Ota (@uref{http://sourceforge.net/projects/table}, | |
9003 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
|
9004 When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org mode |
84308 | 9005 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
|
9006 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
|
9007 to execute Org mode-related commands, leave the table. |
84308 | 9008 |
9009 @table @kbd | |
9010 @kindex C-c C-c | |
9011 @item C-c C-c | |
9012 Recognize @file{table.el} table. Works when the cursor is in a | |
9013 table.el table. | |
9014 @c | |
9015 @kindex C-c ~ | |
9016 @item C-c ~ | |
9017 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
|
9018 command converts it between the table.el format and the Org mode |
84308 | 9019 format. See the documentation string of the command |
9020 @code{org-convert-table} for the restrictions under which this is | |
9021 possible. | |
9022 @end table | |
9023 @file{table.el} is part of Emacs 22. | |
9024 @cindex @file{footnote.el} | |
9025 @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
|
9026 Org mode recognizes numerical footnotes as provided by this package |
84308 | 9027 (@pxref{Footnotes}). |
9028 @end table | |
9029 | |
9030 @node Conflicts, , Cooperation, Interaction | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9031 @subsection Packages that lead to conflicts with Org mode |
84308 | 9032 |
9033 @table @asis | |
9034 | |
9035 @cindex @file{allout.el} | |
9036 @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
|
9037 Startup of Org may fail with the error message |
84308 | 9038 @code{(wrong-type-argument keymapp nil)} when there is an outdated |
9039 version @file{allout.el} on the load path, for example the version | |
9040 distributed with Emacs 21.x. Upgrade to Emacs 22 and this problem will | |
9041 disappear. If for some reason you cannot do this, make sure that org.el | |
9042 is loaded @emph{before} @file{allout.el}, for example by putting | |
9043 @code{(require 'org)} early enough into your @file{.emacs} file. | |
9044 | |
9045 @cindex @file{CUA.el} | |
9046 @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
|
9047 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
|
9048 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
|
9049 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
|
9050 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
|
9051 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
|
9052 in the agenda buffer (but not during date selection). |
84308 | 9053 |
9054 @example | |
9055 S-UP -> M-p S-DOWN -> M-n | |
9056 S-LEFT -> M-- S-RIGHT -> M-+ | |
9057 @end example | |
9058 | |
9059 Yes, these are unfortunately more difficult to remember. If you want | |
9060 to have other replacement keys, look at the variable | |
9061 @code{org-disputed-keys}. | |
9062 @item @file{windmove.el} by Hovav Shacham | |
9063 @cindex @file{windmove.el} | |
9064 Also this package uses the @kbd{S-<cursor>} keys, so everything written | |
9065 in the paragraph above about CUA mode also applies here. | |
9066 | |
9067 @cindex @file{footnote.el} | |
9068 @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
|
9069 Org supports the syntax of the footnote package, but only the |
84308 | 9070 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
|
9071 commands, @kbd{C-c !} is already used by Org. You could use the |
84308 | 9072 variable @code{footnote-prefix} to switch footnotes commands to another |
9073 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
|
9074 @code{org-disputed-keys} to change the settings in Org. |
84308 | 9075 |
9076 @end table | |
9077 | |
9078 | |
9079 @node Bugs, , Interaction, Miscellaneous | |
9080 @section Bugs | |
9081 @cindex bugs | |
9082 | |
9083 Here is a list of things that should work differently, but which I | |
9084 have found too hard to fix. | |
9085 | |
9086 @itemize @bullet | |
9087 @item | |
9088 If a table field starts with a link, and if the corresponding table | |
9089 column is narrowed (@pxref{Narrow columns}) to a width too small to | |
9090 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
|
9091 not. To prevent this, Org throws an error. The work-around is to |
84308 | 9092 make the column wide enough to fit the link, or to add some text (at |
9093 least 2 characters) before the link in the same field. | |
9094 @item | |
9095 Narrowing table columns does not work on XEmacs, because the | |
9096 @code{format} function does not transport text properties. | |
9097 @item | |
9098 Text in an entry protected with the @samp{QUOTE} keyword should not | |
9099 autowrap. | |
9100 @item | |
9101 When the application called by @kbd{C-c C-o} to open a file link fails | |
9102 (for example because the application does not exist or refuses to open | |
9103 the file), it does so silently. No error message is displayed. | |
9104 @item | |
9105 Recalculating a table line applies the formulas from left to right. | |
9106 If a formula uses @emph{calculated} fields further down the row, | |
9107 multiple recalculation may be needed to get all fields consistent. You | |
9108 may use the command @code{org-table-iterate} (@kbd{C-u C-c *}) to | |
9109 recalculate until convergence. | |
9110 @item | |
9111 The exporters work well, but could be made more efficient. | |
9112 @end itemize | |
9113 | |
9114 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9115 @node Extensions, Hacking, Miscellaneous, Top |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9116 @appendix Extensions |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9117 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9118 This appendix lists the extension modules that have been written for Org. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9119 Many of these extensions live in the @file{contrib} directory of the Org |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9120 distribution, others are available somewhere on the web. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9121 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9122 @menu |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9123 * Extensions in the contrib directory:: These come with the Org distro |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9124 * Other extensions:: These you have to find on the web. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9125 @end menu |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9126 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9127 @node Extensions in the contrib directory, Other extensions, Extensions, Extensions |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9128 @section Extensions in the @file{contrib} directory |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9129 |
99851
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
9130 A number of extension are distributed with Org when you download it from its |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
9131 homepage. Please note that these extensions are @emph{not} distributed as |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
9132 part of Emacs, so if you use Org as delivered with Emacs, you still need to |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
9133 go to @url{http://orgmode.org} to get access to these modules. |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
9134 |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9135 @table @asis |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9136 @item @file{org-annotate-file.el} by @i{Philip Jackson} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9137 Annotate a file with org syntax, in a separate file, with links back to |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9138 the annotated file. |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
9139 @item @file{org-annotation-helper.el} by @i{Bastien Guerry and Daniel E. German} |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9140 Call @i{remember} directly from Firefox/Opera, or from Adobe Reader. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9141 When activating a special link or bookmark, Emacs receives a trigger to |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9142 create a note with a link back to the website. Requires some setup, a |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9143 detailes description is in |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9144 @file{contrib/packages/org-annotation-helper}. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9145 @item @file{org-bookmark.el} by @i{Tokuya Kameshima} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9146 Support for links to Emacs bookmarks. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9147 @item @file{org-depend.el} by @i{Carsten Dominik} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9148 TODO dependencies for Org-mode. Make TODO state changes in one entry |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9149 trigger changes in another, or be blocked by the state of another |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9150 entry. Also, easily create chains of TODO items with exactly one |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9151 active item at any time. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9152 @item @file{org-elisp-symbol.el} by @i{Bastien Guerry} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9153 Org links to emacs-lisp symbols. This can create annotated links that |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9154 exactly point to the definition location of a variable of function. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9155 @item @file{org-eval.el} by @i{Carsten Dominik} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9156 The @code{<lisp>} tag, adapted from Emacs Wiki and Emacs Muse, allows |
99868
404f28130174
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
99851
diff
changeset
|
9157 text to be included in a document that is the result of evaluating some |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9158 code. Other scripting languages like @code{perl} can be supported with |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9159 this package as well. |
99851
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
9160 @item @file{org-eval-light.el} by @i{Eric Schulte} |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
9161 User-controlled evaluation of code in an Org buffer. |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
9162 @item @file{org-exp-blocks.el} by @i{Eric Schulte} |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
9163 Preprocess user-defined blocks for export. |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9164 @item @file{org-expiry.el} by @i{Bastien Guerry} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9165 Expiry mechanism for Org entries. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9166 @item @file{org-indent.el} by @i{Carsten Dominik} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9167 Dynamic indentation of Org outlines. The plan is to indent an outline |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9168 according to level, but so far this is too hard for a proper and stable |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9169 implementation. Still, it works somewhat. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9170 @item @file{org-interactive-query.el} by @i{Christopher League} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9171 Interactive modification of tags queries. After running a general |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9172 query in Org, this package allows to narrow down the results by adding |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9173 more tags or keywords. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9174 @item @file{org-mairix.el} by @i{Georg C. F. Greve} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9175 Hook mairix search into Org for different MUAs. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9176 @item @file{org-man.el} by @i{Carsten Dominik} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9177 Support for links to manpages in Org-mode. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9178 @item @file{org-mtags.el} by @i{Carsten Dominik} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9179 Support for some Muse-like tags in Org-mode. This package allows you |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9180 to write @code{<example>} and @code{<src>} and other syntax copied from |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9181 Emacs Muse, right inside an Org file. The goal here is to make it easy |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9182 to publish the same file using either org-publish or Muse. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9183 @item @file{org-panel.el} by @i{Lennard Borgman} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9184 Simplified and display-aided access to some Org commands. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9185 @item @file{org-registry.el} by @i{Bastien Guerry} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9186 A registry for Org links, to find out from where links point to a given |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9187 file or location. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9188 @item @file{org2rem.el} by @i{Bastien Guerry} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9189 Convert org appointments into reminders for the @file{remind} program. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9190 @item @file{org-screen.el} by @i{Andrew Hyatt} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9191 Visit screen sessions through Org-mode links. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9192 @item @file{org-toc.el} by @i{Bastien Guerry} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9193 Table of contents in a separate buffer, with fast access to sections |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9194 and easy visibility cycling. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9195 @item @file{orgtbl-sqlinsert.el} by @i{Jason Riedy} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9196 Convert Org-mode tables to SQL insertions. Documentation for this can |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9197 be found on the Worg pages. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9198 @end table |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9199 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9200 @node Other extensions, , Extensions in the contrib directory, Extensions |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9201 @section Other extensions |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9202 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9203 @i{TO BE DONE} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9204 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9205 @node Hacking, History and Acknowledgments, Extensions, Top |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9206 @appendix Hacking |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9207 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9208 This appendix 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
|
9209 Org. |
84308 | 9210 |
9211 @menu | |
9212 * Adding hyperlink types:: New custom link types | |
9213 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs | |
9214 * Dynamic blocks:: Automatically filled blocks | |
9215 * Special agenda views:: Customized views | |
9216 * Using the property API:: Writing programs that use entry properties | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9217 * Using the mapping API:: Mapping over all or selected entries |
84308 | 9218 @end menu |
9219 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9220 @node Adding hyperlink types, Tables in arbitrary syntax, Hacking, Hacking |
84308 | 9221 @section Adding hyperlink types |
9222 @cindex hyperlinks, adding new types | |
9223 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9224 Org has a large number of hyperlink types built-in |
84308 | 9225 (@pxref{Hyperlinks}). If you would like to add new link types, it |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
9226 provides an interface for doing so. Let's look at an example file |
84308 | 9227 @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
|
9228 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside |
84308 | 9229 emacs: |
9230 | |
9231 @lisp | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9232 ;;; org-man.el - Support for links to manpages in Org |
84308 | 9233 |
9234 (require 'org) | |
9235 | |
9236 (org-add-link-type "man" 'org-man-open) | |
9237 (add-hook 'org-store-link-functions 'org-man-store-link) | |
9238 | |
9239 (defcustom org-man-command 'man | |
9240 "The Emacs command to be used to display a man page." | |
9241 :group 'org-link | |
9242 :type '(choice (const man) (const woman))) | |
9243 | |
9244 (defun org-man-open (path) | |
9245 "Visit the manpage on PATH. | |
9246 PATH should be a topic that can be thrown at the man command." | |
9247 (funcall org-man-command path)) | |
9248 | |
9249 (defun org-man-store-link () | |
9250 "Store a link to a manpage." | |
9251 (when (memq major-mode '(Man-mode woman-mode)) | |
9252 ;; This is a man page, we do make this link | |
9253 (let* ((page (org-man-get-page-name)) | |
9254 (link (concat "man:" page)) | |
9255 (description (format "Manpage for %s" page))) | |
9256 (org-store-link-props | |
9257 :type "man" | |
9258 :link link | |
9259 :description description)))) | |
9260 | |
9261 (defun org-man-get-page-name () | |
9262 "Extract the page name from the buffer name." | |
9263 ;; This works for both `Man-mode' and `woman-mode'. | |
9264 (if (string-match " \\(\\S-+\\)\\*" (buffer-name)) | |
9265 (match-string 1 (buffer-name)) | |
9266 (error "Cannot create link to this man page"))) | |
9267 | |
9268 (provide 'org-man) | |
9269 | |
9270 ;;; org-man.el ends here | |
9271 @end lisp | |
9272 | |
9273 @noindent | |
9274 You would activate this new link type in @file{.emacs} with | |
9275 | |
9276 @lisp | |
9277 (require 'org-man) | |
9278 @end lisp | |
9279 | |
9280 @noindent | |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
9281 Let's go through the file and see what it does. |
84308 | 9282 @enumerate |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
9283 @item |
84308 | 9284 It does @code{(require 'org)} to make sure that @file{org.el} has been |
9285 loaded. | |
9286 @item | |
9287 The next line calls @code{org-add-link-type} to define a new link type | |
9288 with prefix @samp{man}. The call also contains the name of a function | |
9289 that will be called to follow such a link. | |
9290 @item | |
9291 The next line adds a function to @code{org-store-link-functions}, in | |
9292 order to allow the command @kbd{C-c l} to record a useful link in a | |
9293 buffer displaying a man page. | |
9294 @end enumerate | |
9295 | |
9296 The rest of the file defines the necessary variables and functions. | |
9297 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
|
9298 command should be used to display man pages. There are two options, |
84308 | 9299 @code{man} and @code{woman}. Then the function to follow a link is |
9300 defined. It gets the link path as an argument - in this case the link | |
9301 path is just a topic for the manual command. The function calls the | |
9302 value of @code{org-man-command} to display the man page. | |
9303 | |
9304 Finally the function @code{org-man-store-link} is defined. When you try | |
9305 to store a link with @kbd{C-c l}, also this function will be called to | |
9306 try to make a link. The function must first decide if it is supposed to | |
9307 create the link for this buffer type, we do this by checking the value | |
9308 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
|
9309 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
|
9310 manual topic from the buffer name and prefixing it with the string |
84308 | 9311 @samp{man:}. Then it must call the command @code{org-store-link-props} |
9312 and set the @code{:type} and @code{:link} properties. Optionally you | |
9313 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
|
9314 the link description when the link is later inserted into an Org |
84308 | 9315 buffer with @kbd{C-c C-l}. |
9316 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9317 @node Tables in arbitrary syntax, Dynamic blocks, Adding hyperlink types, Hacking |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9318 @section Tables and lists in arbitrary syntax |
84308 | 9319 @cindex tables, in other modes |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9320 @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
|
9321 @cindex Orgtbl mode |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9322 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9323 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a |
84308 | 9324 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
|
9325 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
|
9326 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
|
9327 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
|
9328 editor. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9329 |
84308 | 9330 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9331 This appendix describes a different approach. We keep the Orgtbl mode |
84308 | 9332 table in its native format (the @i{source table}), and use a custom |
9333 function to @i{translate} the table to the correct syntax, and to | |
9334 @i{install} it in the right location (the @i{target table}). This puts | |
9335 the burden of writing conversion functions on the user, but it allows | |
9336 for a very flexible system. | |
9337 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9338 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
|
9339 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
|
9340 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
|
9341 or Texinfo.) |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9342 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9343 |
84308 | 9344 @menu |
9345 * Radio tables:: Sending and receiving | |
9346 * A LaTeX example:: Step by step, almost a tutorial | |
9347 * 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
|
9348 * Radio lists:: Doing the same for lists |
84308 | 9349 @end menu |
9350 | |
9351 @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax | |
9352 @subsection Radio tables | |
9353 @cindex radio tables | |
9354 | |
9355 To define the location of the target table, you first need to create two | |
9356 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
|
9357 Orgtbl mode to find. Orgtbl mode will insert the translated table |
84308 | 9358 between these lines, replacing whatever was there before. For example: |
9359 | |
9360 @example | |
9361 /* BEGIN RECEIVE ORGTBL table_name */ | |
9362 /* END RECEIVE ORGTBL table_name */ | |
9363 @end example | |
9364 | |
9365 @noindent | |
9366 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
|
9367 Orgtbl mode how to translate this table and where to install it. For |
84308 | 9368 example: |
9369 @example | |
9370 #+ORGTBL: SEND table_name translation_function arguments.... | |
9371 @end example | |
9372 | |
9373 @noindent | |
9374 @code{table_name} is the reference name for the table that is also used | |
9375 in the receiver lines. @code{translation_function} is the Lisp function | |
9376 that does the translation. Furthermore, the line can contain a list of | |
9377 arguments (alternating key and value) at the end. The arguments will be | |
9378 passed as a property list to the translation function for | |
9379 interpretation. A few standard parameters are already recognized and | |
9380 acted upon before the translation function is called: | |
9381 | |
9382 @table @code | |
9383 @item :skip N | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9384 Skip the first N lines of the table. Hlines do count as separate lines for |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9385 this parameter! |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9386 |
84308 | 9387 @item :skipcols (n1 n2 ...) |
9388 List of columns that should be skipped. If the table has a column with | |
9389 calculation marks, that column is automatically discarded as well. | |
9390 Please note that the translator function sees the table @emph{after} the | |
9391 removal of these columns, the function never knows that there have been | |
9392 additional columns. | |
9393 @end table | |
9394 | |
9395 @noindent | |
9396 The one problem remaining is how to keep the source table in the buffer | |
9397 without disturbing the normal workings of the file, for example during | |
9398 compilation of a C file or processing of a La@TeX{} file. There are a | |
9399 number of different solutions: | |
9400 | |
9401 @itemize @bullet | |
9402 @item | |
9403 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
|
9404 language. For example, in C mode you could wrap the table between |
84308 | 9405 @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
|
9406 @item |
84308 | 9407 Sometimes it is possible to put the table after some kind of @i{END} |
9408 statement, for example @samp{\bye} in TeX and @samp{\end@{document@}} | |
9409 in La@TeX{}. | |
9410 @item | |
9411 You can just comment the table line by line whenever you want to process | |
9412 the file, and uncomment it whenever you need to edit the table. This | |
9413 only sounds tedious - the command @kbd{M-x orgtbl-toggle-comment} does | |
9414 make this comment-toggling very easy, in particular if you bind it to a | |
9415 key. | |
9416 @end itemize | |
9417 | |
9418 @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
|
9419 @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
|
9420 @cindex LaTeX, and Orgtbl mode |
84308 | 9421 |
9422 The best way to wrap the source table in La@TeX{} is to use the | |
9423 @code{comment} environment provided by @file{comment.sty}. It has to be | |
9424 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
|
9425 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
|
9426 default this works only for La@TeX{}, HTML, and Texinfo. Configure the |
84308 | 9427 variable @code{orgtbl-radio-tables} to install templates for other |
9428 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will | |
9429 be prompted for a table name, lets say we use @samp{salesfigures}. You | |
9430 will then get the following template: | |
9431 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9432 @cindex #+ORGTBL: SEND |
84308 | 9433 @example |
9434 % BEGIN RECEIVE ORGTBL salesfigures | |
9435 % END RECEIVE ORGTBL salesfigures | |
9436 \begin@{comment@} | |
9437 #+ORGTBL: SEND salesfigures orgtbl-to-latex | |
9438 | | | | |
9439 \end@{comment@} | |
9440 @end example | |
9441 | |
9442 @noindent | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9443 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function |
84308 | 9444 @code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it |
9445 into the receiver location with name @code{salesfigures}. You may now | |
9446 fill in the table, feel free to use the spreadsheet features@footnote{If | |
9447 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
|
9448 this may cause problems with font-lock in LaTeX mode. As shown in the |
84308 | 9449 example you can fix this by adding an extra line inside the |
9450 @code{comment} environment that is used to balance the dollar | |
9451 expressions. If you are using AUCTeX with the font-latex library, a | |
9452 much better solution is to add the @code{comment} environment to the | |
9453 variable @code{LaTeX-verbatim-environments}.}: | |
9454 | |
9455 @example | |
9456 % BEGIN RECEIVE ORGTBL salesfigures | |
9457 % END RECEIVE ORGTBL salesfigures | |
9458 \begin@{comment@} | |
9459 #+ORGTBL: SEND salesfigures orgtbl-to-latex | |
9460 | Month | Days | Nr sold | per day | | |
9461 |-------+------+---------+---------| | |
9462 | Jan | 23 | 55 | 2.4 | | |
9463 | Feb | 21 | 16 | 0.8 | | |
9464 | March | 22 | 278 | 12.6 | | |
9465 #+TBLFM: $4=$3/$2;%.1f | |
9466 % $ (optional extra dollar to keep font-lock happy, see footnote) | |
9467 \end@{comment@} | |
9468 @end example | |
9469 | |
9470 @noindent | |
9471 When you are done, press @kbd{C-c C-c} in the table to get the converted | |
9472 table inserted between the two marker lines. | |
9473 | |
9474 Now lets assume you want to make the table header by hand, because you | |
9475 want to control how columns are aligned etc. In this case we make sure | |
9476 that the table translator does skip the first 2 lines of the source | |
9477 table, and tell the command to work as a @i{splice}, i.e. to not produce | |
9478 header and footer commands of the target table: | |
9479 | |
9480 @example | |
9481 \begin@{tabular@}@{lrrr@} | |
9482 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\ | |
9483 % BEGIN RECEIVE ORGTBL salesfigures | |
9484 % END RECEIVE ORGTBL salesfigures | |
9485 \end@{tabular@} | |
9486 % | |
9487 \begin@{comment@} | |
9488 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2 | |
9489 | Month | Days | Nr sold | per day | | |
9490 |-------+------+---------+---------| | |
9491 | Jan | 23 | 55 | 2.4 | | |
9492 | Feb | 21 | 16 | 0.8 | | |
9493 | March | 22 | 278 | 12.6 | | |
9494 #+TBLFM: $4=$3/$2;%.1f | |
9495 \end@{comment@} | |
9496 @end example | |
9497 | |
9498 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
|
9499 Orgtbl mode. It uses a @code{tabular} environment to typeset the table |
84308 | 9500 and marks horizontal lines with @code{\hline}. Furthermore, it |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9501 interprets the following parameters (see also @ref{Translator functions}): |
84308 | 9502 |
9503 @table @code | |
9504 @item :splice nil/t | |
9505 When set to t, return only table body lines, don't wrap them into a | |
9506 tabular environment. Default is nil. | |
9507 | |
9508 @item :fmt fmt | |
9509 A format to be used to wrap each field, should contain @code{%s} for the | |
9510 original field value. For example, to wrap each field value in dollars, | |
9511 you could use @code{:fmt "$%s$"}. This may also be a property list with | |
9512 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
|
9513 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
|
9514 function must return a formatted string. |
84308 | 9515 |
9516 @item :efmt efmt | |
9517 Use this format to print numbers with exponentials. The format should | |
9518 have @code{%s} twice for inserting mantissa and exponent, for example | |
9519 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This | |
9520 may also be a property list with column numbers and formats, for example | |
9521 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After | |
9522 @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
|
9523 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
|
9524 supplied instead of strings. |
84308 | 9525 @end table |
9526 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9527 @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax |
84308 | 9528 @subsection Translator functions |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9529 @cindex HTML, and Orgtbl mode |
84308 | 9530 @cindex translator function |
9531 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9532 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9533 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values) |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9534 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9535 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9536 code that produces tables during HTML export.}, these all use a generic |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9537 translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9538 itself is a very short function that computes the column definitions for the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9539 @code{tabular} environment, defines a few field and line separators and then |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9540 hands over to the generic translator. Here is the entire code: |
84308 | 9541 |
9542 @lisp | |
9543 @group | |
9544 (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
|
9545 "Convert the Orgtbl mode TABLE to LaTeX." |
84308 | 9546 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l")) |
9547 org-table-last-alignment "")) | |
9548 (params2 | |
9549 (list | |
9550 :tstart (concat "\\begin@{tabular@}@{" alignment "@}") | |
9551 :tend "\\end@{tabular@}" | |
9552 :lstart "" :lend " \\\\" :sep " & " | |
9553 :efmt "%s\\,(%s)" :hline "\\hline"))) | |
9554 (orgtbl-to-generic table (org-combine-plists params2 params)))) | |
9555 @end group | |
9556 @end lisp | |
9557 | |
9558 As you can see, the properties passed into the function (variable | |
9559 @var{PARAMS}) are combined with the ones newly defined in the function | |
9560 (variable @var{PARAMS2}). The ones passed into the function (i.e. the | |
9561 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you | |
9562 would like to use the La@TeX{} translator, but wanted the line endings to | |
9563 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just | |
9564 overrule the default with | |
9565 | |
9566 @example | |
9567 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]" | |
9568 @end example | |
9569 | |
9570 For a new language, you can either write your own converter function in | |
9571 analogy with the La@TeX{} translator, or you can use the generic function | |
9572 directly. For example, if you have a language where a table is started | |
9573 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are | |
9574 started with @samp{!BL!}, ended with @samp{!EL!} and where the field | |
9575 separator is a TAB, you could call the generic translator like this (on | |
9576 a single line!): | |
9577 | |
9578 @example | |
9579 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!" | |
9580 :lstart "!BL! " :lend " !EL!" :sep "\t" | |
9581 @end example | |
9582 | |
9583 @noindent | |
9584 Please check the documentation string of the function | |
9585 @code{orgtbl-to-generic} for a full list of parameters understood by | |
9586 that function and remember that you can pass each of them into | |
9587 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function | |
9588 using the generic function. | |
9589 | |
9590 Of course you can also write a completely new function doing complicated | |
9591 things the generic translator cannot do. A translator function takes | |
9592 two arguments. The first argument is the table, a list of lines, each | |
9593 line either the symbol @code{hline} or a list of fields. The second | |
9594 argument is the property list containing all parameters specified in the | |
9595 @samp{#+ORGTBL: SEND} line. The function must return a single string | |
9596 containing the formatted table. If you write a generally useful | |
9597 translator, please post it on @code{emacs-orgmode@@gnu.org} so that | |
9598 others can benefit from your work. | |
9599 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9600 @node Radio lists, , Translator functions, Tables in arbitrary syntax |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9601 @subsection Radio lists |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9602 @cindex radio lists |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9603 @cindex org-list-insert-radio-list |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9604 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9605 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
|
9606 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
|
9607 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
|
9608 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
|
9609 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
|
9610 calling @code{org-list-insert-radio-list}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9611 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9612 Here are the differences with radio tables: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9613 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9614 @itemize @minus |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9615 @item |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9616 Use @code{ORGLST} instead of @code{ORGTBL}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9617 @item |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9618 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
|
9619 parameters. |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
9620 @item |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9621 `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
|
9622 @end itemize |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9623 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9624 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
|
9625 La@TeX{} file: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9626 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9627 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9628 % BEGIN RECEIVE ORGLST to-buy |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9629 % END RECEIVE ORGLST to-buy |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9630 \begin@{comment@} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9631 #+ORGLIST: SEND to-buy orgtbl-to-latex |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9632 - a new house |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9633 - a new computer |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9634 + a new keyboard |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9635 + a new mouse |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9636 - a new life |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9637 \end@{comment@} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9638 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9639 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9640 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
|
9641 La@TeX{} list between the two marker lines. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9642 |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9643 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking |
84308 | 9644 @section Dynamic blocks |
9645 @cindex dynamic blocks | |
9646 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9647 Org documents can contain @emph{dynamic blocks}. These are |
84308 | 9648 specially marked regions that are updated by some user-written function. |
9649 A good example for such a block is the clock table inserted by the | |
9650 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}). | |
9651 | |
9652 Dynamic block are enclosed by a BEGIN-END structure that assigns a name | |
9653 to the block and can also specify parameters for the function producing | |
9654 the content of the block. | |
9655 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9656 #+BEGIN:dynamic block |
84308 | 9657 @example |
9658 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ... | |
9659 | |
9660 #+END: | |
9661 @end example | |
9662 | |
9663 Dynamic blocks are updated with the following commands | |
9664 | |
9665 @table @kbd | |
9666 @kindex C-c C-x C-u | |
9667 @item C-c C-x C-u | |
9668 Update dynamic block at point. | |
9669 @kindex C-u C-c C-x C-u | |
9670 @item C-u C-c C-x C-u | |
9671 Update all dynamic blocks in the current file. | |
9672 @end table | |
9673 | |
9674 Updating a dynamic block means to remove all the text between BEGIN and | |
9675 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
|
9676 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
|
9677 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
|
9678 extra parameter @code{:content}. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
9679 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
9680 For a block with name @code{myblock}, the writer function is |
84308 | 9681 @code{org-dblock-write:myblock} with as only parameter a property list |
9682 with the parameters given in the begin line. Here is a trivial example | |
9683 of a block that keeps track of when the block update function was last | |
9684 run: | |
9685 | |
9686 @example | |
9687 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M" | |
9688 | |
9689 #+END: | |
9690 @end example | |
9691 | |
9692 @noindent | |
9693 The corresponding block writer function could look like this: | |
9694 | |
9695 @lisp | |
9696 (defun org-dblock-write:block-update-time (params) | |
9697 (let ((fmt (or (plist-get params :format) "%d. %m. %Y"))) | |
9698 (insert "Last block update at: " | |
9699 (format-time-string fmt (current-time))))) | |
9700 @end lisp | |
9701 | |
9702 If you want to make sure that all dynamic blocks are always up-to-date, | |
9703 you could add the function @code{org-update-all-dblocks} to a hook, for | |
9704 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
|
9705 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
|
9706 @code{org-mode}. |
84308 | 9707 |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9708 @node Special agenda views, Using the property API, Dynamic blocks, Hacking |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9709 @section Special agenda views |
84308 | 9710 @cindex agenda views, user-defined |
9711 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9712 Org provides a special hook that can be used to narrow down the |
84308 | 9713 selection made by any of the agenda views. You may specify a function |
9714 that is used at each match to verify if the match should indeed be part | |
9715 of the agenda view, and if not, how much should be skipped. | |
9716 | |
9717 Let's say you want to produce a list of projects that contain a WAITING | |
9718 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
|
9719 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
|
9720 PROJECT. In this case you would run a TODO search for the keyword |
84308 | 9721 PROJECT, but skip the match unless there is a WAITING tag anywhere in |
9722 the subtree belonging to the project line. | |
9723 | |
9724 To achieve this, you must write a function that searches the subtree for | |
9725 the tag. If the tag is found, the function must return @code{nil} to | |
9726 indicate that this match should not be skipped. If there is no such | |
9727 tag, return the location of the end of the subtree, to indicate that | |
9728 search should continue from there. | |
9729 | |
9730 @lisp | |
9731 (defun my-skip-unless-waiting () | |
9732 "Skip trees that are not waiting" | |
9733 (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
|
9734 (if (re-search-forward ":waiting:" subtree-end t) |
84308 | 9735 nil ; tag found, do not skip |
9736 subtree-end))) ; tag not found, continue after end of subtree | |
9737 @end lisp | |
9738 | |
9739 Now you may use this function in an agenda custom command, for example | |
9740 like this: | |
9741 | |
9742 @lisp | |
9743 (org-add-agenda-custom-command | |
9744 '("b" todo "PROJECT" | |
99503
9d16e131644e
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99139
diff
changeset
|
9745 ((org-agenda-skip-function 'my-skip-unless-waiting) |
84308 | 9746 (org-agenda-overriding-header "Projects waiting for something: ")))) |
9747 @end lisp | |
9748 | |
9749 Note that this also binds @code{org-agenda-overriding-header} to get a | |
9750 meaningful header in the agenda view. | |
9751 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9752 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
|
9753 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
|
9754 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
|
9755 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
|
9756 have. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9757 |
84308 | 9758 You may also put a Lisp form into @code{org-agenda-skip-function}. In |
9759 particular, you may use the functions @code{org-agenda-skip-entry-if} | |
9760 and @code{org-agenda-skip-subtree-if} in this form, for example: | |
9761 | |
9762 @table @code | |
9763 @item '(org-agenda-skip-entry-if 'scheduled) | |
9764 Skip current entry if it has been scheduled. | |
9765 @item '(org-agenda-skip-entry-if 'notscheduled) | |
9766 Skip current entry if it has not been scheduled. | |
9767 @item '(org-agenda-skip-entry-if 'deadline) | |
9768 Skip current entry if it has a deadline. | |
9769 @item '(org-agenda-skip-entry-if 'scheduled 'deadline) | |
9770 Skip current entry if it has a deadline, or if it is scheduled. | |
9771 @item '(org-agenda-skip-entry 'regexp "regular expression") | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9772 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
|
9773 @item '(org-agenda-skip-entry 'notregexp "regular expression") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9774 Skip current entry unless the regular expression matches. |
84308 | 9775 @item '(org-agenda-skip-subtree-if 'regexp "regular expression") |
9776 Same as above, but check and skip the entire subtree. | |
9777 @end table | |
9778 | |
9779 Therefore we could also have written the search for WAITING projects | |
9780 like this, even without defining a special function: | |
9781 | |
9782 @lisp | |
9783 (org-add-agenda-custom-command | |
9784 '("b" todo "PROJECT" | |
9785 ((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
|
9786 'regexp ":waiting:")) |
84308 | 9787 (org-agenda-overriding-header "Projects waiting for something: ")))) |
9788 @end lisp | |
9789 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9790 @node Using the property API, Using the mapping API, Special agenda views, Hacking |
84308 | 9791 @section Using the property API |
9792 @cindex API, for properties | |
9793 @cindex properties, API | |
9794 | |
9795 Here is a description of the functions that can be used to work with | |
9796 properties. | |
9797 | |
9798 @defun org-entry-properties &optional pom which | |
9799 Get all properties of the entry at point-or-marker POM. | |
9800 This includes the TODO keyword, the tags, time strings for deadline, | |
9801 scheduled, and clocking, and any additional properties defined in the | |
9802 entry. The return value is an alist, keys may occur multiple times | |
9803 if the property key was used several times. | |
9804 POM may also be nil, in which case the current entry is used. | |
9805 If WHICH is nil or `all', get all properties. If WHICH is | |
9806 `special' or `standard', only get that subclass. | |
9807 @end defun | |
9808 @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
|
9809 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
|
9810 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
|
9811 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
|
9812 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
|
9813 @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
|
9814 @code{org-use-property-inheritance} selects PROPERTY for inheritance. |
84308 | 9815 @end defun |
9816 | |
9817 @defun org-entry-delete pom property | |
9818 Delete the property PROPERTY from entry at point-or-marker POM. | |
9819 @end defun | |
9820 | |
9821 @defun org-entry-put pom property value | |
9822 Set PROPERTY to VALUE for entry at point-or-marker POM. | |
9823 @end defun | |
9824 | |
9825 @defun org-buffer-property-keys &optional include-specials | |
9826 Get all property keys in the current buffer. | |
9827 @end defun | |
9828 | |
9829 @defun org-insert-property-drawer | |
9830 Insert a property drawer at point. | |
9831 @end defun | |
9832 | |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
9833 @defun org-entry-put-multivalued-property pom property &rest values |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
9834 Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
9835 strings. They will be concatenated, with spaces as separators. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
9836 @end defun |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
9837 |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
9838 @defun org-entry-get-multivalued-property pom property |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
9839 Treat the value of the property PROPERTY as a whitespace-separated list of |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
9840 values and return the values as a list of strings. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
9841 @end defun |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
9842 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9843 @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
|
9844 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
|
9845 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
|
9846 @end defun |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9847 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9848 @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
|
9849 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
|
9850 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
|
9851 @end defun |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9852 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9853 @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
|
9854 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
|
9855 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
|
9856 @end defun |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9857 |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9858 @node Using the mapping API, , Using the property API, Hacking |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9859 @section Using the mapping API |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9860 @cindex API, for mapping |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9861 @cindex mapping entries, API |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9862 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9863 Org has sophisticated mapping capabilities to find all entries satisfying |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9864 certain criteria. Internally, this functionality is used to produce agenda |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9865 views, but there is also an API that can be used to execute arbitrary |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9866 functions for each or selected entries. The main entry point for this API |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
9867 is: |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9868 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9869 @defun org-map-entries func &optional match scope &rest skip |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9870 Call FUNC at each headline selected by MATCH in SCOPE. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9871 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9872 FUNC is a function or a lisp form. The function will be called without |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9873 arguments, with the cursor positioned at the beginning of the headline. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9874 The return values of all calls to the function will be collected and |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9875 returned as a list. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9876 |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
9877 MATCH is a tags/property/todo match as it is used in the agenda match view. |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9878 Only headlines that are matched by this query will be considered during |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9879 the iteration. When MATCH is nil or t, all headlines will be |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9880 visited by the iteration. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9881 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9882 SCOPE determines the scope of this command. It can be any of: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9883 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9884 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9885 nil @r{the current buffer, respecting the restriction if any} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9886 tree @r{the subtree started with the entry at point} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9887 file @r{the current buffer, without restriction} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9888 file-with-archives |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9889 @r{the current buffer, and any archives associated with it} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9890 agenda @r{all agenda files} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9891 agenda-with-archives |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9892 @r{all agenda files with any archive files associated with them} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9893 (file1 file2 ...) |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9894 @r{if this is a list, all files in the list will be scanned} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9895 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9896 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9897 The remaining args are treated as settings for the skipping facilities of |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9898 the scanner. The following items can be given here: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9899 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9900 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9901 archive @r{skip trees with the archive tag} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9902 comment @r{skip trees with the COMMENT keyword} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9903 function or Lisp form |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9904 @r{will be used as value for @code{org-agenda-skip-function},} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9905 @r{so whenever the the function returns t, FUNC} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9906 @r{will not be called for that entry and search will} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9907 @r{continue from the point where the function leaves it} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9908 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9909 @end defun |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9910 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9911 The function given to that mapping routine can really do anything you like. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9912 It can uce the property API (@pxref{Using the property API}) to gather more |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9913 information about the entry, or in order to change metadate in the entry. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9914 Here are a couple of functions that might be handy: |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
9915 |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9916 @defun org-todo &optional arg |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9917 Change the TODO state of the entry, see the docstring of the functions for |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9918 the many possible values for the argument ARG. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9919 @end defun |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9920 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9921 @defun org-priority &optional action |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9922 Change the priority of the entry, see the docstring of this function for the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9923 possible values for ACTION. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9924 @end defun |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9925 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9926 @defun org-toggle-tag tag &optional onoff |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9927 Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9928 or @code{off} will not toggle tag, but ensure that it is either on or off. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9929 @end defun |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9930 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9931 @defun org-promote |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9932 Promote the current entry. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9933 @end defun |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9934 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9935 @defun org-demote |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9936 Demote the current entry. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9937 @end defun |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9938 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9939 Here is a simple example that will turn all entries in the current file with |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9940 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9941 Entries in comment trees and in archive trees will be ignored. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9942 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9943 @lisp |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9944 (org-map-entries |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9945 '(org-todo "UPCOMING") |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9946 "+TOMORROW" 'file 'archive 'comment) |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9947 @end lisp |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9948 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9949 The following example counts the number of entries with TODO keyword |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9950 @code{WAITING}, in all agenda files. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9951 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9952 @lisp |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
9953 (length (org-map-entries t "/+WAITING" 'agenda)) |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9954 @end lisp |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9955 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9956 @node History and Acknowledgments, Main Index, Hacking, Top |
84308 | 9957 @appendix History and Acknowledgments |
9958 @cindex acknowledgments | |
9959 @cindex history | |
9960 @cindex thanks | |
9961 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9962 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
|
9963 of the Emacs Outline mode. I was trying to organize my notes and |
84308 | 9964 projects, and using Emacs seemed to be the natural way to go. However, |
9965 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
|
9966 command, only to hide and show parts of the outline tree, that seemed |
84308 | 9967 entirely unacceptable to me. Also, when using outlines to take notes, I |
9968 constantly want to restructure the tree, organizing it parallel to my | |
9969 thoughts and plans. @emph{Visibility cycling} and @emph{structure | |
9970 editing} were originally implemented in the package | |
9971 @file{outline-magic.el}, but quickly moved to the more general | |
9972 @file{org.el}. As this environment became comfortable for project | |
9973 planning, the next step was adding @emph{TODO entries}, basic @emph{time | |
9974 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
|
9975 goals that Org still has today: To create a new, outline-based, |
84308 | 9976 plain text mode with innovative and intuitive editing features, and to |
9977 incorporate project planning functionality directly into a notes file. | |
9978 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9979 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
|
9980 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
|
9981 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
|
9982 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
|
9983 |
84308 | 9984 Since the first release, literally thousands of emails to me or on |
9985 @code{emacs-orgmode@@gnu.org} have provided a constant stream of bug | |
9986 reports, feedback, new ideas, and sometimes patches and add-on code. | |
9987 Many thanks to everyone who has helped to improve this package. I am | |
9988 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
|
9989 in shaping one or more aspects of Org. The list may not be |
84308 | 9990 complete, if I have forgotten someone, please accept my apologies and |
9991 let me know. | |
9992 | |
9993 @itemize @bullet | |
9994 | |
9995 @item | |
9996 @i{Russel Adams} came up with the idea for drawers. | |
9997 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9998 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}. |
84308 | 9999 @item |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
10000 @i{Christophe Bataillon} created the great unicorn logo that we use on the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
10001 Org-mode website. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
10002 @item |
84308 | 10003 @i{Alex Bochannek} provided a patch for rounding time stamps. |
10004 @item | |
10005 @i{Charles Cave}'s suggestion sparked the implementation of templates | |
10006 for Remember. | |
10007 @item | |
10008 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with | |
10009 specified time. | |
10010 @item | |
10011 @i{Gregory Chernov} patched support for lisp forms into table | |
10012 calculations and improved XEmacs compatibility, in particular by porting | |
10013 @file{nouline.el} to XEmacs. | |
10014 @item | |
10015 @i{Sacha Chua} suggested to copy some linking code from Planner. | |
10016 @item | |
10017 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also | |
10018 came up with the idea of properties, and that there should be an API for | |
10019 them. | |
10020 @item | |
10021 @i{Kees Dullemond} used to edit projects lists directly in HTML and so | |
10022 inspired some of the early development, including HTML export. He also | |
10023 asked for a way to narrow wide table columns. | |
10024 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
10025 @i{Christian Egli} converted the documentation into Texinfo format, |
84308 | 10026 patched CSS formatting into the HTML exporter, and inspired the agenda. |
10027 @item | |
10028 @i{David Emery} provided a patch for custom CSS support in exported | |
10029 HTML agendas. | |
10030 @item | |
10031 @i{Nic Ferrier} contributed mailcap and XOXO support. | |
10032 @item | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
10033 @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
|
10034 @item |
84308 | 10035 @i{John Foerch} figured out how to make incremental search show context |
10036 around a match in a hidden outline tree. | |
10037 @item | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
10038 @i{Niels Giesen} had the idea to automatically archive DONE trees. |
84308 | 10039 @item |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
10040 @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
|
10041 has been prolific with patches, ideas, and bug reports. |
84308 | 10042 @item |
10043 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages. | |
10044 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
10045 @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
|
10046 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
|
10047 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
|
10048 @item |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
10049 @i{Manuel Hermenegildo} has contributed various ideas, small fixed and |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
10050 patches. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
10051 @item |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
10052 @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
|
10053 @item |
84308 | 10054 @i{Scott Jaderholm} proposed footnotes, control over whitespace between |
10055 folded entries, and column view for properties. | |
10056 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
10057 @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
|
10058 @item |
84308 | 10059 @i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also |
10060 provided frequent feedback and some patches. | |
10061 @item | |
10062 @i{Jason F. McBrayer} suggested agenda export to CSV format. | |
10063 @item | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
10064 @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
|
10065 @item |
84308 | 10066 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file |
10067 basis. | |
10068 @item | |
10069 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler | |
10070 happy. | |
10071 @item | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
10072 @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
|
10073 and to be able to quickly restrict the agenda to a subtree. |
84308 | 10074 @item |
10075 @i{Todd Neal} provided patches for links to Info files and elisp forms. | |
10076 @item | |
10077 @i{Tim O'Callaghan} suggested in-file links, search options for general | |
10078 file links, and TAGS. | |
10079 @item | |
10080 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial | |
10081 into Japanese. | |
10082 @item | |
10083 @i{Oliver Oppitz} suggested multi-state TODO items. | |
10084 @item | |
10085 @i{Scott Otterson} sparked the introduction of descriptive text for | |
10086 links, among other things. | |
10087 @item | |
10088 @i{Pete Phillips} helped during the development of the TAGS feature, and | |
10089 provided frequent feedback. | |
10090 @item | |
10091 @i{T.V. Raman} reported bugs and suggested improvements. | |
10092 @item | |
10093 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality | |
10094 control. | |
10095 @item | |
10096 @i{Kevin Rogers} contributed code to access VM files on remote hosts. | |
10097 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
10098 @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
|
10099 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
|
10100 single key navigation. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
10101 @item |
84308 | 10102 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a |
10103 conflict with @file{allout.el}. | |
10104 @item | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
10105 @i{Jason Riedy} generalized the send-receive mechanism for orgtbl tables with |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
10106 extensive patches. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
10107 @item |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
10108 @i{Philip Rooke} created the Org reference card, provided lots |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
10109 of feedback, developed and applied standards to the Org documentation. |
84308 | 10110 @item |
10111 @i{Christian Schlauer} proposed angular brackets around links, among | |
10112 other things. | |
10113 @item | |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
10114 @i{Eric Schulte} wrote @file{org-plot.el}. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
10115 @item |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
10116 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s |
84308 | 10117 @file{organizer-mode.el}. |
10118 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
10119 @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
|
10120 @item |
99851
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
10121 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
10122 now packaged into Org's @file{contrib} directory. |
68981b04c1ac
2008-11-23 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
99709
diff
changeset
|
10123 @item |
84308 | 10124 @i{Daniel Sinder} came up with the idea of internal archiving by locking |
10125 subtrees. | |
10126 @item | |
10127 @i{Dale Smith} proposed link abbreviations. | |
10128 @item | |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
10129 @i{James TD Smith} has contributed a large number of patches for useful |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
10130 tweaks and features. |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
10131 @item |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
10132 @i{Adam Spiers} asked for global linking commands, inspired the link |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
10133 extension system, added support for mairix, and proposed the mapping API. |
84308 | 10134 @item |
100271
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
10135 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
10136 with links transformation to Org syntax. |
ba4358a5f1c6
2008-12-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents:
99868
diff
changeset
|
10137 @item |
84308 | 10138 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual |
10139 chapter about publishing. | |
10140 @item | |
10141 @i{J@"urgen Vollmer} contributed code generating the table of contents | |
10142 in HTML output. | |
10143 @item | |
10144 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE} | |
10145 keyword. | |
10146 @item | |
10147 @i{David Wainberg} suggested archiving, and improvements to the linking | |
10148 system. | |
10149 @item | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
10150 @i{John Wiegley} wrote @file{emacs-wiki.el}, @file{planner.el}, and |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
10151 @file{muse.el}, which have similar goals as Org. Initially the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
10152 development of Org was fully independent because I was not aware of the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
10153 existence of these packages. But with time I have accasionally looked |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
10154 at John's code and learned a lot from it. John has also contributed a |
98649
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
10155 number of great ideas and patches directly to Org, including the attachment |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
10156 system (@file{org-attach.el}) and integration with Apple Mail |
5796ed317137
Lots of minor fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
97382
diff
changeset
|
10157 (@file{org-mac-message.el}). |
84308 | 10158 @item |
10159 @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
|
10160 linking to Gnus. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
10161 @item |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
10162 @i{Roland Winkler} requested additional key bindings to make Org |
84308 | 10163 work on a tty. |
10164 @item | |
10165 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks | |
10166 and contributed various ideas and code snippets. | |
10167 @end itemize | |
10168 | |
10169 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
10170 @node Main Index, Key Index, History and Acknowledgments, Top |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
10171 @unnumbered The Main Index |
84308 | 10172 |
10173 @printindex cp | |
10174 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
10175 @node Key Index, , Main Index, Top |
84308 | 10176 @unnumbered Key Index |
10177 | |
10178 @printindex ky | |
10179 | |
10180 @bye | |
10181 | |
10182 @ignore | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
10183 arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac |
84308 | 10184 @end ignore |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
10185 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
10186 @c Local variables: |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
10187 @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
|
10188 @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
|
10189 @c fill-column: 77 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
10190 @c End: |
96976
86e1b62bcc3e
New version 6.06a.
Carsten Dominik <dominik@science.uva.nl>
parents:
96072
diff
changeset
|
10191 |