Mercurial > emacs
annotate doc/misc/org.texi @ 96072:2398ec3bc9c5
Fix typo (where -> were).
author | Stephen Eglen <stephen@gnu.org> |
---|---|
date | Wed, 18 Jun 2008 11:01:51 +0000 |
parents | d3e733e75a9d |
children | 86e1b62bcc3e |
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 |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6 @set VERSION 6.05a |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7 @set DATE June 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 | |
95933
b5e79026c857
Change to GFDL 1.2. Refer to license in Emacs manual.
Glenn Morris <rgm@gnu.org>
parents:
95874
diff
changeset
|
42 under the terms of the GNU Free Documentation License, Version 1.2 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,'' | |
96057 | 45 and with the Back-Cover Texts as in (a) below. A copy of the license |
46 is included in the section entitled ``GNU Free Documentation License.'' | |
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 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
90 * Remember:: Quickly adding nodes to the outline tree |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
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 |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
96 * Extensions:: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
97 * Hacking:: |
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 |
84308 | 138 |
139 The spreadsheet | |
140 | |
141 * References:: How to refer to another field or range | |
142 * Formula syntax for Calc:: Using Calc to compute stuff | |
143 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp | |
144 * Field formulas:: Formulas valid for a single field | |
145 * Column formulas:: Formulas valid for an entire column | |
146 * Editing and debugging formulas:: Fixing formulas | |
147 * Updating the table:: Recomputing all dependent fields | |
148 * Advanced features:: Field names, parameters and automatic recalc | |
149 | |
150 Hyperlinks | |
151 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
152 * Link format:: How links in Org are formatted |
84308 | 153 * Internal links:: Links to other places in the current file |
154 * External links:: URL-like links to the world | |
155 * 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
|
156 * Using links outside Org:: Linking from my C source code? |
84308 | 157 * Link abbreviations:: Shortcuts for writing complex links |
158 * Search options:: Linking to a specific location | |
159 * Custom searches:: When the default search is not enough | |
160 | |
161 Internal links | |
162 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
163 * 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
|
164 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
165 TODO Items |
84308 | 166 |
167 * TODO basics:: Marking and displaying TODO entries | |
168 * TODO extensions:: Workflow and assignments | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
169 * Progress logging:: Dates and notes for progress |
84308 | 170 * Priorities:: Some things are more important than others |
171 * Breaking down tasks:: Splitting a task into manageable pieces | |
172 * Checkboxes:: Tick-off lists | |
173 | |
174 Extended use of TODO keywords | |
175 | |
176 * Workflow states:: From TODO to DONE in steps | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
177 * TODO types:: I do this, Fred does the rest |
84308 | 178 * 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
|
179 * 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
|
180 * Per-file keywords:: Different files, different requirements |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
181 * Faces for TODO keywords:: Highlighting states |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
182 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
183 Progress logging |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
184 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
185 * Closing items:: When was this entry marked DONE? |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
186 * Tracking TODO state changes:: When did the status change? |
84308 | 187 |
188 Tags | |
189 | |
190 * Tag inheritance:: Tags use the tree structure of the outline | |
191 * Setting tags:: How to assign tags to a headline | |
192 * Tag searches:: Searching for combinations of tags | |
193 | |
194 Properties and Columns | |
195 | |
196 * 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
|
197 * Special properties:: Access to other Org mode features |
84308 | 198 * Property searches:: Matching property values |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
199 * Property inheritance:: Passing values down the tree |
84308 | 200 * Column view:: Tabular viewing and editing |
201 * Property API:: Properties for Lisp programmers | |
202 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
203 Column view |
84308 | 204 |
205 * Defining columns:: The COLUMNS format property | |
206 * 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
|
207 * 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
|
208 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
209 Defining columns |
84308 | 210 |
211 * Scope of column definitions:: Where defined, where valid? | |
212 * Column attributes:: Appearance and content of a column | |
213 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
214 Dates and Times |
84308 | 215 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
216 * Timestamps:: Assigning a time to a tree entry |
84308 | 217 * Creating timestamps:: Commands which insert timestamps |
218 * 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
|
219 * 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
|
220 * Effort estimates:: Planning work effort in advance |
84308 | 221 |
222 Creating timestamps | |
223 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
224 * 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
|
225 * 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
|
226 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
227 Deadlines and scheduling |
84308 | 228 |
229 * Inserting deadline/schedule:: Planning items | |
230 * Repeated tasks:: Items that show up again and again | |
231 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
232 Remember |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
233 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
234 * 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
|
235 * Remember templates:: Define the outline of different note types |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
236 * 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
|
237 * Refiling notes:: Moving a note or task to a project |
84308 | 238 |
239 Agenda Views | |
240 | |
241 * Agenda files:: Files being searched for agenda information | |
242 * Agenda dispatcher:: Keyboard access to agenda views | |
243 * Built-in agenda views:: What is available out of the box? | |
244 * 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
|
245 * Agenda commands:: Remote editing of Org trees |
84308 | 246 * 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
|
247 * Agenda column view:: Using column view for collected entries |
84308 | 248 |
249 The built-in agenda views | |
250 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
251 * Weekly/daily agenda:: The calendar page with current tasks |
84308 | 252 * Global TODO list:: All unfinished action items |
253 * Matching tags and properties:: Structured information with fine-tuned search | |
254 * 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
|
255 * Keyword search:: Finding entries by keyword |
84308 | 256 * Stuck projects:: Find projects you need to review |
257 | |
258 Presentation and sorting | |
259 | |
260 * Categories:: Not all tasks are equal | |
261 * Time-of-day specifications:: How the agenda knows the time | |
262 * Sorting of agenda items:: The order of things | |
263 | |
264 Custom agenda views | |
265 | |
266 * Storing searches:: Type once, use often | |
267 * Block agenda:: All the stuff you need in a single buffer | |
268 * 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
|
269 * 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
|
270 * Using the agenda elsewhere:: Using agenda information in other programs |
84308 | 271 |
272 Embedded LaTeX | |
273 | |
274 * 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
|
275 * Subscripts and superscripts:: Simple syntax for raising/lowering text |
84308 | 276 * LaTeX fragments:: Complex formulas made easy |
277 * Processing LaTeX fragments:: Previewing LaTeX processing | |
278 * CDLaTeX mode:: Speed up entering of formulas | |
279 | |
280 Exporting | |
281 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
282 * Markup rules:: Which structures are recognized? |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
283 * 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
|
284 * The export dispatcher:: How to access exporter commands |
84308 | 285 * ASCII export:: Exporting to plain ASCII |
286 * HTML export:: Exporting to HTML | |
287 * LaTeX export:: Exporting to LaTeX | |
288 * XOXO export:: Exporting to XOXO | |
289 * 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
|
290 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
291 Markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
292 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
293 * 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
|
294 * 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
|
295 * 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
|
296 * 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
|
297 * 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
|
298 * 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
|
299 * 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
|
300 * 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
|
301 * Tables exported:: Tables are exported richly |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
302 * Footnotes:: Numbers like [1] |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
303 * 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
|
304 * 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
|
305 * 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
|
306 * Comment lines:: Some lines will not be exported |
84308 | 307 |
308 HTML export | |
309 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
310 * 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
|
311 * Quoting HTML tags:: Using direct HTML in Org mode |
84308 | 312 * Links:: Transformation of links for HTML |
313 * Images:: How to include images | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
314 * 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
|
315 * Javascript support:: Info and Folding in a web browser |
84308 | 316 |
317 LaTeX export | |
318 | |
319 * LaTeX export commands:: How to invoke LaTeX export | |
320 * 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
|
321 * Sectioning structure:: Changing sectioning in LaTeX output |
84308 | 322 |
323 Publishing | |
324 | |
325 * Configuration:: Defining projects | |
326 * Sample configuration:: Example projects | |
327 * Triggering publication:: Publication commands | |
328 | |
329 Configuration | |
330 | |
331 * Project alist:: The central configuration variable | |
332 * Sources and destinations:: From here to there | |
333 * Selecting files:: What files are part of the project? | |
334 * Publishing action:: Setting the function doing the publishing | |
335 * Publishing options:: Tweaking HTML export | |
336 * Publishing links:: Which links keep working after publishing? | |
337 * Project page index:: Publishing a list of project files | |
338 | |
339 Sample configuration | |
340 | |
341 * Simple example:: One-component publishing | |
342 * Complex example:: A multi-component publishing example | |
343 | |
344 Miscellaneous | |
345 | |
346 * 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
|
347 * Customization:: Adapting Org to your taste |
84308 | 348 * In-buffer settings:: Overview of the #+KEYWORDS |
349 * The very busy C-c C-c key:: When in doubt, press C-c C-c | |
350 * 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
|
351 * TTY keys:: Using Org on a tty |
84308 | 352 * Interaction:: Other Emacs packages |
353 * Bugs:: Things which do not work perfectly | |
354 | |
355 Interaction with other packages | |
356 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
357 * Cooperation:: Packages Org cooperates with |
84308 | 358 * Conflicts:: Packages that lead to conflicts |
359 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
360 Extensions |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
361 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
362 * 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
|
363 * 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
|
364 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
365 Hacking |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
366 |
84308 | 367 * Adding hyperlink types:: New custom link types |
368 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs | |
369 * Dynamic blocks:: Automatically filled blocks | |
370 * Special agenda views:: Customized views | |
371 * 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
|
372 * Using the mapping API:: Mapping over all or selected entries |
84308 | 373 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
374 Tables and lists in arbitrary syntax |
84308 | 375 |
376 * Radio tables:: Sending and receiving | |
377 * A LaTeX example:: Step by step, almost a tutorial | |
378 * 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
|
379 * Radio lists:: Doing the same for lists |
84308 | 380 |
381 @end detailmenu | |
382 @end menu | |
383 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
384 @node Introduction, Document Structure, Top, Top |
84308 | 385 @chapter Introduction |
386 @cindex introduction | |
387 | |
388 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
389 * 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
|
390 * 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
|
391 * Activation:: How to activate Org for certain buffers |
84308 | 392 * Feedback:: Bug reports, ideas, patches etc. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
393 * Conventions:: Type-setting conventions in the manual |
84308 | 394 @end menu |
395 | |
396 @node Summary, Installation, Introduction, Introduction | |
397 @section Summary | |
398 @cindex summary | |
399 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
400 Org is a mode for keeping notes, maintaining TODO lists, and doing |
84308 | 401 project planning with a fast and effective plain-text system. |
402 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
403 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
|
404 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
|
405 implemented on top of Outline mode, which makes it possible to keep the |
84308 | 406 content of large files well structured. Visibility cycling and |
407 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
|
408 with a built-in table editor. Org supports TODO items, deadlines, |
84308 | 409 time stamps, and scheduling. It dynamically compiles entries into an |
410 agenda that utilizes and smoothly integrates much of the Emacs calendar | |
411 and diary. Plain text URL-like links connect to websites, emails, | |
412 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
|
413 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
|
414 structured ASCII file, as HTML, or (TODO and agenda items only) as an |
84308 | 415 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
|
416 linked web pages. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
417 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
418 An important design aspect that distinguishes Org from for example |
84308 | 419 Planner/Muse is that it encourages to store every piece of information |
420 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
|
421 other files, duplicating some information such as tasks. In Org, |
84308 | 422 you only have notes files. In your notes you mark entries as tasks, |
423 label them with tags and timestamps. All necessary lists like a | |
424 schedule for the day, the agenda for a meeting, tasks lists selected by | |
425 tags etc are created dynamically when you need them. | |
426 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
427 Org keeps simple things simple. When first fired up, it should |
84308 | 428 feel like a straightforward, easy to use outliner. Complexity is not |
429 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
|
430 it. Org is a toolbox and can be used in different ways, for |
84308 | 431 example as: |
432 | |
433 @example | |
434 @r{@bullet{} outline extension with visibility cycling and structure editing} | |
435 @r{@bullet{} ASCII system and table editor for taking structured notes} | |
436 @r{@bullet{} ASCII table editor with spreadsheet-like capabilities} | |
437 @r{@bullet{} TODO list editor} | |
438 @r{@bullet{} full agenda and planner with deadlines and work scheduling} | |
439 @r{@bullet{} environment to implement David Allen's GTD system} | |
440 @r{@bullet{} a basic database application} | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
441 @r{@bullet{} simple hypertext system, with HTML and LaTeX export} |
84308 | 442 @r{@bullet{} publishing tool to create a set of interlinked webpages} |
443 @end example | |
444 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
445 Org's automatic, context sensitive table editor with spreadsheet |
84308 | 446 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
|
447 minor Orgtbl mode. Using a translation step, it can be used to maintain |
84308 | 448 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
|
449 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
|
450 the minor Orgstruct mode. |
84308 | 451 |
452 @cindex FAQ | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
453 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
|
454 version of Org, as well as additional information, frequently asked |
84308 | 455 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
|
456 @uref{http://orgmode.org}. |
84308 | 457 |
458 @page | |
459 | |
460 | |
461 @node Installation, Activation, Summary, Introduction | |
462 @section Installation | |
463 @cindex installation | |
464 @cindex XEmacs | |
465 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
466 @b{Important:} @i{If Org is part of the Emacs distribution or an |
84308 | 467 XEmacs package, please skip this section and go directly to |
468 @ref{Activation}.} | |
469 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
470 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
|
471 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
|
472 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
|
473 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
|
474 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
|
475 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
|
476 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
|
477 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
|
478 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
|
479 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
480 @example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
481 (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
|
482 @end example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
483 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
484 @noindent |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
485 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
|
486 step for this directory: |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
487 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
488 @example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
489 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path)) |
84308 | 490 @end example |
491 | |
492 @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
|
493 the @file{xemacs} sub-directory of the Org distribution. Use the |
84308 | 494 command:} |
495 | |
496 @example | |
497 @b{make install-noutline} | |
498 @end example | |
499 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
500 @noindent Now byte-compile the Lisp files with the shell command: |
84308 | 501 |
502 @example | |
503 make | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
504 @end example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
505 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
506 @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
|
507 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
|
508 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
509 @example |
84308 | 510 make install |
511 make install-info | |
512 @end example | |
513 | |
514 @noindent Then add to @file{.emacs}: | |
515 | |
516 @lisp | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
517 ;; This line only if Org is not part of the X/Emacs distribution. |
84308 | 518 (require 'org-install) |
519 @end lisp | |
520 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
521 |
84308 | 522 @node Activation, Feedback, Installation, Introduction |
523 @section Activation | |
524 @cindex activation | |
525 @cindex autoload | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
526 @cindex global key bindings |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
527 @cindex key bindings, global |
84308 | 528 |
529 @iftex | |
530 @b{Important:} @i{If you use copy-and-paste to copy lisp code from the | |
531 PDF documentation as viewed by Acrobat reader to your .emacs file, the | |
532 single quote character comes out incorrectly and the code will not work. | |
533 You need to fix the single quotes by hand, or copy from Info | |
534 documentation.} | |
535 @end iftex | |
536 | |
537 Add the following lines to your @file{.emacs} file. The last two lines | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
538 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
|
539 @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
|
540 keys yourself. |
84308 | 541 |
542 @lisp | |
543 ;; The following lines are always needed. Choose your own keys. | |
544 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode)) | |
545 (global-set-key "\C-cl" 'org-store-link) | |
546 (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
|
547 (global-set-key "\C-cb" 'org-iswitchb) |
84308 | 548 @end lisp |
549 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
550 Furthermore, you must activate @code{font-lock-mode} in Org |
84308 | 551 buffers, because significant functionality depends on font-locking being |
552 active. You can do this with either one of the following two lines | |
553 (XEmacs user must use the second option): | |
554 @lisp | |
555 (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
|
556 (add-hook 'org-mode-hook 'turn-on-font-lock) ; Org buffers only |
84308 | 557 @end lisp |
558 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
559 @cindex Org mode, turning on |
84308 | 560 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
|
561 into Org mode. As an alternative, make the first line of a file look |
84308 | 562 like this: |
563 | |
564 @example | |
565 MY PROJECTS -*- mode: org; -*- | |
566 @end example | |
567 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
568 @noindent which will select Org mode for this buffer no matter what |
84308 | 569 the file's name is. See also the variable |
570 @code{org-insert-mode-line-in-empty-file}. | |
571 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
572 @node Feedback, Conventions, Activation, Introduction |
84308 | 573 @section Feedback |
574 @cindex feedback | |
575 @cindex bug reports | |
576 @cindex maintainer | |
577 @cindex author | |
578 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
579 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
|
580 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
|
581 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
|
582 moderator and then passed through to the list. |
84308 | 583 |
584 For bug reports, please provide as much information as possible, | |
585 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
|
586 @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
|
587 the Org related setup in @file{.emacs}. If an error occurs, a |
84308 | 588 backtrace can be very useful (see below on how to create one). Often a |
589 small example file helps, along with clear information about: | |
590 | |
591 @enumerate | |
592 @item What exactly did you do? | |
593 @item What did you expect to happen? | |
594 @item What happened instead? | |
595 @end enumerate | |
596 @noindent Thank you for helping to improve this mode. | |
597 | |
598 @subsubheading How to create a useful backtrace | |
599 | |
600 @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
|
601 If working with Org produces an error with a message you don't |
84308 | 602 understand, you may have hit a bug. The best way to report this is by |
603 providing, in addition to what was mentioned above, a @emph{Backtrace}. | |
604 This is information from the built-in debugger about where and how the | |
605 error occurred. Here is how to produce a useful backtrace: | |
606 | |
607 @enumerate | |
608 @item | |
609 Start a fresh Emacs or XEmacs, and make sure that it will load the | |
610 original Lisp code in @file{org.el} instead of the compiled version in | |
611 @file{org.elc}. The backtrace contains much more information if it is | |
612 produced with uncompiled code. To do this, either rename @file{org.elc} | |
613 to something else before starting Emacs, or ask Emacs explicitly to load | |
614 @file{org.el} by using the command line | |
615 @example | |
616 emacs -l /path/to/org.el | |
617 @end example | |
618 @item | |
619 Go to the @code{Options} menu and select @code{Enter Debugger on Error} | |
620 (XEmacs has this option in the @code{Troubleshooting} sub-menu). | |
621 @item | |
622 Do whatever you have to do to hit the error. Don't forget to | |
623 document the steps you take. | |
624 @item | |
625 When you hit the error, a @file{*Backtrace*} buffer will appear on the | |
626 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and | |
627 attach it to your bug report. | |
628 @end enumerate | |
629 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
630 @node Conventions, , Feedback, Introduction |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
631 @section Typesetting conventions used in this manual |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
632 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
633 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
|
634 names. In this manual we use the following conventions: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
635 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
636 @table @code |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
637 @item TODO |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
638 @itemx WAITING |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
639 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
|
640 user-defined. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
641 @item boss |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
642 @itemx ARCHIVE |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
643 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
|
644 meaning are written with all capitals. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
645 @item Release |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
646 @itemx PRIORITY |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
647 User-defined properties are capitalized; built-in properties with |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
648 special meaning are written with all capitals. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
649 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
650 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
651 @node Document Structure, Tables, Introduction, Top |
84308 | 652 @chapter Document Structure |
653 @cindex document structure | |
654 @cindex structure of document | |
655 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
656 Org is based on outline mode and provides flexible commands to |
84308 | 657 edit the structure of the document. |
658 | |
659 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
660 * 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
|
661 * Headlines:: How to typeset Org tree headlines |
84308 | 662 * Visibility cycling:: Show and hide, much simplified |
663 * Motion:: Jumping to other headlines | |
664 * Structure editing:: Changing sequence and level of headlines | |
665 * Archiving:: Move done task trees to a different place | |
666 * Sparse trees:: Matches embedded in context | |
667 * Plain lists:: Additional structure within an entry | |
668 * Drawers:: Tucking stuff away | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
669 * Orgstruct mode:: Structure editing outside Org |
84308 | 670 @end menu |
671 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
672 @node Outlines, Headlines, Document Structure, Document Structure |
84308 | 673 @section Outlines |
674 @cindex outlines | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
675 @cindex Outline mode |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
676 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
677 Org is implemented on top of Outline mode. Outlines allow a |
84308 | 678 document to be organized in a hierarchical structure, which (at least |
679 for me) is the best representation of notes and thoughts. An overview | |
680 of this structure is achieved by folding (hiding) large parts of the | |
681 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
|
682 currently being worked on. Org greatly simplifies the use of |
84308 | 683 outlines by compressing the entire show/hide functionality into a single |
684 command @command{org-cycle}, which is bound to the @key{TAB} key. | |
685 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
686 @node Headlines, Visibility cycling, Outlines, Document Structure |
84308 | 687 @section Headlines |
688 @cindex headlines | |
689 @cindex outline tree | |
690 | |
691 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
|
692 Org start with one or more stars, on the left margin@footnote{See |
84308 | 693 the variable @code{org-special-ctrl-a/e} to configure special behavior |
694 of @kbd{C-a} and @kbd{C-e} in headlines.}. For example: | |
695 | |
696 @example | |
697 * Top level headline | |
698 ** Second level | |
699 *** 3rd level | |
700 some text | |
701 *** 3rd level | |
702 more text | |
703 | |
704 * Another top level headline | |
705 @end example | |
706 | |
707 @noindent Some people find the many stars too noisy and would prefer an | |
708 outline that has whitespace followed by a single star as headline | |
709 starters. @ref{Clean view} describes a setup to realize this. | |
710 | |
711 An empty line after the end of a subtree is considered part of it and | |
712 will be hidden when the subtree is folded. However, if you leave at | |
713 least two empty lines, one empty line will remain visible after folding | |
714 the subtree, in order to structure the collapsed view. See the | |
715 variable @code{org-cycle-separator-lines} to modify this behavior. | |
716 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
717 @node Visibility cycling, Motion, Headlines, Document Structure |
84308 | 718 @section Visibility cycling |
719 @cindex cycling, visibility | |
720 @cindex visibility cycling | |
721 @cindex trees, visibility | |
722 @cindex show hidden text | |
723 @cindex hide text | |
724 | |
725 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
|
726 Org uses just two commands, bound to @key{TAB} and |
84308 | 727 @kbd{S-@key{TAB}} to change the visibility in the buffer. |
728 | |
729 @cindex subtree visibility states | |
730 @cindex subtree cycling | |
731 @cindex folded, subtree visibility state | |
732 @cindex children, subtree visibility state | |
733 @cindex subtree, subtree visibility state | |
734 @table @kbd | |
735 @kindex @key{TAB} | |
736 @item @key{TAB} | |
737 @emph{Subtree cycling}: Rotate current subtree among the states | |
738 | |
739 @example | |
740 ,-> FOLDED -> CHILDREN -> SUBTREE --. | |
741 '-----------------------------------' | |
742 @end example | |
743 | |
744 The cursor must be on a headline for this to work@footnote{see, however, | |
745 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the | |
746 beginning of the buffer and the first line is not a headline, then | |
747 @key{TAB} actually runs global cycling (see below)@footnote{see the | |
748 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix | |
749 argument (@kbd{C-u @key{TAB}}), global cycling is invoked. | |
750 | |
751 @cindex global visibility states | |
752 @cindex global cycling | |
753 @cindex overview, global visibility state | |
754 @cindex contents, global visibility state | |
755 @cindex show all, global visibility state | |
756 @kindex S-@key{TAB} | |
757 @item S-@key{TAB} | |
758 @itemx C-u @key{TAB} | |
759 @emph{Global cycling}: Rotate the entire buffer among the states | |
760 | |
761 @example | |
762 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --. | |
763 '--------------------------------------' | |
764 @end example | |
765 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
766 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
|
767 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
|
768 tables, @kbd{S-@key{TAB}} jumps to the previous field. |
84308 | 769 |
770 @cindex show all, command | |
771 @kindex C-c C-a | |
772 @item C-c C-a | |
773 Show all. | |
774 @kindex C-c C-r | |
775 @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
|
776 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
|
777 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
|
778 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
|
779 (@pxref{Agenda commands}). With a prefix argument show, on each |
84308 | 780 level, all sibling headings. |
781 @kindex C-c C-x b | |
782 @item C-c C-x b | |
783 Show the current subtree in an indirect buffer@footnote{The indirect | |
784 buffer | |
785 @ifinfo | |
786 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual}) | |
787 @end ifinfo | |
788 @ifnotinfo | |
789 (see the Emacs manual for more information about indirect buffers) | |
790 @end ifnotinfo | |
791 will contain the entire buffer, but will be narrowed to the current | |
792 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
|
793 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
|
794 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
|
795 negative then go up that many levels. With a @kbd{C-u} prefix, do not remove |
84308 | 796 the previously used indirect buffer. |
797 @end table | |
798 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
799 When Emacs first visits an Org file, the global state is set to |
84308 | 800 OVERVIEW, i.e. only the top level headlines are visible. This can be |
801 configured through the variable @code{org-startup-folded}, or on a | |
802 per-file basis by adding one of the following lines anywhere in the | |
803 buffer: | |
804 | |
805 @example | |
806 #+STARTUP: overview | |
807 #+STARTUP: content | |
808 #+STARTUP: showall | |
809 @end example | |
810 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
811 @noindent |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
812 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
|
813 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
|
814 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
|
815 @code{all}. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
816 @table @kbd |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
817 @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
|
818 @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
|
819 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
|
820 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
|
821 entries. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
822 @end table |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
823 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
824 @node Motion, Structure editing, Visibility cycling, Document Structure |
84308 | 825 @section Motion |
826 @cindex motion, between headlines | |
827 @cindex jumping, to headlines | |
828 @cindex headline navigation | |
829 The following commands jump to other headlines in the buffer. | |
830 | |
831 @table @kbd | |
832 @kindex C-c C-n | |
833 @item C-c C-n | |
834 Next heading. | |
835 @kindex C-c C-p | |
836 @item C-c C-p | |
837 Previous heading. | |
838 @kindex C-c C-f | |
839 @item C-c C-f | |
840 Next heading same level. | |
841 @kindex C-c C-b | |
842 @item C-c C-b | |
843 Previous heading same level. | |
844 @kindex C-c C-u | |
845 @item C-c C-u | |
846 Backward to higher level heading. | |
847 @kindex C-c C-j | |
848 @item C-c C-j | |
849 Jump to a different place without changing the current outline | |
850 visibility. Shows the document structure in a temporary buffer, where | |
851 you can use the following keys to find your destination: | |
852 @example | |
853 @key{TAB} @r{Cycle visibility.} | |
854 @key{down} / @key{up} @r{Next/previous visible headline.} | |
855 n / p @r{Next/previous visible headline.} | |
856 f / b @r{Next/previous headline same level.} | |
857 u @r{One level up.} | |
858 0-9 @r{Digit argument.} | |
859 @key{RET} @r{Select this location.} | |
860 @end example | |
861 @end table | |
862 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
863 @node Structure editing, Archiving, Motion, Document Structure |
84308 | 864 @section Structure editing |
865 @cindex structure editing | |
866 @cindex headline, promotion and demotion | |
867 @cindex promotion, of subtrees | |
868 @cindex demotion, of subtrees | |
869 @cindex subtree, cut and paste | |
870 @cindex pasting, of subtrees | |
871 @cindex cutting, of subtrees | |
872 @cindex copying, of subtrees | |
873 @cindex subtrees, cut and paste | |
874 | |
875 @table @kbd | |
876 @kindex M-@key{RET} | |
877 @item M-@key{RET} | |
878 Insert new heading with same level as current. If the cursor is in a | |
879 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
|
880 creation of a new headline, use a prefix argument, or first press @key{RET} |
84308 | 881 to get to the beginning of the next line. When this command is used in |
882 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
|
883 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
|
884 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
|
885 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
|
886 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
|
887 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
|
888 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
|
889 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
|
890 after the end of the subtree. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
891 @kindex C-@key{RET} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
892 @item C-@key{RET} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
893 Insert a new heading after the current subtree, same level as the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
894 current headline. This command works from anywhere in the entry. |
84308 | 895 @kindex M-S-@key{RET} |
896 @item M-S-@key{RET} | |
897 Insert new TODO entry with same level as current heading. | |
898 @kindex M-@key{left} | |
899 @item M-@key{left} | |
900 Promote current heading by one level. | |
901 @kindex M-@key{right} | |
902 @item M-@key{right} | |
903 Demote current heading by one level. | |
904 @kindex M-S-@key{left} | |
905 @item M-S-@key{left} | |
906 Promote the current subtree by one level. | |
907 @kindex M-S-@key{right} | |
908 @item M-S-@key{right} | |
909 Demote the current subtree by one level. | |
910 @kindex M-S-@key{up} | |
911 @item M-S-@key{up} | |
912 Move subtree up (swap with previous subtree of same | |
913 level). | |
914 @kindex M-S-@key{down} | |
915 @item M-S-@key{down} | |
916 Move subtree down (swap with next subtree of same level). | |
917 @kindex C-c C-x C-w | |
918 @kindex C-c C-x C-k | |
919 @item C-c C-x C-w | |
920 @itemx C-c C-x C-k | |
921 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
|
922 With a numeric prefix argument N, kill N sequential subtrees. |
84308 | 923 @kindex C-c C-x M-w |
924 @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
|
925 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
|
926 sequential subtrees. |
84308 | 927 @kindex C-c C-x C-y |
928 @item C-c C-x C-y | |
929 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
|
930 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
|
931 also be specified with a numeric prefix argument, or by yanking after a |
84308 | 932 headline marker like @samp{****}. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
933 @kindex C-c C-w |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
934 @item C-c C-w |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
935 Refile entry to a different location. @xref{Refiling notes}. |
84308 | 936 @kindex C-c ^ |
937 @item C-c ^ | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
938 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
|
939 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
|
940 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
|
941 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
|
942 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
|
943 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
|
944 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
|
945 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
|
946 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
|
947 @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
|
948 @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
|
949 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
|
950 @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
|
951 @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
|
952 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
|
953 @kindex C-c * |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
954 @item C-c * |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
955 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
|
956 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
|
957 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
|
958 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
|
959 headline, remove the stars from all headlines in the region. |
84308 | 960 @end table |
961 | |
962 @cindex region, active | |
963 @cindex active region | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
964 @cindex Transient mark mode |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
965 When there is an active region (Transient mark mode), promotion and |
84308 | 966 demotion work on all headlines in the region. To select a region of |
967 headlines, it is best to place both point and mark at the beginning of a | |
968 line, mark at the beginning of the first headline, and point at the line | |
969 just after the last headline to change. Note that when the cursor is | |
970 inside a table (@pxref{Tables}), the Meta-Cursor keys have different | |
971 functionality. | |
972 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
973 @node Archiving, Sparse trees, Structure editing, Document Structure |
84308 | 974 @section Archiving |
975 @cindex archiving | |
976 | |
977 When a project represented by a (sub)tree is finished, you may want | |
978 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
|
979 agenda. Org mode knows two ways of archiving. You can mark a tree with |
84308 | 980 the ARCHIVE tag, or you can move an entire (sub)tree to a different |
981 location. | |
982 | |
983 @menu | |
984 * ARCHIVE tag:: Marking a tree as inactive | |
985 * Moving subtrees:: Moving a tree to an archive file | |
986 @end menu | |
987 | |
988 @node ARCHIVE tag, Moving subtrees, Archiving, Archiving | |
989 @subsection The ARCHIVE tag | |
990 @cindex internal archiving | |
991 | |
992 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at | |
993 its location in the outline tree, but behaves in the following way: | |
994 @itemize @minus | |
995 @item | |
996 It does not open when you attempt to do so with a visibility cycling | |
997 command (@pxref{Visibility cycling}). You can force cycling archived | |
998 subtrees with @kbd{C-@key{TAB}}, or by setting the option | |
999 @code{org-cycle-open-archived-trees}. Also normal outline commands like | |
1000 @code{show-all} will open archived subtrees. | |
1001 @item | |
1002 During sparse tree construction (@pxref{Sparse trees}), matches in | |
1003 archived subtrees are not exposed, unless you configure the option | |
1004 @code{org-sparse-tree-open-archived-trees}. | |
1005 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1006 During agenda view construction (@pxref{Agenda Views}), the content of |
84308 | 1007 archived trees is ignored unless you configure the option |
1008 @code{org-agenda-skip-archived-trees}. | |
1009 @item | |
1010 Archived trees are not exported (@pxref{Exporting}), only the headline | |
1011 is. Configure the details using the variable | |
1012 @code{org-export-with-archived-trees}. | |
1013 @end itemize | |
1014 | |
1015 The following commands help managing the ARCHIVE tag: | |
1016 | |
1017 @table @kbd | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1018 @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
|
1019 @item C-c C-x a |
84308 | 1020 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
|
1021 the headline changes to a shadowed face, and the subtree below it is |
84308 | 1022 hidden. |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1023 @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
|
1024 @item C-u C-c C-x a |
84308 | 1025 Check if any direct children of the current headline should be archived. |
1026 To do this, each subtree is checked for open TODO entries. If none are | |
1027 found, the command offers to set the ARCHIVE tag for the child. If the | |
1028 cursor is @emph{not} on a headline when this command is invoked, the | |
1029 level 1 trees will be checked. | |
1030 @kindex C-@kbd{TAB} | |
1031 @item C-@kbd{TAB} | |
1032 Cycle a tree even if it is tagged with ARCHIVE. | |
1033 @end table | |
1034 | |
1035 @node Moving subtrees, , ARCHIVE tag, Archiving | |
1036 @subsection Moving subtrees | |
1037 @cindex external archiving | |
1038 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1039 Once an entire project is finished, you may want to move it to a different |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1040 location. Org can move it to an @emph{Attic Sibling} in the same tree, to a |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1041 different tree in the current file, or to a different file, the archive file. |
84308 | 1042 |
1043 @table @kbd | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1044 @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
|
1045 @item C-c C-x A |
94550
48d7a33a951c
(Moving subtrees): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents:
94409
diff
changeset
|
1046 Move the current entry to the @emph{Attic Sibling}. This is a sibling of the |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1047 entry with the heading @samp{Attic} and the tag @samp{ARCHIVE} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1048 (@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
|
1049 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
|
1050 approximate position in the outline. |
84308 | 1051 @kindex C-c C-x C-s |
1052 @item C-c C-x C-s | |
1053 Archive the subtree starting at the cursor position to the location | |
1054 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
|
1055 lost like the file name, the category, inherited tags, and the TODO |
84308 | 1056 state will be store as properties in the entry. |
1057 @kindex C-u C-c C-x C-s | |
1058 @item C-u C-c C-x C-s | |
1059 Check if any direct children of the current headline could be moved to | |
1060 the archive. To do this, each subtree is checked for open TODO entries. | |
1061 If none are found, the command offers to move it to the archive | |
1062 location. If the cursor is @emph{not} on a headline when this command | |
1063 is invoked, the level 1 trees will be checked. | |
1064 @end table | |
1065 | |
1066 @cindex archive locations | |
1067 The default archive location is a file in the same directory as the | |
1068 current file, with the name derived by appending @file{_archive} to the | |
1069 current file name. For information and examples on how to change this, | |
1070 see the documentation string of the variable | |
1071 @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
|
1072 setting this variable, for example@footnote{For backward compatibility, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1073 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
|
1074 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
|
1075 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
|
1076 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
|
1077 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
|
1078 setting multiple archive locations in a buffer is using a property.}: |
84308 | 1079 |
1080 @example | |
1081 #+ARCHIVE: %s_done:: | |
1082 @end example | |
1083 | |
1084 @noindent | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1085 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
|
1086 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
|
1087 location as the value (@pxref{Properties and Columns}). |
84308 | 1088 |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
1089 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
|
1090 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
|
1091 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
|
1092 @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
|
1093 added. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
1094 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1095 @node Sparse trees, Plain lists, Archiving, Document Structure |
84308 | 1096 @section Sparse trees |
1097 @cindex sparse trees | |
1098 @cindex trees, sparse | |
1099 @cindex folding, sparse trees | |
1100 @cindex occur, command | |
1101 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1102 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
|
1103 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
|
1104 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
|
1105 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
|
1106 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
|
1107 @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
|
1108 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
|
1109 and you will see immediately how it works. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1110 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1111 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
|
1112 commands can be accessed through a dispatcher: |
84308 | 1113 |
1114 @table @kbd | |
1115 @kindex C-c / | |
1116 @item C-c / | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1117 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
|
1118 @kindex C-c / r |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1119 @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
|
1120 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
|
1121 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
|
1122 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
|
1123 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
|
1124 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
|
1125 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
|
1126 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
|
1127 @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
|
1128 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
|
1129 so several calls to this command can be stacked. |
84308 | 1130 @end table |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1131 |
84308 | 1132 @noindent |
1133 For frequently used sparse trees of specific search strings, you can | |
1134 use the variable @code{org-agenda-custom-commands} to define fast | |
1135 keyboard access to specific sparse trees. These commands will then be | |
1136 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}). | |
1137 For example: | |
1138 | |
1139 @lisp | |
1140 (setq org-agenda-custom-commands | |
1141 '(("f" occur-tree "FIXME"))) | |
1142 @end lisp | |
1143 | |
1144 @noindent will define the key @kbd{C-c a f} as a shortcut for creating | |
1145 a sparse tree matching the string @samp{FIXME}. | |
1146 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1147 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
|
1148 tags, or properties and will be discussed later in this manual. |
84308 | 1149 |
1150 @kindex C-c C-e v | |
1151 @cindex printing sparse trees | |
1152 @cindex visible text, printing | |
1153 To print a sparse tree, you can use the Emacs command | |
1154 @code{ps-print-buffer-with-faces} which does not print invisible parts | |
1155 of the document @footnote{This does not work under XEmacs, because | |
1156 XEmacs uses selective display for outlining, not text properties.}. | |
1157 Or you can use the command @kbd{C-c C-e v} to export only the visible | |
1158 part of the document and print the resulting file. | |
1159 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1160 @node Plain lists, Drawers, Sparse trees, Document Structure |
84308 | 1161 @section Plain lists |
1162 @cindex plain lists | |
1163 @cindex lists, plain | |
1164 @cindex lists, ordered | |
1165 @cindex ordered lists | |
1166 | |
1167 Within an entry of the outline tree, hand-formatted lists can provide | |
1168 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
|
1169 checkboxes (@pxref{Checkboxes}). Org supports editing such lists, |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1170 and the HTML exporter (@pxref{Exporting}) parses and formats them. |
84308 | 1171 |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1172 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
|
1173 @itemize @bullet |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1174 @item |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1175 @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
|
1176 @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
|
1177 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
|
1178 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
|
1179 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
|
1180 @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
|
1181 as bullets. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1182 @item |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1183 @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
|
1184 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
|
1185 @item |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1186 @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
|
1187 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
|
1188 desciption. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1189 @end itemize |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1190 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
1191 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
|
1192 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
|
1193 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
|
1194 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
|
1195 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
|
1196 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
|
1197 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
|
1198 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
|
1199 Here is an example: |
84308 | 1200 |
1201 @example | |
1202 @group | |
1203 ** Lord of the Rings | |
1204 My favorite scenes are (in this order) | |
1205 1. The attack of the Rohirrim | |
1206 2. Eowyns fight with the witch king | |
1207 + this was already my favorite scene in the book | |
1208 + I really like Miranda Otto. | |
1209 3. Peter Jackson being shot by Legolas | |
1210 - on DVD only | |
1211 He makes a really funny face when it happens. | |
1212 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
|
1213 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
|
1214 - @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
|
1215 - @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
|
1216 him very well from his role as Mikey Walsh a in the Goonies. |
84308 | 1217 @end group |
1218 @end example | |
1219 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1220 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
|
1221 deal with them correctly@footnote{Org only changes the filling |
84308 | 1222 settings for Emacs. For XEmacs, you should use Kyle E. Jones' |
1223 @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
|
1224 @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
|
1225 (@pxref{Exporting}). |
84308 | 1226 |
1227 The following commands act on items when the cursor is in the first line | |
1228 of an item (the line with the bullet or number). | |
1229 | |
1230 @table @kbd | |
1231 @kindex @key{TAB} | |
1232 @item @key{TAB} | |
1233 Items can be folded just like headline levels if you set the variable | |
1234 @code{org-cycle-include-plain-lists}. The level of an item is then | |
1235 given by the indentation of the bullet/number. Items are always | |
1236 subordinate to real headlines, however; the hierarchies remain | |
1237 completely separated. | |
1238 | |
1239 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
|
1240 fixes the indentation of the current line in a heuristic way. |
84308 | 1241 @kindex M-@key{RET} |
1242 @item M-@key{RET} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1243 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
|
1244 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
|
1245 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
|
1246 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
|
1247 @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
|
1248 @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
|
1249 @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
|
1250 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
|
1251 bullet, a bullet is added to the current line. |
84308 | 1252 @kindex M-S-@key{RET} |
1253 @item M-S-@key{RET} | |
1254 Insert a new item with a checkbox (@pxref{Checkboxes}). | |
1255 @kindex S-@key{up} | |
1256 @kindex S-@key{down} | |
1257 @item S-@key{up} | |
1258 @itemx S-@key{down} | |
1259 Jump to the previous/next item in the current list. | |
1260 @kindex M-S-@key{up} | |
1261 @kindex M-S-@key{down} | |
1262 @item M-S-@key{up} | |
1263 @itemx M-S-@key{down} | |
1264 Move the item including subitems up/down (swap with previous/next item | |
1265 of same indentation). If the list is ordered, renumbering is | |
1266 automatic. | |
1267 @kindex M-S-@key{left} | |
1268 @kindex M-S-@key{right} | |
1269 @item M-S-@key{left} | |
1270 @itemx M-S-@key{right} | |
1271 Decrease/increase the indentation of the item, including subitems. | |
1272 Initially, the item tree is selected based on current indentation. | |
1273 When these commands are executed several times in direct succession, | |
1274 the initially selected region is used, even if the new indentation | |
1275 would imply a different hierarchy. To use the new hierarchy, break | |
1276 the command chain with a cursor motion or so. | |
1277 @kindex C-c C-c | |
1278 @item C-c C-c | |
1279 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
|
1280 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
|
1281 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
|
1282 an ordered list, make sure the numbering is OK. |
84308 | 1283 @kindex C-c - |
1284 @item C-c - | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1285 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
|
1286 (@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
|
1287 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
|
1288 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
|
1289 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
|
1290 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
|
1291 converted into a list item. |
84308 | 1292 @end table |
1293 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1294 @node Drawers, Orgstruct mode, Plain lists, Document Structure |
84308 | 1295 @section Drawers |
1296 @cindex drawers | |
1297 @cindex visibility cycling, drawers | |
1298 | |
1299 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
|
1300 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
|
1301 Drawers need to be configured with the variable |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1302 @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
|
1303 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers |
84308 | 1304 look like this: |
1305 | |
1306 @example | |
1307 ** This is a headline | |
1308 Still outside the drawer | |
1309 :DRAWERNAME: | |
1310 This is inside the drawer. | |
1311 :END: | |
1312 After the drawer. | |
1313 @end example | |
1314 | |
1315 Visibility cycling (@pxref{Visibility cycling}) on the headline will | |
1316 hide and show the entry, but keep the drawer collapsed to a single line. | |
1317 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
|
1318 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
|
1319 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
|
1320 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
|
1321 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1322 @node Orgstruct mode, , Drawers, Document Structure |
84308 | 1323 @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
|
1324 @cindex Orgstruct mode |
84308 | 1325 @cindex minor mode for structure editing |
1326 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1327 If you like the intuitive way the Org mode structure editing and list |
84308 | 1328 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
|
1329 like Text mode or Mail mode as well. The minor mode Orgstruct mode |
84308 | 1330 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
|
1331 orgstruct-mode}. To turn it on by default, for example in Mail mode, |
84308 | 1332 use |
1333 | |
1334 @lisp | |
1335 (add-hook 'mail-mode-hook 'turn-on-orgstruct) | |
1336 @end lisp | |
1337 | |
1338 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
|
1339 Org like a headline of the first line of a list item, most |
84308 | 1340 structure editing commands will work, even if the same keys normally |
1341 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
|
1342 cursor is not in one of those special lines, Orgstruct mode lurks |
84308 | 1343 silently in the shadow. |
1344 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1345 @node Tables, Hyperlinks, Document Structure, Top |
84308 | 1346 @chapter Tables |
1347 @cindex tables | |
1348 @cindex editing tables | |
1349 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1350 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
|
1351 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
|
1352 package |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1353 @ifinfo |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1354 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}). |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1355 @end ifinfo |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1356 @ifnotinfo |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1357 (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
|
1358 calculator). |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1359 @end ifnotinfo |
84308 | 1360 |
1361 @menu | |
1362 * 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
|
1363 * Narrow columns:: Stop wasting space in tables |
84308 | 1364 * 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
|
1365 * 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
|
1366 * The spreadsheet:: The table editor has spreadsheet capabilities |
84308 | 1367 @end menu |
1368 | |
1369 @node Built-in table editor, Narrow columns, Tables, Tables | |
1370 @section The built-in table editor | |
1371 @cindex table editor, built-in | |
1372 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1373 Org makes it easy to format tables in plain ASCII. Any line with |
84308 | 1374 @samp{|} as the first non-whitespace character is considered part of a |
1375 table. @samp{|} is also the column separator. A table might look like | |
1376 this: | |
1377 | |
1378 @example | |
1379 | Name | Phone | Age | | |
1380 |-------+-------+-----| | |
1381 | Peter | 1234 | 17 | | |
1382 | Anna | 4321 | 25 | | |
1383 @end example | |
1384 | |
1385 A table is re-aligned automatically each time you press @key{TAB} or | |
1386 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to | |
1387 the next field (@key{RET} to the next row) and creates new table rows | |
1388 at the end of the table or before horizontal lines. The indentation | |
1389 of the table is set by the first line. Any line starting with | |
1390 @samp{|-} is considered as a horizontal separator line and will be | |
1391 expanded on the next re-align to span the whole table width. So, to | |
1392 create the above table, you would only type | |
1393 | |
1394 @example | |
1395 |Name|Phone|Age| | |
1396 |- | |
1397 @end example | |
1398 | |
1399 @noindent and then press @key{TAB} to align the table and start filling in | |
1400 fields. | |
1401 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1402 When typing text into a field, Org treats @key{DEL}, |
84308 | 1403 @key{Backspace}, and all character keys in a special way, so that |
1404 inserting and deleting avoids shifting other fields. Also, when | |
1405 typing @emph{immediately after the cursor was moved into a new field | |
1406 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the | |
1407 field is automatically made blank. If this behavior is too | |
1408 unpredictable for you, configure the variables | |
1409 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}. | |
1410 | |
1411 @table @kbd | |
1412 @tsubheading{Creation and conversion} | |
1413 @kindex C-c | | |
1414 @item C-c | | |
1415 Convert the active region to table. If every line contains at least one | |
1416 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
|
1417 If every line contains a comma, comma-separated values (CSV) are assumed. |
84308 | 1418 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
|
1419 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
|
1420 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
|
1421 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
|
1422 @* |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1423 If there is no active region, this command creates an empty Org |
84308 | 1424 table. But it's easier just to start typing, like |
1425 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}. | |
1426 | |
1427 @tsubheading{Re-aligning and field motion} | |
1428 @kindex C-c C-c | |
1429 @item C-c C-c | |
1430 Re-align the table without moving the cursor. | |
1431 @c | |
1432 @kindex @key{TAB} | |
1433 @item @key{TAB} | |
1434 Re-align the table, move to the next field. Creates a new row if | |
1435 necessary. | |
1436 @c | |
1437 @kindex S-@key{TAB} | |
1438 @item S-@key{TAB} | |
1439 Re-align, move to previous field. | |
1440 @c | |
1441 @kindex @key{RET} | |
1442 @item @key{RET} | |
1443 Re-align the table and move down to next row. Creates a new row if | |
1444 necessary. At the beginning or end of a line, @key{RET} still does | |
1445 NEWLINE, so it can be used to split a table. | |
1446 | |
1447 @tsubheading{Column and row editing} | |
1448 @kindex M-@key{left} | |
1449 @kindex M-@key{right} | |
1450 @item M-@key{left} | |
1451 @itemx M-@key{right} | |
1452 Move the current column left/right. | |
1453 @c | |
1454 @kindex M-S-@key{left} | |
1455 @item M-S-@key{left} | |
1456 Kill the current column. | |
1457 @c | |
1458 @kindex M-S-@key{right} | |
1459 @item M-S-@key{right} | |
1460 Insert a new column to the left of the cursor position. | |
1461 @c | |
1462 @kindex M-@key{up} | |
1463 @kindex M-@key{down} | |
1464 @item M-@key{up} | |
1465 @itemx M-@key{down} | |
1466 Move the current row up/down. | |
1467 @c | |
1468 @kindex M-S-@key{up} | |
1469 @item M-S-@key{up} | |
1470 Kill the current row or horizontal line. | |
1471 @c | |
1472 @kindex M-S-@key{down} | |
1473 @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
|
1474 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
|
1475 created below the current one. |
84308 | 1476 @c |
1477 @kindex C-c - | |
1478 @item C-c - | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1479 Insert a horizontal line below current row. With a prefix argument, the line |
84308 | 1480 is created above the current line. |
1481 @c | |
1482 @kindex C-c ^ | |
1483 @item C-c ^ | |
1484 Sort the table lines in the region. The position of point indicates the | |
1485 column to be used for sorting, and the range of lines is the range | |
1486 between the nearest horizontal separator lines, or the entire table. If | |
1487 point is before the first column, you will be prompted for the sorting | |
1488 column. If there is an active region, the mark specifies the first line | |
1489 and the sorting column, while point should be in the last line to be | |
1490 included into the sorting. The command prompts for the sorting type | |
1491 (alphabetically, numerically, or by time). When called with a prefix | |
1492 argument, alphabetic sorting will be case-sensitive. | |
1493 | |
1494 @tsubheading{Regions} | |
1495 @kindex C-c C-x M-w | |
1496 @item C-c C-x M-w | |
1497 Copy a rectangular region from a table to a special clipboard. Point | |
1498 and mark determine edge fields of the rectangle. The process ignores | |
1499 horizontal separator lines. | |
1500 @c | |
1501 @kindex C-c C-x C-w | |
1502 @item C-c C-x C-w | |
1503 Copy a rectangular region from a table to a special clipboard, and | |
1504 blank all fields in the rectangle. So this is the ``cut'' operation. | |
1505 @c | |
1506 @kindex C-c C-x C-y | |
1507 @item C-c C-x C-y | |
1508 Paste a rectangular region into a table. | |
1509 The upper right corner ends up in the current field. All involved fields | |
1510 will be overwritten. If the rectangle does not fit into the present table, | |
1511 the table is enlarged as needed. The process ignores horizontal separator | |
1512 lines. | |
1513 @c | |
1514 @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
|
1515 @kindex M-@key{RET} |
84308 | 1516 @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
|
1517 @itemx M-@kbd{RET} |
84308 | 1518 Wrap several fields in a column like a paragraph. If there is an active |
1519 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
|
1520 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
|
1521 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
|
1522 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
|
1523 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
|
1524 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
|
1525 field is made blank, and the content is appended to the field above. |
84308 | 1526 |
1527 @tsubheading{Calculations} | |
1528 @cindex formula, in tables | |
1529 @cindex calculations, in tables | |
1530 @cindex region, active | |
1531 @cindex active region | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1532 @cindex Transient mark mode |
84308 | 1533 @kindex C-c + |
1534 @item C-c + | |
1535 Sum the numbers in the current column, or in the rectangle defined by | |
1536 the active region. The result is shown in the echo area and can | |
1537 be inserted with @kbd{C-y}. | |
1538 @c | |
1539 @kindex S-@key{RET} | |
1540 @item S-@key{RET} | |
1541 When current field is empty, copy from first non-empty field above. | |
1542 When not empty, copy current field down to next row and move cursor | |
1543 along with it. Depending on the variable | |
1544 @code{org-table-copy-increment}, integer field values will be | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1545 incremented during copy. This key is also used by CUA mode |
84308 | 1546 (@pxref{Cooperation}). |
1547 | |
1548 @tsubheading{Miscellaneous} | |
1549 @kindex C-c ` | |
1550 @item C-c ` | |
1551 Edit the current field in a separate window. This is useful for fields | |
1552 that are not fully visible (@pxref{Narrow columns}). When called with a | |
1553 @kbd{C-u} prefix, just make the full field visible, so that it can be | |
1554 edited in place. | |
1555 @c | |
1556 @item M-x org-table-import | |
1557 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
|
1558 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
|
1559 from a database, because these programs generally can write |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
1560 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
|
1561 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
|
1562 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
|
1563 separator. |
84308 | 1564 @item C-c | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1565 Tables can also be imported by pasting tabular text into the Org |
84308 | 1566 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the |
1567 @kbd{C-c |} command (see above under @i{Creation and conversion}. | |
1568 @c | |
1569 @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
|
1570 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
|
1571 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
|
1572 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
|
1573 @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
|
1574 @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
|
1575 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
|
1576 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
|
1577 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
|
1578 detailed description. |
84308 | 1579 @end table |
1580 | |
1581 If you don't like the automatic table editor because it gets in your | |
1582 way on lines which you would like to start with @samp{|}, you can turn | |
1583 it off with | |
1584 | |
1585 @lisp | |
1586 (setq org-enable-table-editor nil) | |
1587 @end lisp | |
1588 | |
1589 @noindent Then the only table command that still works is | |
1590 @kbd{C-c C-c} to do a manual re-align. | |
1591 | |
1592 @node Narrow columns, Column groups, Built-in table editor, Tables | |
1593 @section Narrow columns | |
1594 @cindex narrow columns in tables | |
1595 | |
1596 The width of columns is automatically determined by the table editor. | |
1597 Sometimes a single field or a few fields need to carry more text, | |
1598 leading to inconveniently wide columns. To limit@footnote{This feature | |
1599 does not work on XEmacs.} the width of a column, one field anywhere in | |
1600 the column may contain just the string @samp{<N>} where @samp{N} is an | |
1601 integer specifying the width of the column in characters. The next | |
1602 re-align will then set the width of this column to no more than this | |
1603 value. | |
1604 | |
1605 @example | |
1606 @group | |
1607 |---+------------------------------| |---+--------| | |
1608 | | | | | <6> | | |
1609 | 1 | one | | 1 | one | | |
1610 | 2 | two | ----\ | 2 | two | | |
1611 | 3 | This is a long chunk of text | ----/ | 3 | This=> | | |
1612 | 4 | four | | 4 | four | | |
1613 |---+------------------------------| |---+--------| | |
1614 @end group | |
1615 @end example | |
1616 | |
1617 @noindent | |
1618 Fields that are wider become clipped and end in the string @samp{=>}. | |
1619 Note that the full text is still in the buffer, it is only invisible. | |
1620 To see the full text, hold the mouse over the field - a tool-tip window | |
1621 will show the full content. To edit such a field, use the command | |
1622 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will | |
1623 open a new window with the full field. Edit it and finish with @kbd{C-c | |
1624 C-c}. | |
1625 | |
1626 When visiting a file containing a table with narrowed columns, the | |
1627 necessary character hiding has not yet happened, and the table needs to | |
1628 be aligned before it looks nice. Setting the option | |
1629 @code{org-startup-align-all-tables} will realign all tables in a file | |
1630 upon visiting, but also slow down startup. You can also set this option | |
1631 on a per-file basis with: | |
1632 | |
1633 @example | |
1634 #+STARTUP: align | |
1635 #+STARTUP: noalign | |
1636 @end example | |
1637 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1638 @node Column groups, Orgtbl mode, Narrow columns, Tables |
84308 | 1639 @section Column groups |
1640 @cindex grouping columns in tables | |
1641 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1642 When Org exports tables, it does so by default without vertical |
84308 | 1643 lines because that is visually more satisfying in general. Occasionally |
1644 however, vertical lines can be useful to structure a table into groups | |
1645 of columns, much like horizontal lines can do for groups of rows. In | |
1646 order to specify column groups, you can use a special row where the | |
1647 first field contains only @samp{/}. The further fields can either | |
1648 contain @samp{<} to indicate that this column should start a group, | |
1649 @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
|
1650 a group of its own. Boundaries between column groups will upon export be |
84308 | 1651 marked with vertical lines. Here is an example: |
1652 | |
1653 @example | |
1654 | | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) | | |
1655 |---+----+-----+-----+-----+---------+------------| | |
1656 | / | <> | < | | > | < | > | | |
1657 | # | 1 | 1 | 1 | 1 | 1 | 1 | | |
1658 | # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 | | |
1659 | # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 | | |
1660 |---+----+-----+-----+-----+---------+------------| | |
1661 #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2)) | |
1662 @end example | |
1663 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1664 It is also sufficient to just insert the column group starters after |
84308 | 1665 every vertical line you'd like to have: |
1666 | |
1667 @example | |
1668 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) | | |
1669 |----+-----+-----+-----+---------+------------| | |
1670 | / | < | | | < | | | |
1671 @end example | |
1672 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1673 @node Orgtbl mode, The spreadsheet, Column groups, Tables |
84308 | 1674 @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
|
1675 @cindex Orgtbl mode |
84308 | 1676 @cindex minor mode for tables |
1677 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1678 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
|
1679 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
|
1680 The minor mode Orgtbl mode makes this possible. You can always toggle |
84308 | 1681 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for |
1682 example in mail mode, use | |
1683 | |
1684 @lisp | |
1685 (add-hook 'mail-mode-hook 'turn-on-orgtbl) | |
1686 @end lisp | |
1687 | |
1688 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
|
1689 in arbitrary syntax with Orgtbl mode. For example, it is possible to |
84308 | 1690 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
|
1691 Orgtbl mode, including spreadsheet capabilities. For details, see |
84308 | 1692 @ref{Tables in arbitrary syntax}. |
1693 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1694 @node The spreadsheet, , Orgtbl mode, Tables |
84308 | 1695 @section The spreadsheet |
1696 @cindex calculations, in tables | |
1697 @cindex spreadsheet capabilities | |
1698 @cindex @file{calc} package | |
1699 | |
1700 The table editor makes use of the Emacs @file{calc} package to implement | |
1701 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
|
1702 derive fields from other fields. While fully featured, Org's |
84308 | 1703 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
|
1704 Org knows the concept of a @emph{column formula} that will be |
84308 | 1705 applied to all non-header fields in a column without having to copy the |
1706 formula to each relevant field. | |
1707 | |
1708 @menu | |
1709 * References:: How to refer to another field or range | |
1710 * Formula syntax for Calc:: Using Calc to compute stuff | |
1711 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp | |
1712 * Field formulas:: Formulas valid for a single field | |
1713 * Column formulas:: Formulas valid for an entire column | |
1714 * Editing and debugging formulas:: Fixing formulas | |
1715 * Updating the table:: Recomputing all dependent fields | |
1716 * Advanced features:: Field names, parameters and automatic recalc | |
1717 @end menu | |
1718 | |
1719 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet | |
1720 @subsection References | |
1721 @cindex references | |
1722 | |
1723 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
|
1724 reference other fields or ranges. In Org, fields can be referenced |
84308 | 1725 by name, by absolute coordinates, and by relative coordinates. To find |
1726 out what the coordinates of a field are, press @kbd{C-c ?} in that | |
1727 field, or press @kbd{C-c @}} to toggle the display of a grid. | |
1728 | |
1729 @subsubheading Field references | |
1730 @cindex field references | |
1731 @cindex references, to fields | |
1732 | |
1733 Formulas can reference the value of another field in two ways. Like in | |
1734 any other spreadsheet, you may reference fields with a letter/number | |
1735 combination like @code{B3}, meaning the 2nd field in the 3rd row. | |
1736 @c Such references are always fixed to that field, they don't change | |
1737 @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
|
1738 @c Org's @code{B3} behaves like @code{$B$3} in other spreadsheets. |
84308 | 1739 |
1740 @noindent | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1741 Org also uses another, more general operator that looks like this: |
84308 | 1742 @example |
1743 @@row$column | |
1744 @end example | |
1745 | |
1746 @noindent | |
1747 Column references can be absolute like @samp{1}, @samp{2},...@samp{N}, | |
1748 or relative to the current column like @samp{+1} or @samp{-2}. | |
1749 | |
1750 The row specification only counts data lines and ignores horizontal | |
1751 separator lines (hlines). You can use absolute row numbers | |
1752 @samp{1}...@samp{N}, and row numbers relative to the current row like | |
1753 @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
|
1754 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
|
1755 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
|
1756 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
|
1757 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
|
1758 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
|
1759 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
|
1760 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
|
1761 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
|
1762 the value directly at the hline is used. |
84308 | 1763 |
1764 @samp{0} refers to the current row and column. Also, if you omit | |
1765 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
|
1766 row/column is implied. |
84308 | 1767 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1768 Org's references with @emph{unsigned} numbers are fixed references |
84308 | 1769 in the sense that if you use the same reference in the formula for two |
1770 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
|
1771 Org's references with @emph{signed} numbers are floating |
84308 | 1772 references because the same reference operator can reference different |
1773 fields depending on the field being calculated by the formula. | |
1774 | |
1775 Here are a few examples: | |
1776 | |
1777 @example | |
1778 @@2$3 @r{2nd row, 3rd column} | |
1779 C2 @r{same as previous} | |
1780 $5 @r{column 5 in the current row} | |
1781 E& @r{same as previous} | |
1782 @@2 @r{current column, row 2} | |
1783 @@-1$-3 @r{the field one row up, three columns to the left} | |
1784 @@-I$2 @r{field just under hline above current row, column 2} | |
1785 @end example | |
1786 | |
1787 @subsubheading Range references | |
1788 @cindex range references | |
1789 @cindex references, to ranges | |
1790 | |
1791 You may reference a rectangular range of fields by specifying two field | |
1792 references connected by two dots @samp{..}. If both fields are in the | |
1793 current row, you may simply use @samp{$2..$7}, but if at least one field | |
1794 is in a different row, you need to use the general @code{@@row$column} | |
1795 format at least for the first field (i.e the reference must start with | |
1796 @samp{@@} in order to be interpreted correctly). Examples: | |
1797 | |
1798 @example | |
1799 $1..$3 @r{First three fields in the current row.} | |
1800 $P..$Q @r{Range, using column names (see under Advanced)} | |
1801 @@2$1..@@4$3 @r{6 fields between these two fields.} | |
1802 A2..C4 @r{Same as above.} | |
1803 @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row} | |
1804 @end example | |
1805 | |
1806 @noindent Range references return a vector of values that can be fed | |
1807 into Calc vector functions. Empty fields in ranges are normally | |
1808 suppressed, so that the vector contains only the non-empty fields (but | |
1809 see the @samp{E} mode switch below). If there are no non-empty fields, | |
1810 @samp{[0]} is returned to avoid syntax errors in formulas. | |
1811 | |
1812 @subsubheading Named references | |
1813 @cindex named references | |
1814 @cindex references, named | |
1815 @cindex name, of column or field | |
1816 @cindex constants, in calculations | |
1817 | |
1818 @samp{$name} is interpreted as the name of a column, parameter or | |
1819 constant. Constants are defined globally through the variable | |
1820 @code{org-table-formula-constants}, and locally (for the file) through a | |
1821 line like | |
1822 | |
1823 @example | |
1824 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6 | |
1825 @end example | |
1826 | |
1827 @noindent | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1828 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
|
1829 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
|
1830 @samp{$PROP_Xyz}, and the property will be searched in the current |
84308 | 1831 outline entry and in the hierarchy above it. If you have the |
1832 @file{constants.el} package, it will also be used to resolve constants, | |
1833 including natural constants like @samp{$h} for Planck's constant, and | |
1834 units like @samp{$km} for kilometers@footnote{@file{Constant.el} can | |
1835 supply the values of constants in two different unit systems, @code{SI} | |
1836 and @code{cgs}. Which one is used depends on the value of the variable | |
1837 @code{constants-unit-system}. You can use the @code{#+STARTUP} options | |
1838 @code{constSI} and @code{constcgs} to set this value for the current | |
1839 buffer.}. Column names and parameters can be specified in special table | |
1840 lines. These are described below, see @ref{Advanced features}. All | |
1841 names must start with a letter, and further consist of letters and | |
1842 numbers. | |
1843 | |
1844 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet | |
1845 @subsection Formula syntax for Calc | |
1846 @cindex formula syntax, Calc | |
1847 @cindex syntax, of formulas | |
1848 | |
1849 A formula can be any algebraic expression understood by the Emacs | |
1850 @file{Calc} package. @b{Note that @file{calc} has the | |
1851 non-standard convention that @samp{/} has lower precedence than | |
1852 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before | |
1853 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
|
1854 Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU |
84308 | 1855 Emacs Calc Manual}), |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1856 @c FIXME: The link to the Calc manual in HTML does not work. |
84308 | 1857 variable substitution takes place according to the rules described above. |
1858 @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
|
1859 The range vectors can be directly fed into the Calc vector functions |
84308 | 1860 like @samp{vmean} and @samp{vsum}. |
1861 | |
1862 @cindex format specifier | |
1863 @cindex mode, for @file{calc} | |
1864 A formula can contain an optional mode string after a semicolon. This | |
1865 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
|
1866 execution. By default, Org uses the standard Calc modes (precision |
84308 | 1867 12, angular units degrees, fraction and symbolic modes off. The display |
1868 format, however, has been changed to @code{(float 5)} to keep tables | |
1869 compact. The default settings can be configured using the variable | |
1870 @code{org-calc-default-modes}. | |
1871 | |
1872 @example | |
1873 p20 @r{switch the internal precision to 20 digits} | |
1874 n3 s3 e2 f4 @r{normal, scientific, engineering, or fixed display format} | |
1875 D R @r{angle modes: degrees, radians} | |
1876 F S @r{fraction and symbolic modes} | |
1877 N @r{interpret all fields as numbers, use 0 for non-numbers} | |
1878 T @r{force text interpretation} | |
1879 E @r{keep empty fields in ranges} | |
1880 @end example | |
1881 | |
1882 @noindent | |
1883 In addition, you may provide a @code{printf} format specifier to | |
1884 reformat the final result. A few examples: | |
1885 | |
1886 @example | |
1887 $1+$2 @r{Sum of first and second field} | |
1888 $1+$2;%.2f @r{Same, format result to two decimals} | |
1889 exp($2)+exp($1) @r{Math functions can be used} | |
1890 $0;%.1f @r{Reformat current cell to 1 decimal} | |
1891 ($3-32)*5/9 @r{Degrees F -> C conversion} | |
1892 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}} | |
1893 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1} | |
1894 sin($1);Dp3%.1e @r{Same, but use printf specifier for display} | |
1895 vmean($2..$7) @r{Compute column range mean, using vector function} | |
1896 vmean($2..$7);EN @r{Same, but treat empty fields as 0} | |
1897 taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree} | |
1898 @end example | |
1899 | |
1900 Calc also contains a complete set of logical operations. For example | |
1901 | |
1902 @example | |
1903 if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty} | |
1904 @end example | |
1905 | |
1906 @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet | |
1907 @subsection Emacs Lisp forms as formulas | |
1908 @cindex Lisp forms, as table formulas | |
1909 | |
1910 It is also possible to write a formula in Emacs Lisp; this can be useful | |
1911 for string manipulation and control structures, if the Calc's | |
1912 functionality is not enough. If a formula starts with a single quote | |
1913 followed by an opening parenthesis, then it is evaluated as a lisp form. | |
1914 The evaluation should return either a string or a number. Just as with | |
1915 @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
|
1916 semicolon. With Emacs Lisp forms, you need to be conscious about the way |
84308 | 1917 field references are interpolated into the form. By default, a |
1918 reference will be interpolated as a Lisp string (in double quotes) | |
1919 containing the field. If you provide the @samp{N} mode switch, all | |
1920 referenced elements will be numbers (non-number fields will be zero) and | |
1921 interpolated as Lisp numbers, without quotes. If you provide the | |
1922 @samp{L} flag, all fields will be interpolated literally, without quotes. | |
1923 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
|
1924 form, enclose the reference operator itself in double quotes, like |
84308 | 1925 @code{"$3"}. Ranges are inserted as space-separated fields, so you can |
1926 embed them in list or vector syntax. A few examples, note how the | |
1927 @samp{N} mode is used when we do computations in lisp. | |
1928 | |
1929 @example | |
1930 @r{Swap the first two characters of the content of column 1} | |
1931 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2)) | |
1932 @r{Add columns 1 and 2, equivalent to the Calc's @code{$1+$2}} | |
1933 '(+ $1 $2);N | |
1934 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}} | |
1935 '(apply '+ '($1..$4));N | |
1936 @end example | |
1937 | |
1938 @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet | |
1939 @subsection Field formulas | |
1940 @cindex field formula | |
1941 @cindex formula, for individual table field | |
1942 | |
1943 To assign a formula to a particular field, type it directly into the | |
1944 field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you | |
1945 press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in | |
1946 the field, the formula will be stored as the formula for this field, | |
1947 evaluated, and the current field replaced with the result. | |
1948 | |
1949 Formulas are stored in a special line starting with @samp{#+TBLFM:} | |
1950 directly below the table. If you typed the equation in the 4th field of | |
1951 the 3rd data line in the table, the formula will look like | |
1952 @samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows | |
1953 with the appropriate commands, @i{absolute references} (but not relative | |
1954 ones) in stored formulas are modified in order to still reference the | |
1955 same field. Of cause this is not true if you edit the table structure | |
1956 with normal editing commands - then you must fix the equations yourself. | |
1957 | |
1958 Instead of typing an equation into the field, you may also use the | |
1959 following command | |
1960 | |
1961 @table @kbd | |
1962 @kindex C-u C-c = | |
1963 @item C-u C-c = | |
1964 Install a new formula for the current field. The command prompts for a | |
1965 formula, with default taken from the @samp{#+TBLFM:} line, applies | |
1966 it to the current field and stores it. | |
1967 @end table | |
1968 | |
1969 @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet | |
1970 @subsection Column formulas | |
1971 @cindex column formula | |
1972 @cindex formula, for table column | |
1973 | |
1974 Often in a table, the same formula should be used for all fields in a | |
1975 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
|
1976 in that column, Org allows to assign a single formula to an entire |
84308 | 1977 column. If the table contains horizontal separator hlines, everything |
1978 before the first such line is considered part of the table @emph{header} | |
1979 and will not be modified by column formulas. | |
1980 | |
1981 To assign a formula to a column, type it directly into any field in the | |
1982 column, preceded by an equal sign, like @samp{=$1+$2}. When you press | |
1983 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the | |
1984 field, the formula will be stored as the formula for the current column, | |
1985 evaluated and the current field replaced with the result. If the field | |
1986 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
|
1987 used. For each column, Org will only remember the most recently |
84308 | 1988 used formula. In the @samp{TBLFM:} line, column formulas will look like |
1989 @samp{$4=$1+$2}. | |
1990 | |
1991 Instead of typing an equation into the field, you may also use the | |
1992 following command: | |
1993 | |
1994 @table @kbd | |
1995 @kindex C-c = | |
1996 @item C-c = | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
1997 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
|
1998 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
|
1999 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
|
2000 stores it. With a numeric prefix argument(e.g. @kbd{C-5 C-c =}) the command |
84308 | 2001 will apply it to that many consecutive fields in the current column. |
2002 @end table | |
2003 | |
2004 @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
|
2005 @subsection Editing and debugging formulas |
84308 | 2006 @cindex formula editing |
2007 @cindex editing, of table formulas | |
2008 | |
2009 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
|
2010 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
|
2011 formulas of a table. When offering a formula for editing, Org |
84308 | 2012 converts references to the standard format (like @code{B3} or @code{D&}) |
2013 if possible. If you prefer to only work with the internal format (like | |
2014 @code{@@3$2} or @code{$4}), configure the variable | |
2015 @code{org-table-use-standard-references}. | |
2016 | |
2017 @table @kbd | |
2018 @kindex C-c = | |
2019 @kindex C-u C-c = | |
2020 @item C-c = | |
2021 @itemx C-u C-c = | |
2022 Edit the formula associated with the current column/field in the | |
2023 minibuffer. See @ref{Column formulas} and @ref{Field formulas}. | |
2024 @kindex C-u C-u C-c = | |
2025 @item C-u C-u C-c = | |
2026 Re-insert the active formula (either a | |
2027 field formula, or a column formula) into the current field, so that you | |
2028 can edit it directly in the field. The advantage over editing in the | |
2029 minibuffer is that you can use the command @kbd{C-c ?}. | |
2030 @kindex C-c ? | |
2031 @item C-c ? | |
2032 While editing a formula in a table field, highlight the field(s) | |
2033 referenced by the reference at the cursor position in the formula. | |
2034 @kindex C-c @} | |
2035 @item C-c @} | |
2036 Toggle the display of row and column numbers for a table, using | |
2037 overlays. These are updated each time the table is aligned, you can | |
2038 force it with @kbd{C-c C-c}. | |
2039 @kindex C-c @{ | |
2040 @item C-c @{ | |
2041 Toggle the formula debugger on and off. See below. | |
2042 @kindex C-c ' | |
2043 @item C-c ' | |
2044 Edit all formulas for the current table in a special buffer, where the | |
2045 formulas will be displayed one per line. If the current field has an | |
2046 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
|
2047 While inside the special buffer, Org will automatically highlight |
84308 | 2048 any field or range reference at the cursor position. You may edit, |
2049 remove and add formulas, and use the following commands: | |
2050 @table @kbd | |
2051 @kindex C-c C-c | |
2052 @kindex C-x C-s | |
2053 @item C-c C-c | |
2054 @itemx C-x C-s | |
2055 Exit the formula editor and store the modified formulas. With @kbd{C-u} | |
2056 prefix, also apply the new formulas to the entire table. | |
2057 @kindex C-c C-q | |
2058 @item C-c C-q | |
2059 Exit the formula editor without installing changes. | |
2060 @kindex C-c C-r | |
2061 @item C-c C-r | |
2062 Toggle all references in the formula editor between standard (like | |
2063 @code{B3}) and internal (like @code{@@3$2}). | |
2064 @kindex @key{TAB} | |
2065 @item @key{TAB} | |
2066 Pretty-print or indent lisp formula at point. When in a line containing | |
2067 a lisp formula, format the formula according to Emacs Lisp rules. | |
2068 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
|
2069 formula, @key{TAB} re-indents just like in Emacs lisp mode. |
84308 | 2070 @kindex M-@key{TAB} |
2071 @item M-@key{TAB} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2072 Complete Lisp symbols, just like in Emacs lisp mode. |
84308 | 2073 @kindex S-@key{up} |
2074 @kindex S-@key{down} | |
2075 @kindex S-@key{left} | |
2076 @kindex S-@key{right} | |
2077 @item S-@key{up}/@key{down}/@key{left}/@key{right} | |
2078 Shift the reference at point. For example, if the reference is | |
2079 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}. | |
2080 This also works for relative references, and for hline references. | |
2081 @kindex M-S-@key{up} | |
2082 @kindex M-S-@key{down} | |
2083 @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
|
2084 Move the test line for column formulas in the Org buffer up and |
84308 | 2085 down. |
2086 @kindex M-@key{up} | |
2087 @kindex M-@key{down} | |
2088 @item M-@key{up}/@key{down} | |
2089 Scroll the window displaying the table. | |
2090 @kindex C-c @} | |
2091 @item C-c @} | |
2092 Turn the coordinate grid in the table on and off. | |
2093 @end table | |
2094 @end table | |
2095 | |
2096 Making a table field blank does not remove the formula associated with | |
2097 the field, because that is stored in a different line (the @samp{TBLFM} | |
2098 line) - during the next recalculation the field will be filled again. | |
2099 To remove a formula from a field, you have to give an empty reply when | |
2100 prompted for the formula, or to edit the @samp{#+TBLFM} line. | |
2101 | |
2102 @kindex C-c C-c | |
2103 You may edit the @samp{#+TBLFM} directly and re-apply the changed | |
2104 equations with @kbd{C-c C-c} in that line, or with the normal | |
2105 recalculation commands in the table. | |
2106 | |
2107 @subsubheading Debugging formulas | |
2108 @cindex formula debugging | |
2109 @cindex debugging, of table formulas | |
2110 When the evaluation of a formula leads to an error, the field content | |
2111 becomes the string @samp{#ERROR}. If you would like see what is going | |
2112 on during variable substitution and calculation in order to find a bug, | |
2113 turn on formula debugging in the @code{Tbl} menu and repeat the | |
2114 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a | |
2115 field. Detailed information will be displayed. | |
2116 | |
2117 @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
|
2118 @subsection Updating the table |
84308 | 2119 @cindex recomputing table fields |
2120 @cindex updating, table | |
2121 | |
2122 Recalculation of a table is normally not automatic, but needs to be | |
2123 triggered by a command. See @ref{Advanced features} for a way to make | |
2124 recalculation at least semi-automatically. | |
2125 | |
2126 In order to recalculate a line of a table or the entire table, use the | |
2127 following commands: | |
2128 | |
2129 @table @kbd | |
2130 @kindex C-c * | |
2131 @item C-c * | |
2132 Recalculate the current row by first applying the stored column formulas | |
2133 from left to right, and all field formulas in the current row. | |
2134 @c | |
2135 @kindex C-u C-c * | |
2136 @item C-u C-c * | |
2137 @kindex C-u C-c C-c | |
2138 @itemx C-u C-c C-c | |
2139 Recompute the entire table, line by line. Any lines before the first | |
2140 hline are left alone, assuming that these are part of the table header. | |
2141 @c | |
2142 @kindex C-u C-u C-c * | |
2143 @kindex C-u C-u C-c C-c | |
2144 @item C-u C-u C-c * | |
2145 @itemx C-u C-u C-c C-c | |
2146 Iterate the table by recomputing it until no further changes occur. | |
2147 This may be necessary if some computed fields use the value of other | |
2148 fields that are computed @i{later} in the calculation sequence. | |
2149 @end table | |
2150 | |
2151 @node Advanced features, , Updating the table, The spreadsheet | |
2152 @subsection Advanced features | |
2153 | |
2154 If you want the recalculation of fields to happen automatically, or if | |
2155 you want to be able to assign @i{names} to fields and columns, you need | |
2156 to reserve the first column of the table for special marking characters. | |
2157 @table @kbd | |
2158 @kindex C-# | |
2159 @item C-# | |
2160 Rotate the calculation mark in first column through the states @samp{}, | |
2161 @samp{#}, @samp{*}, @samp{!}, @samp{$}. The meaning of these characters | |
2162 is discussed below. When there is an active region, change all marks in | |
2163 the region. | |
2164 @end table | |
2165 | |
2166 Here is an example of a table that collects exam results of students and | |
2167 makes use of these features: | |
2168 | |
2169 @example | |
2170 @group | |
2171 |---+---------+--------+--------+--------+-------+------| | |
2172 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note | | |
2173 |---+---------+--------+--------+--------+-------+------| | |
2174 | ! | | P1 | P2 | P3 | Tot | | | |
2175 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 | | |
2176 | ^ | | m1 | m2 | m3 | mt | | | |
2177 |---+---------+--------+--------+--------+-------+------| | |
2178 | # | Peter | 10 | 8 | 23 | 41 | 8.2 | | |
2179 | # | Sara | 6 | 14 | 19 | 39 | 7.8 | | |
2180 | # | Sam | 2 | 4 | 3 | 9 | 1.8 | | |
2181 |---+---------+--------+--------+--------+-------+------| | |
2182 | | Average | | | | 29.7 | | | |
2183 | ^ | | | | | at | | | |
2184 | $ | max=50 | | | | | | | |
2185 |---+---------+--------+--------+--------+-------+------| | |
2186 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f | |
2187 @end group | |
2188 @end example | |
2189 | |
2190 @noindent @b{Important}: Please note that for these special tables, | |
2191 recalculating the table with @kbd{C-u C-c *} will only affect rows that | |
2192 are marked @samp{#} or @samp{*}, and fields that have a formula assigned | |
2193 to the field itself. The column formulas are not applied in rows with | |
2194 empty first field. | |
2195 | |
2196 @cindex marking characters, tables | |
2197 The marking characters have the following meaning: | |
2198 @table @samp | |
2199 @item ! | |
2200 The fields in this line define names for the columns, so that you may | |
2201 refer to a column as @samp{$Tot} instead of @samp{$6}. | |
2202 @item ^ | |
2203 This row defines names for the fields @emph{above} the row. With such | |
2204 a definition, any formula in the table may use @samp{$m1} to refer to | |
2205 the value @samp{10}. Also, if you assign a formula to a names field, it | |
2206 will be stored as @samp{$name=...}. | |
2207 @item _ | |
2208 Similar to @samp{^}, but defines names for the fields in the row | |
2209 @emph{below}. | |
2210 @item $ | |
2211 Fields in this row can define @emph{parameters} for formulas. For | |
2212 example, if a field in a @samp{$} row contains @samp{max=50}, then | |
2213 formulas in this table can refer to the value 50 using @samp{$max}. | |
2214 Parameters work exactly like constants, only that they can be defined on | |
2215 a per-table basis. | |
2216 @item # | |
2217 Fields in this row are automatically recalculated when pressing | |
2218 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row | |
2219 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked | |
2220 lines will be left alone by this command. | |
2221 @item * | |
2222 Selects this line for global recalculation with @kbd{C-u C-c *}, but | |
2223 not for automatic recalculation. Use this when automatic | |
2224 recalculation slows down editing too much. | |
2225 @item | |
2226 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}. | |
2227 All lines that should be recalculated should be marked with @samp{#} | |
2228 or @samp{*}. | |
2229 @item / | |
2230 Do not export this line. Useful for lines that contain the narrowing | |
2231 @samp{<N>} markers. | |
2232 @end table | |
2233 | |
2234 Finally, just to whet your appetite on what can be done with the | |
2235 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
|
2236 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
|
2237 functions. |
84308 | 2238 |
2239 @example | |
2240 @group | |
2241 |---+-------------+---+-----+--------------------------------------| | |
2242 | | Func | n | x | Result | | |
2243 |---+-------------+---+-----+--------------------------------------| | |
2244 | # | exp(x) | 1 | x | 1 + x | | |
2245 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 | | |
2246 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 | | |
2247 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 | | |
2248 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 | | |
2249 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 | | |
2250 |---+-------------+---+-----+--------------------------------------| | |
2251 #+TBLFM: $5=taylor($2,$4,$3);n3 | |
2252 @end group | |
2253 @end example | |
2254 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2255 @node Hyperlinks, TODO Items, Tables, Top |
84308 | 2256 @chapter Hyperlinks |
2257 @cindex hyperlinks | |
2258 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2259 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
|
2260 other files, Usenet articles, emails, and much more. |
84308 | 2261 |
2262 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2263 * Link format:: How links in Org are formatted |
84308 | 2264 * Internal links:: Links to other places in the current file |
2265 * External links:: URL-like links to the world | |
2266 * 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
|
2267 * Using links outside Org:: Linking from my C source code? |
84308 | 2268 * Link abbreviations:: Shortcuts for writing complex links |
2269 * Search options:: Linking to a specific location | |
2270 * Custom searches:: When the default search is not enough | |
2271 @end menu | |
2272 | |
2273 @node Link format, Internal links, Hyperlinks, Hyperlinks | |
2274 @section Link format | |
2275 @cindex link format | |
2276 @cindex format, of links | |
2277 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2278 Org will recognize plain URL-like links and activate them as |
84308 | 2279 clickable links. The general link format, however, looks like this: |
2280 | |
2281 @example | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2282 [[link][description]] @r{or alternatively} [[link]] |
84308 | 2283 @end example |
2284 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2285 Once a link in the buffer is complete (all brackets present), Org |
84308 | 2286 will change the display so that @samp{description} is displayed instead |
2287 of @samp{[[link][description]]} and @samp{link} is displayed instead of | |
2288 @samp{[[link]]}. Links will be highlighted in the face @code{org-link}, | |
2289 which by default is an underlined face. You can directly edit the | |
2290 visible part of a link. Note that this can be either the @samp{link} | |
2291 part (if there is no description) or the @samp{description} part. To | |
2292 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the | |
2293 cursor on the link. | |
2294 | |
2295 If you place the cursor at the beginning or just behind the end of the | |
2296 displayed text and press @key{BACKSPACE}, you will remove the | |
2297 (invisible) bracket at that location. This makes the link incomplete | |
2298 and the internals are again displayed as plain text. Inserting the | |
2299 missing bracket hides the link internals again. To show the | |
2300 internal structure of all links, use the menu entry | |
2301 @code{Org->Hyperlinks->Literal links}. | |
2302 | |
2303 @node Internal links, External links, Link format, Hyperlinks | |
2304 @section Internal links | |
2305 @cindex internal links | |
2306 @cindex links, internal | |
2307 @cindex targets, for links | |
2308 | |
2309 If the link does not look like a URL, it is considered to be internal in | |
2310 the current file. Links such as @samp{[[My Target]]} or @samp{[[My | |
2311 Target][Find my target]]} lead to a text search in the current file. | |
2312 The link can be followed with @kbd{C-c C-o} when the cursor is on the | |
2313 link, or with a mouse click (@pxref{Handling links}). The preferred | |
2314 match for such a link is a dedicated target: the same string in double | |
2315 angular brackets. Targets may be located anywhere; sometimes it is | |
2316 convenient to put them into a comment line. For example | |
2317 | |
2318 @example | |
2319 # <<My Target>> | |
2320 @end example | |
2321 | |
2322 @noindent In HTML export (@pxref{HTML export}), such targets will become | |
2323 named anchors for direct access through @samp{http} links@footnote{Note | |
2324 that text before the first headline is usually not exported, so the | |
2325 first such target should be after the first headline.}. | |
2326 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2327 If no dedicated target exists, Org will search for the words in the |
84308 | 2328 link. In the above example the search would be for @samp{my target}. |
2329 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
|
2330 headlines. When searching, Org mode will first try an exact match, but |
84308 | 2331 then move on to more and more lenient searches. For example, the link |
2332 @samp{[[*My Targets]]} will find any of the following: | |
2333 | |
2334 @example | |
2335 ** My targets | |
2336 ** TODO my targets are bright | |
2337 ** my 20 targets are | |
2338 @end example | |
2339 | |
2340 To insert a link targeting a headline, in-buffer completion can be used. | |
2341 Just type a star followed by a few optional letters into the buffer and | |
2342 press @kbd{M-@key{TAB}}. All headlines in the current buffer will be | |
2343 offered as completions. @xref{Handling links}, for more commands | |
2344 creating links. | |
2345 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2346 Following a link pushes a mark onto Org's own mark ring. You can |
84308 | 2347 return to the previous position with @kbd{C-c &}. Using this command |
2348 several times in direct succession goes back to positions recorded | |
2349 earlier. | |
2350 | |
2351 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2352 * Radio targets:: Make targets trigger links in plain text |
84308 | 2353 @end menu |
2354 | |
2355 @node Radio targets, , Internal links, Internal links | |
2356 @subsection Radio targets | |
2357 @cindex radio targets | |
2358 @cindex targets, radio | |
2359 @cindex links, radio targets | |
2360 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2361 Org can automatically turn any occurrences of certain target names |
84308 | 2362 in normal text into a link. So without explicitly creating a link, the |
2363 text connects to the target radioing its position. Radio targets are | |
2364 enclosed by triple angular brackets. For example, a target @samp{<<<My | |
2365 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
|
2366 become activated as a link. The Org file is scanned automatically |
84308 | 2367 for radio targets only when the file is first loaded into Emacs. To |
2368 update the target list during editing, press @kbd{C-c C-c} with the | |
2369 cursor on or at a target. | |
2370 | |
2371 @node External links, Handling links, Internal links, Hyperlinks | |
2372 @section External links | |
2373 @cindex links, external | |
2374 @cindex external links | |
2375 @cindex links, external | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2376 @cindex Gnus links |
84308 | 2377 @cindex BBDB links |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2378 @cindex IRC links |
84308 | 2379 @cindex URL links |
2380 @cindex file links | |
2381 @cindex VM links | |
2382 @cindex RMAIL links | |
2383 @cindex WANDERLUST links | |
2384 @cindex MH-E links | |
2385 @cindex USENET links | |
2386 @cindex SHELL links | |
2387 @cindex Info links | |
2388 @cindex elisp links | |
2389 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2390 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
|
2391 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
|
2392 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
|
2393 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
|
2394 the colon. The following list shows examples for each link type. |
84308 | 2395 |
2396 @example | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2397 http://www.astro.uva.nl/~dominik @r{on the web} |
84308 | 2398 file:/home/dominik/images/jupiter.jpg @r{file, absolute path} |
2399 file:papers/last.pdf @r{file, relative path} | |
2400 news:comp.emacs @r{Usenet link} | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2401 mailto:adent@@galaxy.net @r{Mail link} |
84308 | 2402 vm:folder @r{VM folder link} |
2403 vm:folder#id @r{VM message link} | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2404 vm://myself@@some.where.org/folder#id @r{VM on remote machine} |
84308 | 2405 wl:folder @r{WANDERLUST folder link} |
2406 wl:folder#id @r{WANDERLUST message link} | |
2407 mhe:folder @r{MH-E folder link} | |
2408 mhe:folder#id @r{MH-E message link} | |
2409 rmail:folder @r{RMAIL folder link} | |
2410 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
|
2411 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
|
2412 gnus:group#id @r{Gnus article link} |
84308 | 2413 bbdb:Richard Stallman @r{BBDB link} |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2414 irc:/irc.com/#emacs/bob @r{IRC link} |
84308 | 2415 shell:ls *.org @r{A shell command} |
2416 elisp:(find-file-other-frame "Elisp.org") @r{An elisp form to evaluate} | |
2417 @end example | |
2418 | |
2419 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
|
2420 descriptive text to be displayed instead of the URL (@pxref{Link |
84308 | 2421 format}), for example: |
2422 | |
2423 @example | |
2424 [[http://www.gnu.org/software/emacs/][GNU Emacs]] | |
2425 @end example | |
2426 | |
2427 @noindent | |
2428 If the description is a file name or URL that points to an image, HTML | |
2429 export (@pxref{HTML export}) will inline the image as a clickable | |
2430 button. If there is no description at all and the link points to an | |
2431 image, | |
2432 that image will be inlined into the exported HTML file. | |
2433 | |
2434 @cindex angular brackets, around links | |
2435 @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
|
2436 Org also finds external links in the normal text and activates them |
84308 | 2437 as links. If spaces must be part of the link (for example in |
2438 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities | |
2439 about the end of the link, enclose them in angular brackets. | |
2440 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2441 @node Handling links, Using links outside Org, External links, Hyperlinks |
84308 | 2442 @section Handling links |
2443 @cindex links, handling | |
2444 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2445 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
|
2446 insert it into an Org file, and to follow the link. |
84308 | 2447 |
2448 @table @kbd | |
2449 @kindex C-c l | |
2450 @cindex storing links | |
2451 @item C-c l | |
2452 Store a link to the current location. This is a @emph{global} command | |
2453 which can be used in any buffer to create a link. The link will be | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2454 stored for later insertion into an Org buffer (see below). For |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2455 Org files, if there is a @samp{<<target>>} at the cursor, the |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2456 link points to the target. Otherwise it points to the current |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2457 headline. For VM, Rmail, Wanderlust, MH-E, Gnus and BBDB buffers, the |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2458 link will indicate the current article/entry. For W3 and W3M buffers, |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2459 the link goes to the current URL. For IRC links, if you set the |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2460 variable @code{org-irc-link-to-logs} to non-nil then @kbd{C-c l} will |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2461 store a @samp{file:/} style link to the relevant point in the logs for |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2462 the current conversation. Otherwise an @samp{irc:/} style link to the |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2463 user/channel/server under the point will be stored. For any other |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2464 files, the link will point to the file, with a search string |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2465 (@pxref{Search options}) pointing to the contents of the current line. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2466 If there is an active region, the selected words will form the basis |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2467 of the search string. If the automatically created link is not |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2468 working correctly or accurately enough, you can write custom functions |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2469 to select the search string and to do the search for particular file |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2470 types - see @ref{Custom searches}. The key binding @kbd{C-c l} is |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
2471 only a suggestion - see @ref{Installation}. |
84308 | 2472 @c |
2473 @kindex C-c C-l | |
2474 @cindex link completion | |
2475 @cindex completion, of links | |
2476 @cindex inserting links | |
2477 @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
|
2478 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
|
2479 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
|
2480 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
|
2481 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
|
2482 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
|
2483 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
|
2484 @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
|
2485 (@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
|
2486 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
|
2487 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
|
2488 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
|
2489 @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
|
2490 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
|
2491 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
|
2492 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
|
2493 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
|
2494 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
|
2495 optional descriptive text. |
84308 | 2496 @c |
2497 @c If the link is a @samp{file:} link and | |
2498 @c the linked file is located in the same directory as the current file or | |
2499 @c a subdirectory of it, the path of the file will be inserted relative to | |
2500 @c the current directory. | |
2501 @c | |
2502 @kindex C-u C-c C-l | |
2503 @cindex file name completion | |
2504 @cindex completion, of file names | |
2505 @item C-u C-c C-l | |
2506 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to | |
2507 a file will be inserted and you may use file name completion to select | |
2508 the name of the file. The path to the file is inserted relative to the | |
2509 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
|
2510 directory or in a sub-directory of it, or if the path is written relative |
84308 | 2511 to the current directory using @samp{../}. Otherwise an absolute path |
2512 is used, if possible with @samp{~/} for your home directory. You can | |
2513 force an absolute path with two @kbd{C-u} prefixes. | |
2514 @c | |
2515 @item C-c C-l @r{(with cursor on existing link)} | |
2516 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the | |
2517 link and description parts of the link. | |
2518 @c | |
2519 @cindex following links | |
2520 @kindex C-c C-o | |
2521 @item C-c C-o | |
2522 Open link at point. This will launch a web browser for URLs (using | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2523 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB |
84308 | 2524 for the corresponding links, and execute the command in a shell link. |
2525 When the cursor is on an internal link, this commands runs the | |
2526 corresponding search. When the cursor is on a TAG list in a headline, | |
2527 it creates the corresponding TAGS view. If the cursor is on a time | |
2528 stamp, it compiles the agenda for that date. Furthermore, it will visit | |
2529 text and remote files in @samp{file:} links with Emacs and select a | |
2530 suitable application for local non-text files. Classification of files | |
2531 is based on file extension only. See option @code{org-file-apps}. If | |
2532 you want to override the default application and visit the file with | |
2533 Emacs, use a @kbd{C-u} prefix. | |
2534 @c | |
2535 @kindex mouse-2 | |
2536 @kindex mouse-1 | |
2537 @item mouse-2 | |
2538 @itemx mouse-1 | |
2539 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o} | |
2540 would. Under Emacs 22, also @kbd{mouse-1} will follow a link. | |
2541 @c | |
2542 @kindex mouse-3 | |
2543 @item mouse-3 | |
2544 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and | |
2545 internal links to be displayed in another window@footnote{See the | |
2546 variable @code{org-display-internal-link-with-indirect-buffer}}. | |
2547 @c | |
2548 @cindex mark ring | |
2549 @kindex C-c % | |
2550 @item C-c % | |
2551 Push the current position onto the mark ring, to be able to return | |
2552 easily. Commands following an internal link do this automatically. | |
2553 @c | |
2554 @cindex links, returning to | |
2555 @kindex C-c & | |
2556 @item C-c & | |
2557 Jump back to a recorded position. A position is recorded by the | |
2558 commands following internal links, and by @kbd{C-c %}. Using this | |
2559 command several times in direct succession moves through a ring of | |
2560 previously recorded positions. | |
2561 @c | |
2562 @kindex C-c C-x C-n | |
2563 @kindex C-c C-x C-p | |
2564 @cindex links, finding next/previous | |
2565 @item C-c C-x C-n | |
2566 @itemx C-c C-x C-p | |
2567 Move forward/backward to the next link in the buffer. At the limit of | |
2568 the buffer, the search fails once, and then wraps around. The key | |
2569 bindings for this are really too long, you might want to bind this also | |
2570 to @kbd{C-n} and @kbd{C-p} | |
2571 @lisp | |
2572 (add-hook 'org-load-hook | |
2573 (lambda () | |
2574 (define-key 'org-mode-map "\C-n" 'org-next-link) | |
2575 (define-key 'org-mode-map "\C-p" 'org-previous-link))) | |
2576 @end lisp | |
2577 @end table | |
2578 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2579 @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
|
2580 @section Using links outside Org |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2581 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2582 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
|
2583 Org, but in any Emacs buffer. For this, you should create two |
84308 | 2584 global commands, like this (please select suitable global keys |
2585 yourself): | |
2586 | |
2587 @lisp | |
2588 (global-set-key "\C-c L" 'org-insert-link-global) | |
2589 (global-set-key "\C-c o" 'org-open-at-point-global) | |
2590 @end lisp | |
2591 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2592 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks |
84308 | 2593 @section Link abbreviations |
2594 @cindex link abbreviations | |
2595 @cindex abbreviation, links | |
2596 | |
2597 Long URLs can be cumbersome to type, and often many similar links are | |
2598 needed in a document. For this you can use link abbreviations. An | |
2599 abbreviated link looks like this | |
2600 | |
2601 @example | |
2602 [[linkword:tag][description]] | |
2603 @end example | |
2604 | |
2605 @noindent | |
2606 where the tag is optional. Such abbreviations are resolved according to | |
2607 the information in the variable @code{org-link-abbrev-alist} that | |
2608 relates the linkwords to replacement text. Here is an example: | |
2609 | |
2610 @lisp | |
2611 @group | |
2612 (setq org-link-abbrev-alist | |
2613 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=") | |
2614 ("google" . "http://www.google.com/search?q=") | |
2615 ("ads" . "http://adsabs.harvard.edu/cgi-bin/ | |
2616 nph-abs_connect?author=%s&db_key=AST"))) | |
2617 @end group | |
2618 @end lisp | |
2619 | |
2620 If the replacement text contains the string @samp{%s}, it will be | |
2621 replaced with the tag. Otherwise the tag will be appended to the string | |
2622 in order to create the link. You may also specify a function that will | |
2623 be called with the tag as the only argument to create the link. | |
2624 | |
2625 With the above setting, you could link to a specific bug with | |
2626 @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
|
2627 @code{[[google:OrgMode]]} and find out what the Org author is |
84308 | 2628 doing besides Emacs hacking with @code{[[ads:Dominik,C]]}. |
2629 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2630 If you need special abbreviations just for a single Org buffer, you |
84308 | 2631 can define them in the file with |
2632 | |
2633 @example | |
2634 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id= | |
2635 #+LINK: google http://www.google.com/search?q=%s | |
2636 @end example | |
2637 | |
2638 @noindent | |
2639 In-buffer completion @pxref{Completion} can be used after @samp{[} to | |
2640 complete link abbreviations. | |
2641 | |
2642 @node Search options, Custom searches, Link abbreviations, Hyperlinks | |
2643 @section Search options in file links | |
2644 @cindex search option in file links | |
2645 @cindex file links, searching | |
2646 | |
2647 File links can contain additional information to make Emacs jump to a | |
2648 particular location in the file when following a link. This can be a | |
2649 line number or a search option after a double@footnote{For backward | |
2650 compatibility, line numbers can also follow a single colon.} colon. For | |
2651 example, when the command @kbd{C-c l} creates a link (@pxref{Handling | |
2652 links}) to a file, it encodes the words in the current line as a search | |
2653 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
|
2654 link with @kbd{C-c C-o}. |
84308 | 2655 |
2656 Here is the syntax of the different ways to attach a search to a file | |
2657 link, together with an explanation: | |
2658 | |
2659 @example | |
2660 [[file:~/code/main.c::255]] | |
2661 [[file:~/xx.org::My Target]] | |
2662 [[file:~/xx.org::*My Target]] | |
2663 [[file:~/xx.org::/regexp/]] | |
2664 @end example | |
2665 | |
2666 @table @code | |
2667 @item 255 | |
2668 Jump to line 255. | |
2669 @item My Target | |
2670 Search for a link target @samp{<<My Target>>}, or do a text search for | |
2671 @samp{my target}, similar to the search in internal links, see | |
2672 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file | |
2673 link will become an HTML reference to the corresponding named anchor in | |
2674 the linked file. | |
2675 @item *My Target | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2676 In an Org file, restrict search to headlines. |
84308 | 2677 @item /regexp/ |
2678 Do a regular expression search for @code{regexp}. This uses the Emacs | |
2679 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
|
2680 target file is in Org mode, @code{org-occur} is used to create a |
84308 | 2681 sparse tree with the matches. |
2682 @c If the target file is a directory, | |
2683 @c @code{grep} will be used to search all files in the directory. | |
2684 @end table | |
2685 | |
2686 As a degenerate case, a file link with an empty file name can be used | |
2687 to search the current file. For example, @code{[[file:::find me]]} does | |
2688 a search for @samp{find me} in the current file, just as | |
2689 @samp{[[find me]]} would. | |
2690 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2691 @node Custom searches, , Search options, Hyperlinks |
84308 | 2692 @section Custom Searches |
2693 @cindex custom search strings | |
2694 @cindex search strings, custom | |
2695 | |
2696 The default mechanism for creating search strings and for doing the | |
2697 actual search related to a file link may not work correctly in all | |
2698 cases. For example, BibTeX database files have many entries like | |
2699 @samp{year="1993"} which would not result in good search strings, | |
2700 because the only unique identification for a BibTeX entry is the | |
2701 citation key. | |
2702 | |
2703 If you come across such a problem, you can write custom functions to set | |
2704 the right search string for a particular file type, and to do the search | |
2705 for the string in the file. Using @code{add-hook}, these functions need | |
2706 to be added to the hook variables | |
2707 @code{org-create-file-search-functions} and | |
2708 @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
|
2709 variables for more information. Org actually uses this mechanism |
84308 | 2710 for Bib@TeX{} database files, and you can use the corresponding code as |
2711 an implementation example. Search for @samp{BibTeX links} in the source | |
2712 file. | |
2713 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2714 @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
|
2715 @chapter TODO Items |
84308 | 2716 @cindex TODO items |
2717 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2718 Org mode does not maintain TODO lists as separate documents. Instead, |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2719 TODO items are an integral part of the notes file, because TODO items |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2720 usually come up while taking notes! With Org mode, simply mark any |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2721 entry in a tree as being a TODO item. In this way, information is not |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2722 duplicated, and the entire context from which the TODO item emerged is |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2723 always present. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2724 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2725 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
|
2726 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
|
2727 methods to give you an overview of all the things that you have to do. |
84308 | 2728 |
2729 @menu | |
2730 * TODO basics:: Marking and displaying TODO entries | |
2731 * TODO extensions:: Workflow and assignments | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2732 * Progress logging:: Dates and notes for progress |
84308 | 2733 * Priorities:: Some things are more important than others |
2734 * Breaking down tasks:: Splitting a task into manageable pieces | |
2735 * Checkboxes:: Tick-off lists | |
2736 @end menu | |
2737 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2738 @node TODO basics, TODO extensions, TODO Items, TODO Items |
84308 | 2739 @section Basic TODO functionality |
2740 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2741 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
|
2742 @samp{TODO}, for example: |
84308 | 2743 |
2744 @example | |
2745 *** TODO Write letter to Sam Fortune | |
2746 @end example | |
2747 | |
2748 @noindent | |
2749 The most important commands to work with TODO entries are: | |
2750 | |
2751 @table @kbd | |
2752 @kindex C-c C-t | |
2753 @cindex cycling, of TODO states | |
2754 @item C-c C-t | |
2755 Rotate the TODO state of the current item among | |
2756 | |
2757 @example | |
2758 ,-> (unmarked) -> TODO -> DONE --. | |
2759 '--------------------------------' | |
2760 @end example | |
2761 | |
2762 The same rotation can also be done ``remotely'' from the timeline and | |
2763 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
|
2764 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2765 @kindex C-u C-c C-t |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2766 @item C-u C-c C-t |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2767 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
|
2768 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
|
2769 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
|
2770 more information. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2771 |
84308 | 2772 @kindex S-@key{right} |
2773 @kindex S-@key{left} | |
2774 @item S-@key{right} | |
2775 @itemx S-@key{left} | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2776 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
|
2777 mostly if more than two TODO states are possible (@pxref{TODO |
84308 | 2778 extensions}). |
2779 @kindex C-c C-v | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2780 @kindex C-c / t |
84308 | 2781 @cindex sparse tree, for TODO |
2782 @item C-c C-v | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2783 @itemx C-c / t |
84308 | 2784 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds |
2785 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
|
2786 above them. With a prefix argument, search for a specific TODO. You will be |
84308 | 2787 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
|
2788 @code{KWD1|KWD2|...}. With numeric prefix argument N, show the tree for the |
84308 | 2789 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
|
2790 arguments, find all TODO and DONE entries. |
84308 | 2791 @kindex C-c a t |
2792 @item C-c a t | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2793 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
|
2794 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
|
2795 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
|
2796 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
|
2797 commands}). @xref{Global TODO list}, for more information. |
84308 | 2798 @kindex S-M-@key{RET} |
2799 @item S-M-@key{RET} | |
2800 Insert a new TODO entry below the current one. | |
2801 @end table | |
2802 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2803 @node TODO extensions, Progress logging, TODO basics, TODO Items |
84308 | 2804 @section Extended use of TODO keywords |
2805 @cindex extended TODO keywords | |
2806 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2807 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
|
2808 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
|
2809 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
|
2810 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
|
2811 files. |
84308 | 2812 |
2813 Note that @i{tags} are another way to classify headlines in general and | |
2814 TODO items in particular (@pxref{Tags}). | |
2815 | |
2816 @menu | |
2817 * Workflow states:: From TODO to DONE in steps | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2818 * TODO types:: I do this, Fred does the rest |
84308 | 2819 * 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
|
2820 * 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
|
2821 * Per-file keywords:: Different files, different requirements |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2822 * Faces for TODO keywords:: Highlighting states |
84308 | 2823 @end menu |
2824 | |
2825 @node Workflow states, TODO types, TODO extensions, TODO extensions | |
2826 @subsection TODO keywords as workflow states | |
2827 @cindex TODO workflow | |
2828 @cindex workflow states as TODO keywords | |
2829 | |
2830 You can use TODO keywords to indicate different @emph{sequential} states | |
2831 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
|
2832 this variable only becomes effective after restarting Org mode in a |
84308 | 2833 buffer.}: |
2834 | |
2835 @lisp | |
2836 (setq org-todo-keywords | |
2837 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED"))) | |
2838 @end lisp | |
2839 | |
2840 The vertical bar separates the TODO keywords (states that @emph{need | |
2841 action}) from the DONE states (which need @emph{no further action}. If | |
2842 you don't provide the separator bar, the last state is used as the DONE | |
2843 state. | |
2844 @cindex completion, of TODO keywords | |
2845 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO | |
2846 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
|
2847 also use a numeric prefix argument to quickly select a specific state. For |
84308 | 2848 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
|
2849 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
|
2850 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
|
2851 (@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
|
2852 (@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
|
2853 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
|
2854 @ref{Tracking TODO state changes} for more information. |
84308 | 2855 |
2856 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions | |
2857 @subsection TODO keywords as types | |
2858 @cindex TODO types | |
2859 @cindex names as TODO keywords | |
2860 @cindex types as TODO keywords | |
2861 | |
2862 The second possibility is to use TODO keywords to indicate different | |
2863 @emph{types} of action items. For example, you might want to indicate | |
2864 that items are for ``work'' or ``home''. Or, when you work with several | |
2865 people on a single project, you might want to assign action items | |
2866 directly to persons, by using their names as TODO keywords. This would | |
2867 be set up like this: | |
2868 | |
2869 @lisp | |
2870 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE"))) | |
2871 @end lisp | |
2872 | |
2873 In this case, different keywords do not indicate a sequence, but rather | |
2874 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
|
2875 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
|
2876 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
|
2877 @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
|
2878 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
|
2879 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
|
2880 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
|
2881 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
|
2882 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
|
2883 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
|
2884 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
|
2885 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
|
2886 argument as well when creating the global TODO list: @kbd{C-3 C-c t}. |
84308 | 2887 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2888 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions |
84308 | 2889 @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
|
2890 @cindex TODO keyword sets |
84308 | 2891 |
2892 Sometimes you may want to use different sets of TODO keywords in | |
2893 parallel. For example, you may want to have the basic | |
2894 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a | |
2895 separate state indicating that an item has been canceled (so it is not | |
2896 DONE, but also does not require action). Your setup would then look | |
2897 like this: | |
2898 | |
2899 @lisp | |
2900 (setq org-todo-keywords | |
2901 '((sequence "TODO" "|" "DONE") | |
2902 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED") | |
2903 (sequence "|" "CANCELED"))) | |
2904 @end lisp | |
2905 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
2906 The keywords should all be different, this helps Org mode to keep track |
84308 | 2907 of which subsequence should be used for a given entry. In this setup, |
2908 @kbd{C-c C-t} only operates within a subsequence, so it switches from | |
2909 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to | |
2910 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially | |
2911 select the correct sequence. Besides the obvious ways like typing a | |
2912 keyword or using completion, you may also apply the following commands: | |
2913 | |
2914 @table @kbd | |
2915 @kindex C-S-@key{right} | |
2916 @kindex C-S-@key{left} | |
2917 @item C-S-@key{right} | |
2918 @itemx C-S-@key{left} | |
2919 These keys jump from one TODO subset to the next. In the above example, | |
2920 @kbd{C-S-@key{right}} would jump from @code{TODO} or @code{DONE} to | |
2921 @code{REPORT}, and any of the words in the second row to @code{CANCELED}. | |
2922 @kindex S-@key{right} | |
2923 @kindex S-@key{left} | |
2924 @item S-@key{right} | |
2925 @itemx S-@key{left} | |
2926 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through | |
2927 @emph{all} keywords from all sets, so for example @kbd{S-@key{<right>}} | |
2928 would switch from @code{DONE} to @code{REPORT} in the example above. | |
2929 @end table | |
2930 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2931 @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
|
2932 @subsection Fast access to TODO states |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2933 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2934 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
|
2935 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
|
2936 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
|
2937 key after each keyword, in parenthesis. For example: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2938 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2939 @lisp |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2940 (setq org-todo-keywords |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2941 '((sequence "TODO(t)" "|" "DONE(d)") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2942 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2943 (sequence "|" "CANCELED(c)"))) |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2944 @end lisp |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2945 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2946 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
|
2947 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
|
2948 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
|
2949 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
|
2950 @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
|
2951 the default. Check also the variable |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2952 @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
|
2953 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
|
2954 like to mingle the two concepts. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2955 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2956 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions |
84308 | 2957 @subsection Setting up keywords for individual files |
2958 @cindex keyword options | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2959 @cindex per-file keywords |
84308 | 2960 |
2961 It can be very useful to use different aspects of the TODO mechanism in | |
2962 different files. For file-local settings, you need to add special lines | |
2963 to the file which set the keywords and interpretation for that file | |
2964 only. For example, to set one of the two examples discussed above, you | |
2965 need one of the following lines, starting in column zero anywhere in the | |
2966 file: | |
2967 | |
2968 @example | |
2969 #+SEQ_TODO: TODO FEEDBACK VERIFY | DONE CANCELED | |
2970 @end example | |
2971 or | |
2972 @example | |
2973 #+TYP_TODO: Fred Sara Lucy Mike | DONE | |
2974 @end example | |
2975 | |
2976 A setup for using several sets in parallel would be: | |
2977 | |
2978 @example | |
2979 #+SEQ_TODO: TODO | DONE | |
2980 #+SEQ_TODO: REPORT BUG KNOWNCAUSE | FIXED | |
2981 #+SEQ_TODO: | CANCELED | |
2982 @end example | |
2983 | |
2984 @cindex completion, of option keywords | |
2985 @kindex M-@key{TAB} | |
2986 @noindent To make sure you are using the correct keyword, type | |
2987 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion. | |
2988 | |
2989 @cindex DONE, final TODO keyword | |
2990 Remember that the keywords after the vertical bar (or the last keyword | |
2991 if no bar is there) must always mean that the item is DONE (although you | |
2992 may use a different word). After changing one of these lines, use | |
2993 @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
|
2994 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
|
2995 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
|
2996 cursor in a line starting with @samp{#+} is simply restarting Org mode |
84308 | 2997 for the current buffer.}. |
2998 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
2999 @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
|
3000 @subsection Faces for TODO keywords |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3001 @cindex faces, for TODO keywords |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3002 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3003 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
|
3004 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
|
3005 @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
|
3006 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
|
3007 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
|
3008 @code{org-todo-keyword-faces}. For example: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3009 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3010 @lisp |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3011 (setq org-todo-keyword-faces |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3012 '(("TODO" . org-warning) |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3013 ("DEFERRED" . shadow) |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3014 ("CANCELED" . (:foreground "blue" :weight bold)))) |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3015 @end lisp |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3016 |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3017 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
|
3018 @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
|
3019 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
|
3020 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3021 @page |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3022 @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
|
3023 @section Progress logging |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3024 @cindex progress logging |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3025 @cindex logging, of progress |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3026 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3027 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
|
3028 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
|
3029 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
|
3030 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
|
3031 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
|
3032 work time}. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3033 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3034 @menu |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3035 * Closing items:: When was this entry marked DONE? |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3036 * Tracking TODO state changes:: When did the status change? |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3037 @end menu |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3038 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3039 @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
|
3040 @subsection Closing items |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3041 |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3042 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
|
3043 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
|
3044 in-buffer setting is: @code{#+STARTUP: logdone}}. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3045 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3046 @lisp |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3047 (setq org-log-done 'time) |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3048 @end lisp |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3049 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3050 @noindent |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3051 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
|
3052 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
|
3053 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
|
3054 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
|
3055 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
|
3056 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}} |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3057 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3058 @lisp |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3059 (setq org-log-done 'note) |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3060 @end lisp |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3061 |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3062 @noindent |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3063 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
|
3064 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
|
3065 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3066 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
|
3067 (@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
|
3068 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
|
3069 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
|
3070 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3071 @node Tracking TODO state changes, , Closing items, Progress logging |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3072 @subsection Tracking TODO state changes |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3073 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3074 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
|
3075 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
|
3076 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
|
3077 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
|
3078 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
|
3079 @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
|
3080 after each keyword. For example, with the setting |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3081 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3082 @lisp |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3083 (setq org-todo-keywords |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3084 '((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
|
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 @noindent |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3088 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
|
3089 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
|
3090 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
|
3091 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
|
3092 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
|
3093 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
|
3094 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
|
3095 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
|
3096 @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
|
3097 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
|
3098 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
|
3099 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
|
3100 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
|
3101 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
|
3102 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
|
3103 configured. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3104 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3105 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
|
3106 to a buffer: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3107 @example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3108 #+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
|
3109 @end example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3110 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3111 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
|
3112 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
|
3113 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
|
3114 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
|
3115 @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
|
3116 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
|
3117 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3118 @example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3119 * 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
|
3120 :PROPERTIES: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3121 :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
|
3122 :END: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3123 * 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
|
3124 :PROPERTIES: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3125 :LOGGING: WAIT(@@) logrepeat |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3126 :END: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3127 * 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
|
3128 :PROPERTIES: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3129 :LOGGING: nil |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3130 :END: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3131 @end example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3132 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3133 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3134 @node Priorities, Breaking down tasks, Progress logging, TODO Items |
84308 | 3135 @section Priorities |
3136 @cindex priorities | |
3137 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3138 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
|
3139 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
|
3140 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
|
3141 this |
84308 | 3142 |
3143 @example | |
3144 *** TODO [#A] Write letter to Sam Fortune | |
3145 @end example | |
3146 | |
3147 @noindent | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3148 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
|
3149 @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
|
3150 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
|
3151 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
|
3152 no inherent meaning to Org mode. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3153 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3154 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
|
3155 to be TODO items. |
84308 | 3156 |
3157 @table @kbd | |
3158 @kindex @kbd{C-c ,} | |
3159 @item @kbd{C-c ,} | |
3160 Set the priority of the current headline. The command prompts for a | |
3161 priority character @samp{A}, @samp{B} or @samp{C}. When you press | |
3162 @key{SPC} instead, the priority cookie is removed from the headline. | |
3163 The priorities can also be changed ``remotely'' from the timeline and | |
3164 agenda buffer with the @kbd{,} command (@pxref{Agenda commands}). | |
3165 @c | |
3166 @kindex S-@key{up} | |
3167 @kindex S-@key{down} | |
3168 @item S-@key{up} | |
3169 @itemx S-@key{down} | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3170 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
|
3171 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
|
3172 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
|
3173 Furthermore, these keys are also used by CUA mode (@pxref{Conflicts}). |
84308 | 3174 @end table |
3175 | |
3176 You can change the range of allowed priorities by setting the variables | |
3177 @code{org-highest-priority}, @code{org-lowest-priority}, and | |
3178 @code{org-default-priority}. For an individual buffer, you may set | |
3179 these values (highest, lowest, default) like this (please make sure that | |
3180 the highest priority is earlier in the alphabet than the lowest | |
3181 priority): | |
3182 | |
3183 @example | |
3184 #+PRIORITIES: A C B | |
3185 @end example | |
3186 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3187 @node Breaking down tasks, Checkboxes, Priorities, TODO Items |
84308 | 3188 @section Breaking tasks down into subtasks |
3189 @cindex tasks, breaking down | |
3190 | |
3191 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
|
3192 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
|
3193 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
|
3194 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
|
3195 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
|
3196 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
|
3197 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
|
3198 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3199 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3200 * Organize Party [33%] |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3201 ** 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
|
3202 *** TODO Peter |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3203 *** DONE Sarah |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3204 ** TODO Buy food |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3205 ** DONE Talk to neighbor |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3206 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3207 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3208 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
|
3209 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
|
3210 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3211 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3212 (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
|
3213 "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
|
3214 (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
|
3215 (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
|
3216 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3217 (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
|
3218 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3219 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3220 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3221 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
|
3222 large number of subtasks (@pxref{Checkboxes}). |
84308 | 3223 |
3224 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3225 @node Checkboxes, , Breaking down tasks, TODO Items |
84308 | 3226 @section Checkboxes |
3227 @cindex checkboxes | |
3228 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3229 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
|
3230 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
|
3231 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
|
3232 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
|
3233 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
|
3234 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
|
3235 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
|
3236 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3237 Here is an example of a checkbox list. |
84308 | 3238 |
3239 @example | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3240 * 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
|
3241 - [-] call people [1/3] |
84308 | 3242 - [ ] Peter |
3243 - [X] Sarah | |
3244 - [ ] Sam | |
3245 - [X] order food | |
3246 - [ ] think about what music to play | |
3247 - [X] talk to the neighbors | |
3248 @end example | |
3249 | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3250 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
|
3251 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
|
3252 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
|
3253 checked. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3254 |
84308 | 3255 @cindex statistics, for checkboxes |
3256 @cindex checkbox statistics | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3257 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
|
3258 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
|
3259 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
|
3260 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
|
3261 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
|
3262 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
|
3263 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
|
3264 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
|
3265 @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
|
3266 the examples above. With @samp{[%]} you get information about the |
84308 | 3267 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
|
3268 @samp{[50%]} and @samp{[33%]}, respectively). |
84308 | 3269 |
3270 @noindent The following commands work with checkboxes: | |
3271 | |
3272 @table @kbd | |
3273 @kindex C-c C-c | |
3274 @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
|
3275 Toggle checkbox at point. With a prefix argument, set it to @samp{[-]}, |
84308 | 3276 which is considered to be an intermediate state. |
3277 @kindex C-c C-x C-b | |
3278 @item C-c C-x C-b | |
3279 Toggle checkbox at point. | |
3280 @itemize @minus | |
3281 @item | |
3282 If there is an active region, toggle the first checkbox in the region | |
3283 and set all remaining boxes to the same status as the first. If you | |
3284 want to toggle all boxes in the region independently, use a prefix | |
3285 argument. | |
3286 @item | |
3287 If the cursor is in a headline, toggle checkboxes in the region between | |
3288 this headline and the next (so @emph{not} the entire subtree). | |
3289 @item | |
3290 If there is no active region, just toggle the checkbox at point. | |
3291 @end itemize | |
3292 @kindex M-S-@key{RET} | |
3293 @item M-S-@key{RET} | |
3294 Insert a new item with a checkbox. | |
3295 This works only if the cursor is already in a plain list item | |
3296 (@pxref{Plain lists}). | |
3297 @kindex C-c # | |
3298 @item C-c # | |
3299 Update the checkbox statistics in the current outline entry. When | |
3300 called with a @kbd{C-u} prefix, update the entire file. Checkbox | |
3301 statistic cookies are updated automatically if you toggle checkboxes | |
3302 with @kbd{C-c C-c} and make new ones with @kbd{M-S-@key{RET}}. If you | |
3303 delete boxes or add/change them by hand, use this command to get things | |
3304 back into synch. Or simply toggle any checkbox twice with @kbd{C-c C-c}. | |
3305 @end table | |
3306 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3307 @node Tags, Properties and Columns, TODO Items, Top |
84308 | 3308 @chapter Tags |
3309 @cindex tags | |
3310 @cindex headline tagging | |
3311 @cindex matching, tags | |
3312 @cindex sparse tree, tag based | |
3313 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3314 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
|
3315 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
|
3316 support for tags. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3317 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3318 Every headline can contain a list of tags; they occur at the end of the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3319 headline. Tags are normal words containing letters, numbers, @samp{_}, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3320 and @samp{@@}. Tags must be preceded and followed by a single colon, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3321 e.g., @samp{:WORK:}. Several tags can be specified, as in |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3322 @samp{:work:URGENT:}. |
84308 | 3323 |
3324 @menu | |
3325 * Tag inheritance:: Tags use the tree structure of the outline | |
3326 * Setting tags:: How to assign tags to a headline | |
3327 * Tag searches:: Searching for combinations of tags | |
3328 @end menu | |
3329 | |
3330 @node Tag inheritance, Setting tags, Tags, Tags | |
3331 @section Tag inheritance | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3332 @cindex tag inheritance |
84308 | 3333 @cindex inheritance, of tags |
3334 @cindex sublevels, inclusion into tags match | |
3335 | |
3336 @i{Tags} make use of the hierarchical structure of outline trees. If a | |
3337 heading has a certain tag, all subheadings will inherit the tag as | |
3338 well. For example, in the list | |
3339 | |
3340 @example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3341 * Meeting with the French group :work: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3342 ** Summary by Frank :boss:notes: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3343 *** TODO Prepare slides for him :action: |
84308 | 3344 @end example |
3345 | |
3346 @noindent | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3347 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
|
3348 @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
|
3349 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
|
3350 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
|
3351 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
|
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 #+FILETAGS: :Peter:Boss:Secret: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3355 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3356 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3357 @noindent |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3358 To limit tag inheritance to specific tags, or to turn it off entirely, use |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3359 the variable @code{org-use-tag-inheritance}. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3360 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3361 When a headline matches during a tags search while tag inheritance is turned |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3362 on, all the sublevels in the same tree will match as well@footnote{This is |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3363 only true if the the search does not involve more complex tests including |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3364 properties (@pxref{Property searches}).}. The list of matches may then |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3365 become very long. If you only want to see the first tags match in a subtree, |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3366 configure the variable @code{org-tags-match-list-sublevels}. |
84308 | 3367 |
3368 @node Setting tags, Tag searches, Tag inheritance, Tags | |
3369 @section Setting tags | |
3370 @cindex setting tags | |
3371 @cindex tags, setting | |
3372 | |
3373 @kindex M-@key{TAB} | |
3374 Tags can simply be typed into the buffer at the end of a headline. | |
3375 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is | |
3376 also a special command for inserting tags: | |
3377 | |
3378 @table @kbd | |
3379 @kindex C-c C-c | |
3380 @item C-c C-c | |
3381 @cindex completion, of tags | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3382 Enter new tags for the current headline. Org mode will either offer |
84308 | 3383 completion or a special single-key interface for setting tags, see |
3384 below. After pressing @key{RET}, the tags will be inserted and aligned | |
3385 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all | |
3386 tags in the current buffer will be aligned to that column, just to make | |
3387 things look nice. TAGS are automatically realigned after promotion, | |
3388 demotion, and TODO state changes (@pxref{TODO basics}). | |
3389 @end table | |
3390 | |
3391 Org will support tag insertion based on a @emph{list of tags}. By | |
3392 default this list is constructed dynamically, containing all tags | |
3393 currently used in the buffer. You may also globally specify a hard list | |
3394 of tags with the variable @code{org-tag-alist}. Finally you can set | |
3395 the default tags for a given file with lines like | |
3396 | |
3397 @example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3398 #+TAGS: @@work @@home @@tennisclub |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3399 #+TAGS: laptop car pc sailboat |
84308 | 3400 @end example |
3401 | |
3402 If you have globally defined your preferred set of tags using the | |
3403 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
|
3404 in a specific file, add an empty TAGS option line to that file: |
84308 | 3405 |
3406 @example | |
3407 #+TAGS: | |
3408 @end example | |
3409 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3410 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
|
3411 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
|
3412 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
|
3413 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
|
3414 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
|
3415 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
|
3416 @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
|
3417 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
|
3418 like: |
84308 | 3419 |
3420 @lisp | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3421 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l))) |
84308 | 3422 @end lisp |
3423 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3424 @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
|
3425 can, instead, set the TAGS option line as: |
84308 | 3426 |
3427 @example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3428 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p) |
84308 | 3429 @end example |
3430 | |
3431 @noindent | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3432 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
|
3433 braces, as in: |
84308 | 3434 |
3435 @example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3436 #+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
|
3437 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3438 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3439 @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
|
3440 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed. |
84308 | 3441 |
3442 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of | |
3443 these lines to activate any changes. | |
3444 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3445 @noindent |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3446 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
|
3447 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
|
3448 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
|
3449 configuration: |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3450 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3451 @lisp |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3452 (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
|
3453 ("@@work" . ?w) ("@@home" . ?h) |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3454 ("@@tennisclub" . ?t) |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3455 (:endgroup . nil) |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3456 ("laptop" . ?l) ("pc" . ?p))) |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3457 @end lisp |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3458 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3459 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
|
3460 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
|
3461 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
|
3462 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
|
3463 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
|
3464 keys: |
84308 | 3465 |
3466 @table @kbd | |
3467 @item a-z... | |
3468 Pressing keys assigned to tags will add or remove them from the list of | |
3469 tags in the current line. Selecting a tag in a group of mutually | |
3470 exclusive tags will turn off any other tags from that group. | |
3471 @kindex @key{TAB} | |
3472 @item @key{TAB} | |
3473 Enter a tag in the minibuffer, even if the tag is not in the predefined | |
3474 list. You will be able to complete on all tags present in the buffer. | |
3475 @kindex @key{SPC} | |
3476 @item @key{SPC} | |
3477 Clear all tags for this line. | |
3478 @kindex @key{RET} | |
3479 @item @key{RET} | |
3480 Accept the modified set. | |
3481 @item C-g | |
3482 Abort without installing changes. | |
3483 @item q | |
3484 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}. | |
3485 @item ! | |
3486 Turn off groups of mutually exclusive tags. Use this to (as an | |
3487 exception) assign several tags from such a group. | |
3488 @item C-c | |
3489 Toggle auto-exit after the next change (see below). | |
3490 If you are using expert mode, the first @kbd{C-c} will display the | |
3491 selection window. | |
3492 @end table | |
3493 | |
3494 @noindent | |
3495 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
|
3496 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
|
3497 @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
|
3498 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
|
3499 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or |
84308 | 3500 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag |
3501 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h | |
3502 @key{RET} @key{RET}}. | |
3503 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3504 If you find that most of the time, you need only a single key press to |
84308 | 3505 modify your list of tags, set the variable |
3506 @code{org-fast-tag-selection-single-key}. Then you no longer have to | |
3507 press @key{RET} to exit fast tag selection - it will immediately exit | |
3508 after the first change. If you then occasionally need more keys, press | |
3509 @kbd{C-c} to turn off auto-exit for the current tag selection process | |
3510 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c | |
3511 C-c}). If you set the variable to the value @code{expert}, the special | |
3512 window is not even shown for single-key tag selection, it comes up only | |
3513 when you press an extra @kbd{C-c}. | |
3514 | |
3515 @node Tag searches, , Setting tags, Tags | |
3516 @section Tag searches | |
3517 @cindex tag searches | |
3518 @cindex searching for tags | |
3519 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3520 Once a system of tags has been set up, it can be used to collect related |
84308 | 3521 information into special lists. |
3522 | |
3523 @table @kbd | |
3524 @kindex C-c \ | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3525 @kindex C-c / T |
84308 | 3526 @item C-c \ |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3527 @itemx C-c / T |
84308 | 3528 Create a sparse tree with all headlines matching a tags search. With a |
3529 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line. | |
3530 @kindex C-c a m | |
3531 @item C-c a m | |
3532 Create a global list of tag matches from all agenda files. | |
3533 @xref{Matching tags and properties}. | |
3534 @kindex C-c a M | |
3535 @item C-c a M | |
3536 Create a global list of tag matches from all agenda files, but check | |
3537 only TODO items and force checking subitems (see variable | |
3538 @code{org-tags-match-list-sublevels}). | |
3539 @end table | |
3540 | |
3541 @cindex Boolean logic, for tag searches | |
3542 A @i{tags} search string can use Boolean operators @samp{&} for AND and | |
3543 @samp{|} for OR. @samp{&} binds more strongly than @samp{|}. | |
3544 Parenthesis are currently not implemented. A tag may also be preceded | |
3545 by @samp{-}, to select against it, and @samp{+} is syntactic sugar for | |
3546 positive selection. The AND operator @samp{&} is optional when @samp{+} | |
3547 or @samp{-} is present. Examples: | |
3548 | |
3549 @table @samp | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3550 @item +work-boss |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3551 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
|
3552 @samp{:boss:}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3553 @item work|laptop |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3554 Selects lines tagged @samp{:work:} or @samp{:laptop:}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3555 @item work|laptop&night |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3556 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
|
3557 @samp{:night:}. |
84308 | 3558 @end table |
3559 | |
3560 @cindex TODO keyword matching, with tags search | |
3561 If you are using multi-state TODO keywords (@pxref{TODO extensions}), it | |
3562 can be useful to also match on the TODO keyword. This can be done by | |
3563 adding a condition after a slash to a tags match. The syntax is similar | |
3564 to the tag matches, but should be applied with consideration: For | |
3565 example, a positive selection on several TODO keywords can not | |
3566 meaningfully be combined with boolean AND. However, @emph{negative | |
3567 selection} combined with AND can be meaningful. To make sure that only | |
3568 lines are checked that actually have any TODO keyword, use @kbd{C-c a | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3569 M}, or equivalently start the TODO part after the slash with @samp{!}. |
84308 | 3570 Examples: |
3571 | |
3572 @table @samp | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3573 @item work/WAITING |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3574 Select @samp{:work:}-tagged TODO lines with the specific TODO |
84308 | 3575 keyword @samp{WAITING}. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3576 @item work/!-WAITING-NEXT |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3577 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING} |
84308 | 3578 nor @samp{NEXT} |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3579 @item work/+WAITING|+NEXT |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3580 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or |
84308 | 3581 @samp{NEXT}. |
3582 @end table | |
3583 | |
3584 @cindex regular expressions, with tags search | |
3585 Any element of the tag/todo match can be a regular expression - in this | |
3586 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
|
3587 @samp{work+@{^boss.*@}} matches headlines that contain the tag |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3588 @samp{:work:} and any tag @i{starting} with @samp{boss}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3589 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3590 @cindex level, require for tags/property match |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3591 @cindex category, require for tags/property match |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3592 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
|
3593 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
|
3594 @samp{CATEGORY="work"}, respectively. For example, a search |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3595 @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
|
3596 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
|
3597 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3598 @node Properties and Columns, Dates and Times, Tags, Top |
84308 | 3599 @chapter Properties and Columns |
3600 @cindex properties | |
3601 | |
3602 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
|
3603 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
|
3604 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
|
3605 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
|
3606 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
|
3607 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
|
3608 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
|
3609 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
|
3610 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
|
3611 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
|
3612 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
|
3613 release, number of tracks, and so on. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3614 |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3615 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
|
3616 (@pxref{Column view}). |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3617 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3618 Properties are like tags, but with a value. For example, in a file |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3619 where you document bugs and plan releases of a piece of software, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3620 instead of using tags like @code{:release_1:}, @code{:release_2:}, it |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3621 can be more efficient to use a property @code{:Release:} with a value |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3622 @code{1.0} or @code{2.0}. Second, you can use properties to implement |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3623 (very basic) database capabilities in an Org buffer, for example to |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3624 create a list of Music CD's you own. You can edit and view properties |
84308 | 3625 conveniently in column view (@pxref{Column view}). |
3626 | |
3627 @menu | |
3628 * 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
|
3629 * Special properties:: Access to other Org mode features |
84308 | 3630 * Property searches:: Matching property values |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3631 * Property inheritance:: Passing values down the tree |
84308 | 3632 * Column view:: Tabular viewing and editing |
3633 * Property API:: Properties for Lisp programmers | |
3634 @end menu | |
3635 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3636 @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
|
3637 @section Property syntax |
84308 | 3638 @cindex property syntax |
3639 @cindex drawer, for properties | |
3640 | |
3641 Properties are key-value pairs. They need to be inserted into a special | |
3642 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property | |
3643 is specified on a single line, with the key (surrounded by colons) | |
3644 first, and the value after it. Here is an example: | |
3645 | |
3646 @example | |
3647 * CD collection | |
3648 ** Classic | |
3649 *** Goldberg Variations | |
3650 :PROPERTIES: | |
3651 :Title: Goldberg Variations | |
3652 :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
|
3653 :Artist: Glen Gould |
84308 | 3654 :Publisher: Deutsche Grammphon |
3655 :NDisks: 1 | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3656 :END: |
84308 | 3657 @end example |
3658 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3659 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
|
3660 by setting a property @samp{:Xyz_ALL:}. This special property is |
84308 | 3661 @emph{inherited}, so if you set it in a level 1 entry, it will apply to |
3662 the entire tree. When allowed values are defined, setting the | |
3663 corresponding property becomes easier and is less prone to typing | |
3664 errors. For the example with the CD collection, we can predefine | |
3665 publishers and the number of disks in a box like this: | |
3666 | |
3667 @example | |
3668 * CD collection | |
3669 :PROPERTIES: | |
3670 :NDisks_ALL: 1 2 3 4 | |
3671 :Publisher_ALL: "Deutsche Grammophon" Phillips EMI | |
3672 :END: | |
3673 @end example | |
3674 | |
3675 If you want to set properties that can be inherited by any entry in a | |
3676 file, use a line like | |
3677 | |
3678 @example | |
3679 #+PROPERTY: NDisks_ALL 1 2 3 4 | |
3680 @end example | |
3681 | |
3682 Property values set with the global variable | |
3683 @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
|
3684 Org files. |
84308 | 3685 |
3686 @noindent | |
3687 The following commands help to work with properties: | |
3688 | |
3689 @table @kbd | |
3690 @kindex M-@key{TAB} | |
3691 @item M-@key{TAB} | |
3692 After an initial colon in a line, complete property keys. All keys used | |
3693 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
|
3694 @kindex C-c C-x p |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3695 @item C-c C-x p |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3696 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
|
3697 necessary, the property drawer is created as well. |
84308 | 3698 @item M-x org-insert-property-drawer |
3699 Insert a property drawer into the current entry. The drawer will be | |
3700 inserted early in the entry, but after the lines with planning | |
3701 information like deadlines. | |
3702 @kindex C-c C-c | |
3703 @item C-c C-c | |
3704 With the cursor in a property drawer, this executes property commands. | |
3705 @item C-c C-c s | |
3706 Set a property in the current entry. Both the property and the value | |
3707 can be inserted using completion. | |
3708 @kindex S-@key{right} | |
3709 @kindex S-@key{left} | |
3710 @item S-@key{left}/@key{right} | |
3711 Switch property at point to the next/previous allowed value. | |
3712 @item C-c C-c d | |
3713 Remove a property from the current entry. | |
3714 @item C-c C-c D | |
3715 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
|
3716 @item C-c C-c c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3717 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
|
3718 nearest column format definition. |
84308 | 3719 @end table |
3720 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3721 @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
|
3722 @section Special properties |
84308 | 3723 @cindex properties, special |
3724 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3725 Special properties provide alternative access method to Org mode |
84308 | 3726 features discussed in the previous chapters, like the TODO state or the |
3727 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
|
3728 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
|
3729 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
|
3730 used as keys in the properties drawer: |
84308 | 3731 |
3732 @example | |
3733 TODO @r{The TODO keyword of the entry.} | |
3734 TAGS @r{The tags defined directly in the headline.} | |
3735 ALLTAGS @r{All tags, including inherited ones.} | |
3736 PRIORITY @r{The priority of the entry, a string with a single letter.} | |
3737 DEADLINE @r{The deadline time string, without the angular brackets.} | |
3738 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
|
3739 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
|
3740 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
|
3741 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
|
3742 @r{must be run first to compute the values.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3743 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3744 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3745 @node Property searches, Property inheritance, Special properties, Properties and Columns |
84308 | 3746 @section Property searches |
3747 @cindex properties, searching | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3748 @cindex searching, of properties |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3749 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3750 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
|
3751 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
|
3752 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
|
3753 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3754 @example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3755 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2+With=@{Sarah\|Denny@} |
84308 | 3756 @end example |
3757 | |
3758 @noindent | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3759 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
|
3760 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=}, |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3761 @samp{>=}, and @samp{<>}. If the comparison value is enclosed in double |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3762 quotes, a string comparison is done, and the same operators are allowed. If |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3763 the comparison value is enclosed in curly braces, a regexp match is |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3764 performed, with @samp{=} meaning that the regexp matches the property value, |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3765 and @samp{<>} meaning that it does not match. So the search string in the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3766 example finds entries tagged @samp{:work:} but not @samp{:boss:}, which also |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3767 have a priority value @samp{A}, a @samp{:Coffee:} property with the value |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3768 @samp{unlimited}, an @samp{Effort} property that is numerically smaller than |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3769 2, and a @samp{:With:} property that is matched by the regular expression |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3770 @samp{Sarah\|Denny}. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3771 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3772 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
|
3773 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
|
3774 inheritance} for details. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3775 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3776 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
|
3777 single property: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3778 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3779 @table @kbd |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3780 @kindex C-c / p |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3781 @item C-c / p |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3782 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
|
3783 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
|
3784 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
|
3785 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
|
3786 a regular expression and matched against the property values. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3787 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3788 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3789 @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
|
3790 @section Property Inheritance |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3791 @cindex properties, inheritance |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3792 @cindex inheritance, of properties |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3793 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3794 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
|
3795 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
|
3796 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
|
3797 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
|
3798 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
|
3799 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
|
3800 @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
|
3801 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
|
3802 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
|
3803 inherited properties. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3804 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3805 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
|
3806 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
|
3807 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3808 @table @code |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3809 @item COLUMNS |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3810 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
|
3811 (@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
|
3812 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
|
3813 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
|
3814 subtree from where columns view is turned on. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3815 @item CATEGORY |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3816 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
|
3817 applies to the entire subtree. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3818 @item ARCHIVE |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3819 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
|
3820 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
|
3821 @item LOGGING |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3822 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
|
3823 subtree (@pxref{Tracking TODO state changes}). |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3824 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3825 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3826 @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
|
3827 @section Column view |
84308 | 3828 |
3829 A great way to view and edit properties in an outline tree is | |
3830 @emph{column view}. In column view, each outline item is turned into a | |
3831 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
|
3832 entries. Org mode implements columns by overlaying a tabular structure |
84308 | 3833 over the headline of each item. While the headlines have been turned |
3834 into a table row, you can still change the visibility of the outline | |
3835 tree. For example, you get a compact table by switching to CONTENTS | |
3836 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view | |
3837 is active), but you can still open, read, and edit the entry below each | |
3838 headline. Or, you can switch to column view after executing a sparse | |
3839 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
|
3840 Column view also works in agenda buffers (@pxref{Agenda Views}) where |
84308 | 3841 queries have collected selected items, possibly from a number of files. |
3842 | |
3843 @menu | |
3844 * Defining columns:: The COLUMNS format property | |
3845 * 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
|
3846 * Capturing column view:: A dynamic block for column view |
84308 | 3847 @end menu |
3848 | |
3849 @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
|
3850 @subsection Defining columns |
84308 | 3851 @cindex column view, for properties |
3852 @cindex properties, column view | |
3853 | |
3854 Setting up a column view first requires defining the columns. This is | |
3855 done by defining a column format line. | |
3856 | |
3857 @menu | |
3858 * Scope of column definitions:: Where defined, where valid? | |
3859 * Column attributes:: Appearance and content of a column | |
3860 @end menu | |
3861 | |
3862 @node Scope of column definitions, Column attributes, Defining columns, Defining columns | |
3863 @subsubsection Scope of column definitions | |
3864 | |
3865 To define a column format for an entire file, use a line like | |
3866 | |
3867 @example | |
3868 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO | |
3869 @end example | |
3870 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3871 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
|
3872 @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
|
3873 |
84308 | 3874 @example |
3875 ** Top node for columns view | |
3876 :PROPERTIES: | |
3877 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO | |
3878 :END: | |
3879 @end example | |
3880 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3881 If a @code{:COLUMNS:} property is present in an entry, it defines columns |
84308 | 3882 for the entry itself, and for the entire subtree below it. Since the |
3883 column definition is part of the hierarchical structure of the document, | |
3884 you can define columns on level 1 that are general enough for all | |
3885 sublevels, and more specific columns further down, when you edit a | |
3886 deeper part of the tree. | |
3887 | |
3888 @node Column attributes, , Scope of column definitions, Defining columns | |
3889 @subsubsection Column attributes | |
3890 A column definition sets the attributes of a column. The general | |
3891 definition looks like this: | |
3892 | |
3893 @example | |
3894 %[width]property[(title)][@{summary-type@}] | |
3895 @end example | |
3896 | |
3897 @noindent | |
3898 Except for the percent sign and the property name, all items are | |
3899 optional. The individual parts have the following meaning: | |
3900 | |
3901 @example | |
3902 width @r{An integer specifying the width of the column in characters.} | |
3903 @r{If omitted, the width will be determined automatically.} | |
3904 property @r{The property that should be edited in this column.} | |
3905 (title) @r{The header text for the column. If omitted, the} | |
3906 @r{property name is used.} | |
3907 @{summary-type@} @r{The summary type. If specified, the column values for} | |
3908 @r{parent nodes are computed from the children.} | |
3909 @r{Supported summary types are:} | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3910 @{+@} @r{Sum numbers in this column.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3911 @{+;%.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
|
3912 @{$@} @r{Currency, short for @samp{+;%.2f}.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3913 @{:@} @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
|
3914 @{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
|
3915 @{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
|
3916 @{X%@} @r{Checkbox status, [n%].} |
84308 | 3917 @end example |
3918 | |
3919 @noindent | |
3920 Here is an example for a complete columns definition, along with allowed | |
3921 values. | |
3922 | |
3923 @example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3924 :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
|
3925 %10Time_Estimate@{:@} %CLOCKSUM |
84308 | 3926 :Owner_ALL: Tammy Mark Karl Lisa Don |
3927 :Status_ALL: "In progress" "Not started yet" "Finished" "" | |
3928 :Approved_ALL: "[ ]" "[X]" | |
3929 @end example | |
3930 | |
3931 The first column, @samp{%25ITEM}, means the first 25 characters of the | |
3932 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
|
3933 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
|
3934 create columns @samp{Owner} with a list of names as allowed values, for |
84308 | 3935 @samp{Status} with four different possible values, and for a checkbox |
3936 field @samp{Approved}. When no width is given after the @samp{%} | |
3937 character, the column will be exactly as wide as it needs to be in order | |
3938 to fully display all values. The @samp{Approved} column does have a | |
3939 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
|
3940 be created for the @samp{Time_Estimate} column by adding time duration |
84308 | 3941 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
|
3942 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
|
3943 @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
|
3944 in the subtree. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3945 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3946 @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
|
3947 @subsection Using column view |
84308 | 3948 |
3949 @table @kbd | |
3950 @tsubheading{Turning column view on and off} | |
3951 @kindex C-c C-x C-c | |
3952 @item C-c C-x C-c | |
3953 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
|
3954 the hierarchy, up from point, for a @code{:COLUMNS:} property that defines |
84308 | 3955 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
|
3956 the entire tree, starting from the entry that contains the @code{:COLUMNS:} |
84308 | 3957 property. If none is found, the format is taken from the @code{#+COLUMNS} |
3958 line or from the variable @code{org-columns-default-format}, and column | |
3959 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
|
3960 @kindex r |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3961 @item r |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
3962 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
|
3963 @kindex g |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3964 @item g |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
3965 Same as @kbd{r}. |
84308 | 3966 @kindex q |
3967 @item q | |
3968 Exit column view. | |
3969 @tsubheading{Editing values} | |
3970 @item @key{left} @key{right} @key{up} @key{down} | |
3971 Move through the column view from field to field. | |
3972 @kindex S-@key{left} | |
3973 @kindex S-@key{right} | |
3974 @item S-@key{left}/@key{right} | |
3975 Switch to the next/previous allowed value of the field. For this, you | |
3976 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
|
3977 @item 1..9,0 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
3978 Directly select the nth allowed value, @kbd{0} selects the 10th value. |
84308 | 3979 @kindex n |
3980 @kindex p | |
3981 @itemx n / p | |
3982 Same as @kbd{S-@key{left}/@key{right}} | |
3983 @kindex e | |
3984 @item e | |
3985 Edit the property at point. For the special properties, this will | |
3986 invoke the same interface that you normally use to change that | |
3987 property. For example, when editing a TAGS property, the tag completion | |
3988 or fast selection interface will pop up. | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3989 @kindex C-c C-c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3990 @item C-c C-c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
3991 When there is a checkbox at point, toggle it. |
84308 | 3992 @kindex v |
3993 @item v | |
3994 View the full value of this property. This is useful if the width of | |
3995 the column is smaller than that of the value. | |
3996 @kindex a | |
3997 @item a | |
3998 Edit the list of allowed values for this property. If the list is found | |
3999 in the hierarchy, the modified values is stored there. If no list is | |
4000 found, the new value is stored in the first entry that is part of the | |
4001 current column view. | |
4002 @tsubheading{Modifying the table structure} | |
4003 @kindex < | |
4004 @kindex > | |
4005 @item < / > | |
4006 Make the column narrower/wider by one character. | |
4007 @kindex S-M-@key{right} | |
4008 @item S-M-@key{right} | |
4009 Insert a new column, to the right of the current column. | |
4010 @kindex S-M-@key{left} | |
4011 @item S-M-@key{left} | |
4012 Delete the current column. | |
4013 @end table | |
4014 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4015 @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
|
4016 @subsection Capturing column view |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4017 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4018 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
|
4019 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
|
4020 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
|
4021 of this block looks like this: |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4022 |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4023 @cindex #+BEGIN: columnview |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4024 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4025 * The column view |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4026 #+BEGIN: columnview :hlines 1 :id "label" |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4027 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4028 #+END: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4029 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4030 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4031 @noindent This dynamic block has the following parameters: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4032 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4033 @table @code |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4034 @item :id |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4035 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
|
4036 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
|
4037 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
|
4038 capture, you can use 3 values: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4039 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4040 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
|
4041 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
|
4042 "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
|
4043 @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
|
4044 @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
|
4045 @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
|
4046 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4047 @item :hlines |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4048 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
|
4049 a hline before each headline with level @code{<= N}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4050 @item :vlines |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4051 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
|
4052 @item :maxlevel |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4053 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
|
4054 @item :skip-empty-rows |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4055 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
|
4056 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
|
4057 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4058 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4059 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4060 @noindent |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4061 The following commands insert or update the dynamic block: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4062 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4063 @table @kbd |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4064 @kindex C-c C-x r |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4065 @item C-c C-x r |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4066 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
|
4067 for the scope or id of the view. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4068 @kindex C-c C-c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4069 @item C-c C-c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4070 @kindex C-c C-x C-u |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4071 @itemx C-c C-x C-u |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4072 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
|
4073 @code{#+BEGIN} line of the dynamic block. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4074 @kindex C-u C-c C-x C-u |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4075 @item C-u C-c C-x C-u |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4076 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
|
4077 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
|
4078 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4079 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4080 @node Property API, , Column view, Properties and Columns |
84308 | 4081 @section The Property API |
4082 @cindex properties, API | |
4083 @cindex API, for properties | |
4084 | |
4085 There is a full API for accessing and changing properties. This API can | |
4086 be used by Emacs Lisp programs to work with properties and to implement | |
4087 features based on them. For more information see @ref{Using the | |
4088 property API}. | |
4089 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4090 @node Dates and Times, Remember, Properties and Columns, Top |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4091 @chapter Dates and Times |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4092 @cindex dates |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4093 @cindex times |
84308 | 4094 @cindex time stamps |
4095 @cindex date stamps | |
4096 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4097 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
|
4098 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
|
4099 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
|
4100 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
|
4101 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
|
4102 is used in a much wider sense. |
84308 | 4103 |
4104 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4105 * Timestamps:: Assigning a time to a tree entry |
84308 | 4106 * Creating timestamps:: Commands which insert timestamps |
4107 * 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
|
4108 * 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
|
4109 * Effort estimates:: Planning work effort in advance |
84308 | 4110 @end menu |
4111 | |
4112 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4113 @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
|
4114 @section Timestamps, deadlines and scheduling |
84308 | 4115 @cindex time stamps |
4116 @cindex ranges, time | |
4117 @cindex date stamps | |
4118 @cindex deadlines | |
4119 @cindex scheduling | |
4120 | |
4121 A time stamp is a specification of a date (possibly with time or a range | |
4122 of times) in a special format, either @samp{<2003-09-16 Tue>} or | |
4123 @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
|
4124 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
|
4125 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
|
4126 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
|
4127 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
|
4128 (@pxref{Weekly/daily agenda}). We distinguish: |
84308 | 4129 |
4130 @table @var | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4131 @item Plain time stamp; Event; Appointment |
84308 | 4132 @cindex timestamp |
4133 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
|
4134 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
|
4135 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
|
4136 plain time stamp will be shown exactly on that date. |
84308 | 4137 |
4138 @example | |
4139 * Meet Peter at the movies <2006-11-01 Wed 19:15> | |
4140 * Discussion on climate change <2006-11-02 Thu 20:00-22:00> | |
4141 @end example | |
4142 | |
4143 @item Time stamp with repeater interval | |
4144 @cindex timestamp, with repeater interval | |
4145 A time stamp may contain a @emph{repeater interval}, indicating that it | |
4146 applies not only on the given date, but again and again after a certain | |
4147 interval of N days (d), weeks (w), months(m), or years(y). The | |
4148 following will show up in the agenda every Wednesday: | |
4149 | |
4150 @example | |
4151 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w> | |
4152 @end example | |
4153 | |
4154 @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
|
4155 For more complex date specifications, Org mode supports using the |
84308 | 4156 special sexp diary entries implemented in the Emacs calendar/diary |
4157 package. For example | |
4158 | |
4159 @example | |
4160 * The nerd meeting on every 2nd Thursday of the month | |
4161 <%%(diary-float t 4 2)> | |
4162 @end example | |
4163 | |
4164 @item Time/Date range | |
4165 @cindex timerange | |
4166 @cindex date range | |
4167 Two time stamps connected by @samp{--} denote a range. The headline | |
4168 will be shown on the first and last day of the range, and on any dates | |
4169 that are displayed and fall in the range. Here is an example: | |
4170 | |
4171 @example | |
4172 ** Meeting in Amsterdam | |
4173 <2004-08-23 Mon>--<2004-08-26 Thu> | |
4174 @end example | |
4175 | |
4176 @item Inactive time stamp | |
4177 @cindex timestamp, inactive | |
4178 @cindex inactive timestamp | |
4179 Just like a plain time stamp, but with square brackets instead of | |
4180 angular ones. These time stamps are inactive in the sense that they do | |
4181 @emph{not} trigger an entry to show up in the agenda. | |
4182 | |
4183 @example | |
4184 * Gillian comes late for the fifth time [2006-11-01 Wed] | |
4185 @end example | |
4186 | |
4187 @end table | |
4188 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4189 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times |
84308 | 4190 @section Creating timestamps |
4191 @cindex creating timestamps | |
4192 @cindex timestamps, creating | |
4193 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4194 For Org mode to recognize time stamps, they need to be in the specific |
84308 | 4195 format. All commands listed below produce time stamps in the correct |
4196 format. | |
4197 | |
4198 @table @kbd | |
4199 @kindex C-c . | |
4200 @item C-c . | |
4201 Prompt for a date and insert a corresponding time stamp. When the | |
4202 cursor is at a previously used time stamp, it is updated to NOW. When | |
4203 this command is used twice in succession, a time range is inserted. | |
4204 @c | |
4205 @kindex C-u C-c . | |
4206 @item C-u C-c . | |
4207 Like @kbd{C-c .}, but use the alternative format which contains date | |
4208 and time. The default time can be rounded to multiples of 5 minutes, | |
4209 see the option @code{org-time-stamp-rounding-minutes}. | |
4210 @c | |
4211 @kindex C-c ! | |
4212 @item C-c ! | |
4213 Like @kbd{C-c .}, but insert an inactive time stamp that will not cause | |
4214 an agenda entry. | |
4215 @c | |
4216 @kindex C-c < | |
4217 @item C-c < | |
4218 Insert a time stamp corresponding to the cursor date in the Calendar. | |
4219 @c | |
4220 @kindex C-c > | |
4221 @item C-c > | |
4222 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
|
4223 timestamp in the current line, go to the corresponding date |
84308 | 4224 instead. |
4225 @c | |
4226 @kindex C-c C-o | |
4227 @item C-c C-o | |
4228 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
|
4229 point (@pxref{Weekly/daily agenda}). |
84308 | 4230 @c |
4231 @kindex S-@key{left} | |
4232 @kindex S-@key{right} | |
4233 @item S-@key{left} | |
4234 @itemx S-@key{right} | |
4235 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
|
4236 CUA mode (@pxref{Conflicts}). |
84308 | 4237 @c |
4238 @kindex S-@key{up} | |
4239 @kindex S-@key{down} | |
4240 @item S-@key{up} | |
4241 @itemx S-@key{down} | |
4242 Change the item under the cursor in a timestamp. The cursor can be on a | |
4243 year, month, day, hour or minute. Note that if the cursor is in a | |
4244 headline and not at a time stamp, these same keys modify the priority of | |
4245 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
|
4246 CUA mode (@pxref{Conflicts}). |
84308 | 4247 @c |
4248 @kindex C-c C-y | |
4249 @cindex evaluate time range | |
4250 @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
|
4251 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
|
4252 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
|
4253 the following column). |
84308 | 4254 @end table |
4255 | |
4256 | |
4257 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4258 * 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
|
4259 * Custom time format:: Making dates look different |
84308 | 4260 @end menu |
4261 | |
4262 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps | |
4263 @subsection The date/time prompt | |
4264 @cindex date, reading in minibuffer | |
4265 @cindex time, reading in minibuffer | |
4266 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4267 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
|
4268 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
|
4269 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
|
4270 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
|
4271 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
|
4272 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
|
4273 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
|
4274 @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
|
4275 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
|
4276 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
|
4277 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
|
4278 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
|
4279 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
|
4280 future date@footnote{See the variable |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4281 @code{org-read-date-prefer-future}.}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4282 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4283 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
|
4284 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
|
4285 in @b{bold}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4286 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4287 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4288 3-2-5 --> 2003-02-05 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4289 14 --> @b{2006}-@b{06}-14 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4290 12 --> @b{2006}-@b{07}-12 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4291 Fri --> nearest Friday (defaultdate or later) |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4292 sep 15 --> @b{2006}-11-15 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4293 feb 15 --> @b{2007}-02-15 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4294 sep 12 9 --> 2009-09-12 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4295 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
|
4296 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
|
4297 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
|
4298 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
|
4299 2012-w04-5 --> Same as above |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4300 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4301 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4302 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
|
4303 @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
|
4304 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
|
4305 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
|
4306 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
|
4307 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
|
4308 the nth such day. E.g. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4309 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4310 @example |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4311 +0 --> today |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4312 . --> today |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4313 +4d --> four days from today |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4314 +4 --> same as above |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4315 +2w --> two weeks from today |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4316 ++5 --> five days from default date |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4317 +2tue --> second tuesday from now. |
84308 | 4318 @end example |
4319 | |
4320 The function understands English month and weekday abbreviations. If | |
4321 you want to use unabbreviated names and/or other languages, configure | |
4322 the variables @code{parse-time-months} and @code{parse-time-weekdays}. | |
4323 | |
4324 @cindex calendar, for selecting date | |
4325 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If | |
4326 you don't need/want the calendar, configure the variable | |
4327 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date | |
4328 prompt, either by clicking on a date in the calendar, or by pressing | |
4329 @key{RET}, the date selected in the calendar will be combined with the | |
4330 information entered at the prompt. You can control the calendar fully | |
4331 from the minibuffer: | |
4332 | |
4333 @kindex < | |
4334 @kindex > | |
4335 @kindex mouse-1 | |
4336 @kindex S-@key{right} | |
4337 @kindex S-@key{left} | |
4338 @kindex S-@key{down} | |
4339 @kindex S-@key{up} | |
4340 @kindex M-S-@key{right} | |
4341 @kindex M-S-@key{left} | |
4342 @kindex @key{RET} | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4343 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4344 > / < @r{Scroll calendar forward/backward by one month.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4345 mouse-1 @r{Select date by clicking on it.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4346 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
|
4347 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
|
4348 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
|
4349 @key{RET} @r{Choose date in calendar.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4350 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4351 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4352 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
|
4353 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
|
4354 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
|
4355 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
|
4356 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
|
4357 @code{org-read-date-display-live}.}. |
84308 | 4358 |
4359 @node Custom time format, , The date/time prompt, Creating timestamps | |
4360 @subsection Custom time format | |
4361 @cindex custom date/time format | |
4362 @cindex time format, custom | |
4363 @cindex date format, custom | |
4364 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4365 Org mode uses the standard ISO notation for dates and times as it is |
84308 | 4366 defined in ISO 8601. If you cannot get used to this and require another |
4367 representation of date and time to keep you happy, you can get it by | |
4368 customizing the variables @code{org-display-custom-times} and | |
4369 @code{org-time-stamp-custom-formats}. | |
4370 | |
4371 @table @kbd | |
4372 @kindex C-c C-x C-t | |
4373 @item C-c C-x C-t | |
4374 Toggle the display of custom formats for dates and times. | |
4375 @end table | |
4376 | |
4377 @noindent | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4378 Org mode needs the default format for scanning, so the custom date/time |
84308 | 4379 format does not @emph{replace} the default format - instead it is put |
4380 @emph{over} the default format using text properties. This has the | |
4381 following consequences: | |
4382 @itemize @bullet | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4383 @item |
84308 | 4384 You cannot place the cursor onto a time stamp anymore, only before or |
4385 after. | |
4386 @item | |
4387 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust | |
4388 each component of a time stamp. If the cursor is at the beginning of | |
4389 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day, | |
4390 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the | |
4391 time will be changed by one minute. | |
4392 @item | |
4393 If the time stamp contains a range of clock times or a repeater, these | |
4394 will not be overlayed, but remain in the buffer as they were. | |
4395 @item | |
4396 When you delete a time stamp character-by-character, it will only | |
4397 disappear from the buffer after @emph{all} (invisible) characters | |
4398 belonging to the ISO timestamp have been removed. | |
4399 @item | |
4400 If the custom time stamp format is longer than the default and you are | |
4401 using dates in tables, table alignment will be messed up. If the custom | |
4402 format is shorter, things do work as expected. | |
4403 @end itemize | |
4404 | |
4405 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4406 @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
|
4407 @section Deadlines and scheduling |
84308 | 4408 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4409 A time stamp may be preceded by special keywords to facilitate planning: |
84308 | 4410 |
4411 @table @var | |
4412 @item DEADLINE | |
4413 @cindex DEADLINE keyword | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4414 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4415 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
|
4416 to be finished on that date. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4417 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4418 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
|
4419 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
|
4420 approaching or missed deadline, starting |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4421 @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
|
4422 until the entry is marked DONE. An example: |
84308 | 4423 |
4424 @example | |
4425 *** TODO write article about the Earth for the Guide | |
4426 The editor in charge is [[bbdb:Ford Prefect]] | |
4427 DEADLINE: <2004-02-29 Sun> | |
4428 @end example | |
4429 | |
4430 You can specify a different lead time for warnings for a specific | |
4431 deadlines using the following syntax. Here is an example with a warning | |
4432 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}. | |
4433 | |
4434 @item SCHEDULED | |
4435 @cindex SCHEDULED keyword | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4436 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4437 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
|
4438 date. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4439 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4440 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
|
4441 be listed on that date after it has been marked DONE. If you don't like |
84308 | 4442 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In |
4443 addition, a reminder that the scheduled date has passed will be present | |
4444 in the compilation for @emph{today}, until the entry is marked DONE. | |
4445 I.e., the task will automatically be forwarded until completed. | |
4446 | |
4447 @example | |
4448 *** TODO Call Trillian for a date on New Years Eve. | |
4449 SCHEDULED: <2004-12-25 Sat> | |
4450 @end example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4451 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4452 @noindent |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4453 @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
|
4454 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
|
4455 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
|
4456 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
|
4457 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
|
4458 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
|
4459 want to start working on an action item. |
84308 | 4460 @end table |
4461 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4462 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
|
4463 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
|
4464 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
|
4465 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
|
4466 @c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4467 @code{<%%(diary-float t 42)>} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4468 @c |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4469 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
|
4470 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
|
4471 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
|
4472 sexp entry matches. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4473 |
84308 | 4474 @menu |
4475 * Inserting deadline/schedule:: Planning items | |
4476 * Repeated tasks:: Items that show up again and again | |
4477 @end menu | |
4478 | |
4479 @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
|
4480 @subsection Inserting deadlines or schedules |
84308 | 4481 |
4482 The following commands allow to quickly insert a deadline or to schedule | |
4483 an item: | |
4484 | |
4485 @table @kbd | |
4486 @c | |
4487 @kindex C-c C-d | |
4488 @item C-c C-d | |
4489 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
|
4490 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
|
4491 prefix arg, an existing deadline will be removed from the entry. |
84308 | 4492 @c FIXME Any CLOSED timestamp will be removed.???????? |
4493 @c | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4494 @kindex C-c / d |
84308 | 4495 @cindex sparse tree, for deadlines |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4496 @item C-c / d |
84308 | 4497 Create a sparse tree with all deadlines that are either past-due, or |
4498 which will become due within @code{org-deadline-warning-days}. | |
4499 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
|
4500 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows |
84308 | 4501 all deadlines due tomorrow. |
4502 @c | |
4503 @kindex C-c C-s | |
4504 @item C-c C-s | |
4505 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will | |
4506 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
|
4507 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
|
4508 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
|
4509 @c |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4510 @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
|
4511 @kindex k a |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4512 @kindex k s |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4513 @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
|
4514 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
|
4515 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
|
4516 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
|
4517 schedule the marked item. |
84308 | 4518 @end table |
4519 | |
4520 @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
|
4521 @subsection Repeated tasks |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4522 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4523 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
|
4524 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
|
4525 or plain time stamp. In the following example |
84308 | 4526 @example |
4527 ** TODO Pay the rent | |
4528 DEADLINE: <2005-10-01 Sat +1m> | |
4529 @end example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4530 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
|
4531 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
|
4532 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
|
4533 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
|
4534 warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}. |
84308 | 4535 |
4536 Deadlines and scheduled items produce entries in the agenda when they | |
4537 are over-due, so it is important to be able to mark such an entry as | |
4538 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
|
4539 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
|
4540 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
|
4541 @emph{next} instance of the repeated entry will not be active. Org mode |
84308 | 4542 deals with this in the following way: When you try to mark such an entry |
4543 DONE (using @kbd{C-c C-t}), it will shift the base date of the repeating | |
4544 time stamp by the repeater interval, and immediately set the entry state | |
4545 back to TODO. In the example above, setting the state to DONE would | |
4546 actually switch the date like this: | |
4547 | |
4548 @example | |
4549 ** TODO Pay the rent | |
4550 DEADLINE: <2005-11-01 Tue +1m> | |
4551 @end example | |
4552 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4553 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
|
4554 @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
|
4555 @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
|
4556 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
|
4557 a record that you actually acted on the previous instance of this deadline. |
84308 | 4558 |
4559 As a consequence of shifting the base date, this entry will no longer be | |
4560 visible in the agenda when checking past dates, but all future instances | |
4561 will be visible. | |
4562 | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4563 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
|
4564 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
|
4565 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
|
4566 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
|
4567 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
|
4568 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
|
4569 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
|
4570 @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
|
4571 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
|
4572 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4573 @example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4574 ** TODO Call Father |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4575 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
|
4576 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
|
4577 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
|
4578 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
|
4579 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
|
4580 ** 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
|
4581 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
|
4582 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
|
4583 today. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4584 @end example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4585 |
84308 | 4586 You may have both scheduling and deadline information for a specific |
4587 task - just make sure that the repeater intervals on both are the same. | |
4588 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4589 @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
|
4590 @section Clocking work time |
84308 | 4591 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4592 Org mode allows you to clock the time you spent on specific tasks in a |
84308 | 4593 project. When you start working on an item, you can start the clock. |
4594 When you stop working on that task, or when you mark the task done, the | |
4595 clock is stopped and the corresponding time interval is recorded. It | |
4596 also computes the total time spent on each subtree of a project. | |
4597 | |
4598 @table @kbd | |
4599 @kindex C-c C-x C-i | |
4600 @item C-c C-x C-i | |
4601 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
|
4602 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
|
4603 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
|
4604 @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
|
4605 @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
|
4606 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
|
4607 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
|
4608 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
|
4609 with letter @kbd{d}. |
84308 | 4610 @kindex C-c C-x C-o |
4611 @item C-c C-x C-o | |
4612 Stop the clock (clock-out). The inserts another timestamp at the same | |
4613 location where the clock was last started. It also directly computes | |
4614 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
|
4615 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
|
4616 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
|
4617 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
|
4618 @code{#+STARTUP: lognoteclock-out}}. |
84308 | 4619 @kindex C-c C-y |
4620 @item C-c C-y | |
4621 Recompute the time interval after changing one of the time stamps. This | |
4622 is only necessary if you edit the time stamps directly. If you change | |
4623 them with @kbd{S-@key{cursor}} keys, the update is automatic. | |
4624 @kindex C-c C-t | |
4625 @item C-c C-t | |
4626 Changing the TODO state of an item to DONE automatically stops the clock | |
4627 if it is running in this same item. | |
4628 @kindex C-c C-x C-x | |
4629 @item C-c C-x C-x | |
4630 Cancel the current clock. This is useful if a clock was started by | |
4631 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
|
4632 @kindex C-c C-x C-j |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4633 @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
|
4634 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
|
4635 @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
|
4636 tasks. |
84308 | 4637 @kindex C-c C-x C-d |
4638 @item C-c C-x C-d | |
4639 Display time summaries for each subtree in the current buffer. This | |
4640 puts overlays at the end of each headline, showing the total time | |
4641 recorded under that heading, including the time of any subheadings. You | |
4642 can use visibility cycling to study the tree, but the overlays disappear | |
4643 when you change the buffer (see variable | |
4644 @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}. | |
4645 @kindex C-c C-x C-r | |
4646 @item C-c C-x C-r | |
4647 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
|
4648 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
|
4649 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
|
4650 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
|
4651 update it. |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4652 @cindex #+BEGIN: clocktable |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4653 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4654 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file |
84308 | 4655 #+END: clocktable |
4656 @end example | |
4657 @noindent | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4658 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
|
4659 new table. The @samp{BEGIN} line can specify options: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4660 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4661 :maxlevel @r{Maximum level depth to which times are listed in the table.} |
84308 | 4662 :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
|
4663 :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
|
4664 nil @r{the current buffer or narrowed region} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4665 file @r{the full current buffer} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4666 subtree @r{the subtree where the clocktable is located} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4667 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
|
4668 tree @r{the surrounding level 1 tree} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4669 agenda @r{all agenda files} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4670 ("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
|
4671 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
|
4672 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
|
4673 :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
|
4674 @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
|
4675 @r{these formats:} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4676 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
|
4677 2007-12 @r{December 2007} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4678 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
|
4679 2007 @r{the year 2007} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4680 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
|
4681 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
|
4682 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
|
4683 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
|
4684 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.} |
84308 | 4685 :tstart @r{A time string specifying when to start considering times} |
4686 :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
|
4687 :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
|
4688 @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
|
4689 :link @r{Link the item headlines in the table to their origins} |
84308 | 4690 @end example |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4691 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
|
4692 day, you could write |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4693 @example |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4694 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t |
84308 | 4695 #+END: clocktable |
4696 @end example | |
4697 and to use a specific time range you could write@footnote{Note that all | |
4698 parameters must be specified in a single line - the line is broken here | |
4699 only to fit it onto the manual.} | |
4700 @example | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4701 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>" |
84308 | 4702 :tend "<2006-08-10 Thu 12:00>" |
4703 #+END: clocktable | |
4704 @end example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4705 @kindex C-c C-c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4706 @item C-c C-c |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4707 @kindex C-c C-x C-u |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4708 @itemx C-c C-x C-u |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4709 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
|
4710 @code{#+BEGIN} line of the dynamic block. |
84308 | 4711 @kindex C-u C-c C-x C-u |
4712 @item C-u C-c C-x C-u | |
4713 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
|
4714 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
|
4715 @kindex S-@key{left} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4716 @kindex S-@key{right} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4717 @item S-@key{left} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4718 @itemx S-@key{right} |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4719 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
|
4720 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
|
4721 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc. |
84308 | 4722 @end table |
4723 | |
4724 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
|
4725 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been |
84308 | 4726 worked on or closed during a day. |
4727 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4728 @node Effort estimates, , 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
|
4729 @section Effort estimates |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4730 @cindex Effort estimates |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4731 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4732 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
|
4733 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
|
4734 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
|
4735 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
|
4736 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
|
4737 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
|
4738 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
|
4739 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
|
4740 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
|
4741 @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
|
4742 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
|
4743 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4744 @example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4745 #+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
|
4746 #+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
|
4747 @end example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4748 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4749 @noindent |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4750 or you can set up these values globally by customizing the variables |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4751 @code{org-global-properties} and @code{org-columns-default-format}. In |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4752 particular if you want to use this setup also in the agenda, a global setup |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4753 may be advised. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4754 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4755 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
|
4756 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
|
4757 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
|
4758 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
|
4759 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4760 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
|
4761 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
|
4762 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
|
4763 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
|
4764 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
|
4765 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
|
4766 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
|
4767 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
|
4768 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4769 @node Remember, Agenda Views, Dates and Times, Top |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4770 @chapter Remember |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4771 @cindex @file{remember.el} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4772 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4773 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
|
4774 little interruption of your work flow. See |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4775 @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
|
4776 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
|
4777 Org files. Org significantly expands the possibilities of |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4778 @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
|
4779 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
|
4780 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
|
4781 interactively, on the fly. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4782 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4783 @menu |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4784 * 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
|
4785 * Remember templates:: Define the outline of different note types |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4786 * 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
|
4787 * 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
|
4788 @end menu |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4789 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4790 @node Setting up Remember, Remember templates, Remember, Remember |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4791 @section Setting up Remember |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4792 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4793 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
|
4794 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
|
4795 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4796 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4797 (org-remember-insinuate) |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4798 (setq org-directory "~/path/to/my/orgfiles/") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4799 (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
|
4800 (define-key global-map "\C-cr" 'org-remember) |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4801 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4802 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4803 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
|
4804 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
|
4805 suggestion.}. @code{org-remember} basically just calls @code{remember}, |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4806 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
|
4807 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
|
4808 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
|
4809 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
|
4810 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
|
4811 remember note was stored. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4812 |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4813 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
|
4814 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
|
4815 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
|
4816 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
|
4817 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4818 @node Remember templates, Storing notes, Setting up Remember, Remember |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4819 @section Remember templates |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4820 @cindex templates, for remember |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4821 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
4822 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
|
4823 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
|
4824 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
|
4825 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
|
4826 use: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4827 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4828 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4829 (setq org-remember-templates |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4830 '(("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
|
4831 ("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
|
4832 ("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
|
4833 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4834 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4835 @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
|
4836 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
|
4837 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
|
4838 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
|
4839 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
|
4840 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
|
4841 @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
|
4842 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
|
4843 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
|
4844 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
|
4845 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4846 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
|
4847 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
|
4848 @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
|
4849 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
|
4850 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
|
4851 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
|
4852 selectable. |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4853 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4854 So for example: |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4855 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4856 @example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4857 (setq org-remember-templates |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4858 '(("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
|
4859 ("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
|
4860 ("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
|
4861 @end example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4862 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4863 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
|
4864 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
|
4865 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
|
4866 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
|
4867 |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4868 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
|
4869 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
|
4870 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
|
4871 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4872 * TODO |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4873 [[file:link to where you called remember]] |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4874 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4875 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4876 @noindent |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4877 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
|
4878 insertion of content: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4879 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4880 %^@{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
|
4881 @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
|
4882 @r{%^@{prompt|default|completion2|completion3...@}} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4883 @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
|
4884 %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
|
4885 %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
|
4886 %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
|
4887 @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
|
4888 %t @r{time stamp, date only} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4889 %T @r{time stamp with date and time} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4890 %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
|
4891 %^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
|
4892 @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
|
4893 %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
|
4894 %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
|
4895 %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
|
4896 %^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
|
4897 %^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
|
4898 %^g @r{prompt for tags, with completion on tags in target file.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4899 %^G @r{prompt for tags, with completion all tags in all agenda files.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4900 %: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
|
4901 %[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
|
4902 %(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
|
4903 %! @r{immediately store note after completing the template} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4904 @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
|
4905 %& @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
|
4906 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4907 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4908 @noindent |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4909 For specific link types, the following keywords will be |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4910 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
|
4911 hyperlink types}), any property you store with |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4912 @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
|
4913 similar way.}: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4914 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4915 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4916 Link type | Available keywords |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4917 -------------------+---------------------------------------------- |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4918 bbdb | %:name %:company |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4919 bbdb | %::server %:port %:nick |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4920 vm, wl, mh, rmail | %:type %:subject %:message-id |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4921 | %:from %:fromname %:fromaddress |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4922 | %:to %:toname %:toaddress |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4923 | %: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
|
4924 gnus | %:group, @r{for messages also all email fields} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4925 w3, w3m | %:url |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4926 info | %:file %:node |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4927 calendar | %:date" |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4928 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4929 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4930 @noindent |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4931 To place the cursor after template expansion use: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4932 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4933 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4934 %? @r{After completing the template, position cursor here.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4935 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4936 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4937 @noindent |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
4938 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
|
4939 @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
|
4940 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
|
4941 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4942 @node Storing notes, Refiling notes, Remember templates, Remember |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4943 @section Storing notes |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4944 |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4945 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
|
4946 @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
|
4947 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
|
4948 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
|
4949 @code{org-remember-clock-out-on-exit}.}. If you answer @kbd{n}, the clock |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4950 will continue to run after the note is filed away. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4951 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4952 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
|
4953 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
|
4954 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
|
4955 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
|
4956 during the last call to @code{remember}, exit the remember buffer with |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4957 @kbd{C-u C-u C-c C-c}, i.e. specify a double prefix argument to @kbd{C-c |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
4958 C-c}. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4959 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4960 If you want to store the note directly to a different place, use |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4961 @kbd{C-u C-c C-c} instead to exit remember@footnote{Configure the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4962 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
|
4963 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
|
4964 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
|
4965 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
|
4966 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
|
4967 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
|
4968 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
|
4969 location: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4970 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4971 @key{TAB} @r{Cycle visibility.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4972 @key{down} / @key{up} @r{Next/previous visible headline.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4973 n / p @r{Next/previous visible headline.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4974 f / b @r{Next/previous headline same level.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4975 u @r{One level up.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4976 @c 0-9 @r{Digit argument.} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4977 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4978 @noindent |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4979 Pressing @key{RET} or @key{left} or @key{right} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4980 then leads to the following result. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4981 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4982 @multitable @columnfractions 0.2 0.15 0.65 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4983 @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
|
4984 @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
|
4985 @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
|
4986 @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
|
4987 @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
|
4988 @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
|
4989 @item not on headline @tab @key{RET} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4990 @tab at cursor position, level taken from context. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4991 @end multitable |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4992 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4993 Before inserting the text into a tree, the function ensures that the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4994 text has a headline, i.e. a first line that starts with a @samp{*}. If |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4995 not, a headline is constructed from the current date and some additional |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4996 data. If you have indented the text of the note below the headline, the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4997 indentation will be adapted if inserting the note into the tree requires |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4998 demotion from level 1. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
4999 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5000 @node Refiling notes, , Storing notes, Remember |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5001 @section Refiling notes |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5002 @cindex refiling notes |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5003 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5004 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
|
5005 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
|
5006 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
|
5007 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
|
5008 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
|
5009 special command: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5010 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5011 @table @kbd |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5012 @kindex C-c C-w |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5013 @item C-c C-w |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5014 Refile the entry at point. This command offers possible locations for |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5015 refiling the entry and lets you select one with completion. The item is |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5016 filed below the target heading as a subitem. Depending on |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5017 @code{org-reverse-note-order}, it will be either the first of last |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5018 subitem.@* By default, all level 1 headlines in the current buffer are |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5019 considered to be targets, but you can have more complex definitions |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5020 across a number of files. See the variable @code{org-refile-targets} |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5021 for details. If you would like to select a location via a file-pathlike |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5022 completion along the outline path, see the variable |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5023 @code{org-refile-use-outline-path}. |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5024 @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
|
5025 @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
|
5026 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
|
5027 @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
|
5028 @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
|
5029 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
|
5030 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5031 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5032 @node Agenda Views, Embedded LaTeX, Remember, Top |
84308 | 5033 @chapter Agenda Views |
5034 @cindex agenda views | |
5035 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5036 Due to the way Org works, TODO items, time-stamped items, and |
84308 | 5037 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
|
5038 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
|
5039 important for a particular date, this information must be collected, |
84308 | 5040 sorted and displayed in an organized way. |
5041 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5042 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
|
5043 in a separate buffer. Seven different view types are provided: |
84308 | 5044 |
5045 @itemize @bullet | |
5046 @item | |
5047 an @emph{agenda} that is like a calendar and shows information | |
5048 for specific dates, | |
5049 @item | |
5050 a @emph{TODO list} that covers all unfinished | |
5051 action items, | |
5052 @item | |
5053 a @emph{tags view}, showings headlines based on | |
5054 the tags associated with them, | |
5055 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5056 a @emph{timeline view} that shows all events in a single Org file, |
84308 | 5057 in time-sorted view, |
5058 @item | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5059 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
|
5060 that contain specified keywords. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5061 @item |
84308 | 5062 a @emph{stuck projects view} showing projects that currently don't move |
5063 along, and | |
5064 @item | |
5065 @emph{custom views} that are special tag/keyword searches and | |
5066 combinations of different views. | |
5067 @end itemize | |
5068 | |
5069 @noindent | |
5070 The extracted information is displayed in a special @emph{agenda | |
5071 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
|
5072 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
|
5073 edit these files remotely. |
84308 | 5074 |
5075 Two variables control how the agenda buffer is displayed and whether the | |
5076 window configuration is restored when the agenda exits: | |
5077 @code{org-agenda-window-setup} and | |
5078 @code{org-agenda-restore-windows-after-quit}. | |
5079 | |
5080 @menu | |
5081 * Agenda files:: Files being searched for agenda information | |
5082 * Agenda dispatcher:: Keyboard access to agenda views | |
5083 * Built-in agenda views:: What is available out of the box? | |
5084 * 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
|
5085 * Agenda commands:: Remote editing of Org trees |
84308 | 5086 * 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
|
5087 * Agenda column view:: Using column view for collected entries |
84308 | 5088 @end menu |
5089 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5090 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views |
84308 | 5091 @section Agenda files |
5092 @cindex agenda files | |
5093 @cindex files for agenda | |
5094 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5095 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
|
5096 files}, the files listed in the variable |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5097 @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
|
5098 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
|
5099 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
|
5100 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
|
5101 of the list. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5102 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5103 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
|
5104 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
|
5105 @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
|
5106 the current file, and ignore @code{org-agenda-files} until the next |
84308 | 5107 dispatcher command.}. You can customize @code{org-agenda-files}, but |
5108 the easiest way to maintain it is through the following commands | |
5109 | |
5110 @cindex files, adding to agenda list | |
5111 @table @kbd | |
5112 @kindex C-c [ | |
5113 @item C-c [ | |
5114 Add current file to the list of agenda files. The file is added to | |
5115 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
|
5116 the front. With a prefix argument, file is added/moved to the end. |
84308 | 5117 @kindex C-c ] |
5118 @item C-c ] | |
5119 Remove current file from the list of agenda files. | |
5120 @kindex C-, | |
5121 @kindex C-' | |
5122 @item C-, | |
5123 @itemx C-' | |
5124 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
|
5125 @kindex M-x org-iswitchb |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5126 @item M-x org-iswitchb |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5127 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
|
5128 buffers. |
84308 | 5129 @end table |
5130 | |
5131 @noindent | |
5132 The Org menu contains the current list of files and can be used | |
5133 to visit any of them. | |
5134 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5135 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
|
5136 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
|
5137 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
|
5138 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
|
5139 (@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
|
5140 extended period, use the following commands: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5141 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5142 @table @kbd |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5143 @kindex C-c C-x < |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5144 @item C-c C-x < |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5145 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
|
5146 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
|
5147 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
|
5148 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
|
5149 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
|
5150 agenda view, the new restriction takes effect immediately. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5151 @kindex C-c C-x < |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5152 @item C-c C-x < |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5153 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
|
5154 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5155 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5156 @noindent |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5157 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
|
5158 the Speedbar frame: |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5159 @table @kbd |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5160 @kindex < |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5161 @item < @r{in the speedbar frame} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5162 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
|
5163 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
|
5164 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
|
5165 effect immediately. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5166 @kindex < |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5167 @item > @r{in the speedbar frame} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5168 Lift the restriction again. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5169 @end table |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5170 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5171 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views |
84308 | 5172 @section The agenda dispatcher |
5173 @cindex agenda dispatcher | |
5174 @cindex dispatching agenda commands | |
5175 The views are created through a dispatcher that should be bound to a | |
5176 global key, for example @kbd{C-c a} (@pxref{Installation}). In the | |
5177 following we will assume that @kbd{C-c a} is indeed how the dispatcher | |
5178 is accessed and list keyboard access to commands accordingly. After | |
5179 pressing @kbd{C-c a}, an additional letter is required to execute a | |
5180 command. The dispatcher offers the following default commands: | |
5181 @table @kbd | |
5182 @item a | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5183 Create the calendar-like agenda (@pxref{Weekly/daily agenda}). |
84308 | 5184 @item t @r{/} T |
5185 Create a list of all TODO items (@pxref{Global TODO list}). | |
5186 @item m @r{/} M | |
5187 Create a list of headlines matching a TAGS expression (@pxref{Matching | |
5188 tags and properties}). | |
5189 @item L | |
5190 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
|
5191 @item s |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5192 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
|
5193 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
|
5194 @item / |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5195 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
|
5196 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
|
5197 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
|
5198 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
|
5199 1. |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5200 @item # @r{/} ! |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5201 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
|
5202 @item < |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5203 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
|
5204 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
|
5205 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
|
5206 selecting the command. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5207 @item < < |
84308 | 5208 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
|
5209 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
|
5210 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
|
5211 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
|
5212 character selecting the command. |
84308 | 5213 @end table |
5214 | |
5215 You can also define custom commands that will be accessible through the | |
5216 dispatcher, just like the default commands. This includes the | |
5217 possibility to create extended agenda buffers that contain several | |
5218 blocks together, for example the weekly agenda, the global TODO list and | |
5219 a number of special tags matches. @xref{Custom agenda views}. | |
5220 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5221 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views |
84308 | 5222 @section The built-in agenda views |
5223 | |
5224 In this section we describe the built-in views. | |
5225 | |
5226 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5227 * Weekly/daily agenda:: The calendar page with current tasks |
84308 | 5228 * Global TODO list:: All unfinished action items |
5229 * Matching tags and properties:: Structured information with fine-tuned search | |
5230 * 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
|
5231 * Keyword search:: Finding entries by keyword |
84308 | 5232 * Stuck projects:: Find projects you need to review |
5233 @end menu | |
5234 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5235 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views |
84308 | 5236 @subsection The weekly/daily agenda |
5237 @cindex agenda | |
5238 @cindex weekly agenda | |
5239 @cindex daily agenda | |
5240 | |
5241 The purpose of the weekly/daily @emph{agenda} is to act like a page of a | |
5242 paper agenda, showing all the tasks for the current week or day. | |
5243 | |
5244 @table @kbd | |
5245 @cindex org-agenda, command | |
5246 @kindex C-c a a | |
5247 @item C-c a a | |
5248 Compile an agenda for the current week from a list of org files. The | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5249 agenda shows the entries for each day. With a numeric |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5250 prefix@footnote{For backward compatibility, the universal prefix |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5251 @kbd{C-u} causes all TODO entries to be listed before the agenda. This |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5252 feature is deprecated, use the dedicated TODO list, or a block agenda |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5253 instead.} (like @kbd{C-u 2 1 C-c a a}) you may set the number of days |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5254 to be displayed (see also the variable @code{org-agenda-ndays}) |
84308 | 5255 @end table |
5256 | |
5257 Remote editing from the agenda buffer means, for example, that you can | |
5258 change the dates of deadlines and appointments from the agenda buffer. | |
5259 The commands available in the Agenda buffer are listed in @ref{Agenda | |
5260 commands}. | |
5261 | |
5262 @subsubheading Calendar/Diary integration | |
5263 @cindex calendar integration | |
5264 @cindex diary integration | |
5265 | |
5266 Emacs contains the calendar and diary by Edward M. Reingold. The | |
5267 calendar displays a three-month calendar with holidays from different | |
5268 countries and cultures. The diary allows you to keep track of | |
5269 anniversaries, lunar phases, sunrise/set, recurrent appointments | |
5270 (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
|
5271 Org. It can be very useful to combine output from Org with |
84308 | 5272 the diary. |
5273 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5274 In order to include entries from the Emacs diary into Org mode's |
84308 | 5275 agenda, you only need to customize the variable |
5276 | |
5277 @lisp | |
5278 (setq org-agenda-include-diary t) | |
5279 @end lisp | |
5280 | |
5281 @noindent After that, everything will happen automatically. All diary | |
5282 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
|
5283 agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and |
84308 | 5284 @key{RET} can be used from the agenda buffer to jump to the diary |
5285 file in order to edit existing diary entries. The @kbd{i} command to | |
5286 insert new entries for the current date works in the agenda buffer, as | |
5287 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display | |
5288 Sunrise/Sunset times, show lunar phases and to convert to other | |
5289 calendars, respectively. @kbd{c} can be used to switch back and forth | |
5290 between calendar and agenda. | |
5291 | |
5292 If you are using the diary only for sexp entries and holidays, it is | |
5293 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
|
5294 the entries into an Org file. Org mode evaluates diary-style sexp |
84308 | 5295 entries, and does it faster because there is no overhead for first |
5296 creating the diary display. Note that the sexp entries must start at | |
5297 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
|
5298 the following segment of an Org file will be processed and entries |
84308 | 5299 will be made in the agenda: |
5300 | |
5301 @example | |
5302 * Birthdays and similar stuff | |
5303 #+CATEGORY: Holiday | |
5304 %%(org-calendar-holiday) ; special function for holiday names | |
5305 #+CATEGORY: Ann | |
5306 %%(diary-anniversary 14 5 1956) Arthur Dent is %d years old | |
5307 %%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old | |
5308 @end example | |
5309 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5310 @subsubheading Appointment reminders |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5311 @cindex @file{appt.el} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5312 @cindex appointment reminders |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5313 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5314 Org can interact with Emacs appointments notification facility. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5315 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5316 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
|
5317 @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
|
5318 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
|
5319 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
|
5320 details. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5321 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5322 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views |
84308 | 5323 @subsection The global TODO list |
5324 @cindex global TODO list | |
5325 @cindex TODO list, global | |
5326 | |
5327 The global TODO list contains all unfinished TODO items, formatted and | |
5328 collected into a single place. | |
5329 | |
5330 @table @kbd | |
5331 @kindex C-c a t | |
5332 @item C-c a t | |
5333 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
|
5334 agenda files (@pxref{Agenda Views}) into a single buffer. The buffer is in |
84308 | 5335 @code{agenda-mode}, so there are commands to examine and manipulate |
5336 the TODO entries directly from that buffer (@pxref{Agenda commands}). | |
5337 @kindex C-c a T | |
5338 @item C-c a T | |
5339 @cindex TODO keyword matching | |
5340 Like the above, but allows selection of a specific TODO keyword. You | |
5341 can also do this by specifying a prefix argument to @kbd{C-c a t}. With | |
5342 a @kbd{C-u} prefix you are prompted for a keyword, and you may also | |
5343 specify several keywords by separating them with @samp{|} as boolean OR | |
5344 operator. With a numeric prefix, the Nth keyword in | |
5345 @code{org-todo-keywords} is selected. | |
5346 @kindex r | |
5347 The @kbd{r} key in the agenda buffer regenerates it, and you can give | |
5348 a prefix argument to this command to change the selected TODO keyword, | |
5349 for example @kbd{3 r}. If you often need a search for a specific | |
5350 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@* | |
5351 Matching specific TODO keywords can also be done as part of a tags | |
5352 search (@pxref{Tag searches}). | |
5353 @end table | |
5354 | |
5355 Remote editing of TODO items means that you can change the state of a | |
5356 TODO entry with a single key press. The commands available in the | |
5357 TODO list are described in @ref{Agenda commands}. | |
5358 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5359 @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
|
5360 Normally the global TODO list simply shows all headlines with TODO |
84308 | 5361 keywords. This list can become very long. There are two ways to keep |
5362 it more compact: | |
5363 @itemize @minus | |
5364 @item | |
5365 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
|
5366 execution (@pxref{Timestamps}) as no longer @emph{open}. Configure the |
84308 | 5367 variable @code{org-agenda-todo-ignore-scheduled} to exclude scheduled |
5368 items from the global TODO list. | |
5369 @item | |
5370 TODO items may have sublevels to break up the task into subtasks. In | |
5371 such cases it may be enough to list only the highest level TODO headline | |
5372 and omit the sublevels from the global list. Configure the variable | |
5373 @code{org-agenda-todo-list-sublevels} to get this behavior. | |
5374 @end itemize | |
5375 | |
5376 @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
|
5377 @subsection Matching tags and properties |
84308 | 5378 @cindex matching, of tags |
5379 @cindex matching, of properties | |
5380 @cindex tags view | |
5381 | |
5382 If headlines in the agenda files are marked with @emph{tags} | |
5383 (@pxref{Tags}), you can select headlines based on the tags that apply | |
5384 to them and collect them into an agenda buffer. | |
5385 | |
5386 @table @kbd | |
5387 @kindex C-c a m | |
5388 @item C-c a m | |
5389 Produce a list of all headlines that match a given set of tags. The | |
5390 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
|
5391 expression with tags, like @samp{+work+urgent-withboss} or |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5392 @samp{work|home} (@pxref{Tags}). If you often need a specific search, |
84308 | 5393 define a custom command for it (@pxref{Agenda dispatcher}). |
5394 @kindex C-c a M | |
5395 @item C-c a M | |
5396 Like @kbd{C-c a m}, but only select headlines that are also TODO items | |
5397 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
|
5398 @code{org-tags-match-list-sublevels}). Matching specific TODO keywords |
84308 | 5399 together with a tags match is also possible, see @ref{Tag searches}. |
5400 @end table | |
5401 | |
5402 The commands available in the tags list are described in @ref{Agenda | |
5403 commands}. | |
5404 | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5405 @node Timeline, Keyword search, Matching tags and properties, Built-in agenda views |
84308 | 5406 @subsection Timeline for a single file |
5407 @cindex timeline, single file | |
5408 @cindex time-sorted view | |
5409 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5410 The timeline summarizes all time-stamped items from a single Org mode |
84308 | 5411 file in a @emph{time-sorted view}. The main purpose of this command is |
5412 to give an overview over events in a project. | |
5413 | |
5414 @table @kbd | |
5415 @kindex C-c a L | |
5416 @item C-c a L | |
5417 Show a time-sorted view of the org file, with all time-stamped items. | |
5418 When called with a @kbd{C-u} prefix, all unfinished TODO entries | |
5419 (scheduled or not) are also listed under the current date. | |
5420 @end table | |
5421 | |
5422 @noindent | |
5423 The commands available in the timeline buffer are listed in | |
5424 @ref{Agenda commands}. | |
5425 | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5426 @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
|
5427 @subsection Keyword search |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5428 @cindex keyword search |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5429 @cindex searching, for keywords |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5430 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5431 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
|
5432 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
|
5433 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5434 @table @kbd |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5435 @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
|
5436 @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
|
5437 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
|
5438 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
|
5439 string |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5440 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5441 @example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5442 +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
|
5443 @end example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5444 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5445 @noindent |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5446 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
|
5447 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
|
5448 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
|
5449 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
|
5450 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5451 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
|
5452 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
|
5453 @end table |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5454 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5455 @node Stuck projects, , Keyword search, Built-in agenda views |
84308 | 5456 @subsection Stuck projects |
5457 | |
5458 If you are following a system like David Allen's GTD to organize your | |
5459 work, one of the ``duties'' you have is a regular review to make sure | |
5460 that all projects move along. A @emph{stuck} project is a project that | |
5461 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
|
5462 Org mode produces. During the review, you need to identify such |
84308 | 5463 projects and define next actions for them. |
5464 | |
5465 @table @kbd | |
5466 @kindex C-c a # | |
5467 @item C-c a # | |
5468 List projects that are stuck. | |
5469 @kindex C-c a ! | |
5470 @item C-c a ! | |
5471 Customize the variable @code{org-stuck-projects} to define what a stuck | |
5472 project is and how to find it. | |
5473 @end table | |
5474 | |
5475 You almost certainly will have to configure this view before it will | |
5476 work for you. The built-in default assumes that all your projects are | |
5477 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
|
5478 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
|
5479 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5480 Lets assume that you, in your own way of using Org mode, identify |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5481 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to |
84308 | 5482 indicate a project that should not be considered yet. Lets further |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5483 assume that the TODO keyword DONE marks finished projects, and that NEXT |
84308 | 5484 and TODO indicate next actions. The tag @@SHOP indicates shopping and |
5485 is a next action even without the NEXT tag. Finally, if the project | |
5486 contains the special word IGNORE anywhere, it should not be listed | |
5487 either. In this case you would start by identifying eligible projects | |
5488 with a tags/todo match @samp{+PROJECT/-MAYBE-DONE}, and then check for | |
5489 TODO, NEXT, @@SHOP, and IGNORE in the subtree to identify projects that | |
5490 are not stuck. The correct customization for this is | |
5491 | |
5492 @lisp | |
5493 (setq org-stuck-projects | |
5494 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP") | |
5495 "\\<IGNORE\\>")) | |
5496 @end lisp | |
5497 | |
5498 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5499 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views |
84308 | 5500 @section Presentation and sorting |
5501 @cindex presentation, of agenda items | |
5502 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5503 Before displaying items in an agenda view, Org mode visually prepares |
84308 | 5504 the items and sorts them. Each item occupies a single line. The line |
5505 starts with a @emph{prefix} that contains the @emph{category} | |
5506 (@pxref{Categories}) of the item and other important information. You can | |
5507 customize the prefix using the option @code{org-agenda-prefix-format}. | |
5508 The prefix is followed by a cleaned-up version of the outline headline | |
5509 associated with the item. | |
5510 | |
5511 @menu | |
5512 * Categories:: Not all tasks are equal | |
5513 * Time-of-day specifications:: How the agenda knows the time | |
5514 * Sorting of agenda items:: The order of things | |
5515 @end menu | |
5516 | |
5517 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting | |
5518 @subsection Categories | |
5519 | |
5520 @cindex category | |
5521 The category is a broad label assigned to each agenda item. By default, | |
5522 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
|
5523 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
|
5524 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
|
5525 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
|
5526 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
|
5527 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
|
5528 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
|
5529 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
|
5530 property.}: |
84308 | 5531 |
5532 @example | |
5533 #+CATEGORY: Thesis | |
5534 @end example | |
5535 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5536 @noindent |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5537 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
|
5538 (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
|
5539 as the value (@pxref{Properties and Columns}). |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5540 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5541 @noindent |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5542 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
|
5543 longer than 10 characters. |
84308 | 5544 |
5545 @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
|
5546 @subsection Time-of-day specifications |
84308 | 5547 @cindex time-of-day specification |
5548 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5549 Org mode checks each agenda item for a time-of-day specification. The |
84308 | 5550 time can be part of the time stamp that triggered inclusion into the |
5551 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time | |
5552 ranges can be specified with two time stamps, like | |
5553 @c | |
5554 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}. | |
5555 | |
5556 In the headline of the entry itself, a time(range) may also appear as | |
5557 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
|
5558 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time |
84308 | 5559 specifications in diary entries are recognized as well. |
5560 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5561 For agenda display, Org mode extracts the time and displays it in a |
84308 | 5562 standard 24 hour format as part of the prefix. The example times in |
5563 the previous paragraphs would end up in the agenda like this: | |
5564 | |
5565 @example | |
5566 8:30-13:00 Arthur Dent lies in front of the bulldozer | |
5567 12:45...... Ford Prefect arrives and takes Arthur to the pub | |
5568 19:00...... The Vogon reads his poem | |
5569 20:30-22:15 Marwin escorts the Hitchhikers to the bridge | |
5570 @end example | |
5571 | |
5572 @cindex time grid | |
5573 If the agenda is in single-day mode, or for the display of today, the | |
5574 timed entries are embedded in a time grid, like | |
5575 | |
5576 @example | |
5577 8:00...... ------------------ | |
5578 8:30-13:00 Arthur Dent lies in front of the bulldozer | |
5579 10:00...... ------------------ | |
5580 12:00...... ------------------ | |
5581 12:45...... Ford Prefect arrives and takes Arthur to the pub | |
5582 14:00...... ------------------ | |
5583 16:00...... ------------------ | |
5584 18:00...... ------------------ | |
5585 19:00...... The Vogon reads his poem | |
5586 20:00...... ------------------ | |
5587 20:30-22:15 Marwin escorts the Hitchhikers to the bridge | |
5588 @end example | |
5589 | |
5590 The time grid can be turned on and off with the variable | |
5591 @code{org-agenda-use-time-grid}, and can be configured with | |
5592 @code{org-agenda-time-grid}. | |
5593 | |
5594 @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting | |
5595 @subsection Sorting of agenda items | |
5596 @cindex sorting, of agenda items | |
5597 @cindex priorities, of agenda items | |
5598 Before being inserted into a view, the items are sorted. How this is | |
5599 done depends on the type of view. | |
5600 @itemize @bullet | |
5601 @item | |
5602 For the daily/weekly agenda, the items for each day are sorted. The | |
5603 default order is to first collect all items containing an explicit | |
5604 time-of-day specification. These entries will be shown at the beginning | |
5605 of the list, as a @emph{schedule} for the day. After that, items remain | |
5606 grouped in categories, in the sequence given by @code{org-agenda-files}. | |
5607 Within each category, items are sorted by priority (@pxref{Priorities}), | |
5608 which is composed of the base priority (2000 for priority @samp{A}, 1000 | |
5609 for @samp{B}, and 0 for @samp{C}), plus additional increments for | |
5610 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
|
5611 @item |
84308 | 5612 For the TODO list, items remain in the order of categories, but within |
5613 each category, sorting takes place according to priority | |
5614 (@pxref{Priorities}). | |
5615 @item | |
5616 For tags matches, items are not sorted at all, but just appear in the | |
5617 sequence in which they are found in the agenda files. | |
5618 @end itemize | |
5619 | |
5620 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
|
5621 @code{org-agenda-sorting-strategy}, and may also include criteria based on |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5622 the estimated effort of an entry. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5623 @c FIXME: link!!!!!!!! |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5624 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5625 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5626 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views |
84308 | 5627 @section Commands in the agenda buffer |
5628 @cindex commands, in agenda buffer | |
5629 | |
5630 Entries in the agenda buffer are linked back to the org file or diary | |
5631 file where they originate. You are not allowed to edit the agenda | |
5632 buffer itself, but commands are provided to show and jump to the | |
5633 original entry location, and to edit the org-files ``remotely'' from | |
5634 the agenda buffer. In this way, all information is stored only once, | |
5635 removing the risk that your agenda and note files may diverge. | |
5636 | |
5637 Some commands can be executed with mouse clicks on agenda lines. For | |
5638 the other commands, the cursor needs to be in the desired line. | |
5639 | |
5640 @table @kbd | |
5641 @tsubheading{Motion} | |
5642 @cindex motion commands in agenda | |
5643 @kindex n | |
5644 @item n | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5645 Next line (same as @key{up} and @kbd{C-p}). |
84308 | 5646 @kindex p |
5647 @item p | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5648 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
|
5649 @tsubheading{View/Go to org file} |
84308 | 5650 @kindex mouse-3 |
5651 @kindex @key{SPC} | |
5652 @item mouse-3 | |
5653 @itemx @key{SPC} | |
5654 Display the original location of the item in another window. | |
5655 @c | |
5656 @kindex L | |
5657 @item L | |
5658 Display original location and recenter that window. | |
5659 @c | |
5660 @kindex mouse-2 | |
5661 @kindex mouse-1 | |
5662 @kindex @key{TAB} | |
5663 @item mouse-2 | |
5664 @itemx mouse-1 | |
5665 @itemx @key{TAB} | |
5666 Go to the original location of the item in another window. Under Emacs | |
5667 22, @kbd{mouse-1} will also works for this. | |
5668 @c | |
5669 @kindex @key{RET} | |
5670 @itemx @key{RET} | |
5671 Go to the original location of the item and delete other windows. | |
5672 @c | |
5673 @kindex f | |
5674 @item f | |
5675 Toggle Follow mode. In Follow mode, as you move the cursor through | |
5676 the agenda buffer, the other window always shows the corresponding | |
5677 location in the org file. The initial setting for this mode in new | |
5678 agenda buffers can be set with the variable | |
5679 @code{org-agenda-start-with-follow-mode}. | |
5680 @c | |
5681 @kindex b | |
5682 @item b | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5683 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
|
5684 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
|
5685 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
|
5686 previously used indirect buffer. |
84308 | 5687 @c |
5688 @kindex l | |
5689 @item l | |
96072
2398ec3bc9c5
Fix typo (where -> were).
Stephen Eglen <stephen@gnu.org>
parents:
96057
diff
changeset
|
5690 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while |
84308 | 5691 logging was on (variable @code{org-log-done}) are shown in the agenda, |
5692 as are entries that have been clocked on that day. | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5693 @c |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5694 @kindex R |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5695 @item R |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5696 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
|
5697 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
|
5698 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
|
5699 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
|
5700 @code{org-agenda-start-with-clockreport-mode}. |
84308 | 5701 |
5702 @tsubheading{Change display} | |
5703 @cindex display changing, in agenda | |
5704 @kindex o | |
5705 @item o | |
5706 Delete other windows. | |
5707 @c | |
5708 @kindex d | |
5709 @kindex w | |
5710 @kindex m | |
5711 @kindex y | |
5712 @item d w m y | |
5713 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
|
5714 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
|
5715 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
|
5716 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
|
5717 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
|
5718 @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
|
5719 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
|
5720 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
|
5721 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
|
5722 be mapped to the interval 1938-2037. |
84308 | 5723 @c |
5724 @kindex D | |
5725 @item D | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5726 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}. |
84308 | 5727 @c |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5728 @kindex G |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5729 @item G |
84308 | 5730 Toggle the time grid on and off. See also the variables |
5731 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}. | |
5732 @c | |
5733 @kindex r | |
5734 @item r | |
5735 Recreate the agenda buffer, for example to reflect the changes | |
5736 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
|
5737 S-@key{right}. When the buffer is the global TODO list, a prefix |
84308 | 5738 argument is interpreted to create a selective list for a specific TODO |
5739 keyword. | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5740 @kindex g |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5741 @item g |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5742 Same as @kbd{r}. |
84308 | 5743 @c |
5744 @kindex s | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5745 @kindex C-x C-s |
84308 | 5746 @item s |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5747 @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
|
5748 Save all Org buffers in the current Emacs session. |
84308 | 5749 @c |
5750 @kindex @key{right} | |
5751 @item @key{right} | |
5752 Display the following @code{org-agenda-ndays} days. For example, if | |
5753 the display covers a week, switch to the following week. With prefix | |
5754 arg, go forward that many times @code{org-agenda-ndays} days. | |
5755 @c | |
5756 @kindex @key{left} | |
5757 @item @key{left} | |
5758 Display the previous dates. | |
5759 @c | |
5760 @kindex . | |
5761 @item . | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5762 Go to today. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5763 @c |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5764 @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
|
5765 @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
|
5766 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
|
5767 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
|
5768 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
|
5769 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
|
5770 @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
|
5771 @code{org-columns-default-format}), will be used in the agenda. |
84308 | 5772 |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5773 @tsubheading{Query editing} |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5774 @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
|
5775 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5776 @kindex [ |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5777 @kindex ] |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5778 @kindex @{ |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5779 @kindex @} |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5780 @item [ ] @{ @} |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5781 In the @i{search view} (@pxref{Keyword search}), these keys add new |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5782 search words (@kbd{[} and @kbd{]}) or new regular expressions (@kbd{@{} |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5783 and @kbd{@}}) to the query string. The opening bracket/brace will add a |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5784 positive search term prefixed by @samp{+}, indicating that this search |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5785 term @i{must} occur/match in the entry. Closing bracket/brace add a |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5786 negative search term which @i{must not} occur/match in the entry for it |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5787 to be selected. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5788 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
5789 |
84308 | 5790 @tsubheading{Remote editing} |
5791 @cindex remote editing, from agenda | |
5792 | |
5793 @item 0-9 | |
5794 Digit argument. | |
5795 @c | |
5796 @cindex undoing remote-editing events | |
5797 @cindex remote editing, undo | |
5798 @kindex C-_ | |
5799 @item C-_ | |
5800 Undo a change due to a remote editing command. The change is undone | |
5801 both in the agenda buffer and in the remote buffer. | |
5802 @c | |
5803 @kindex t | |
5804 @item t | |
5805 Change the TODO state of the item, both in the agenda and in the | |
5806 original org file. | |
5807 @c | |
5808 @kindex C-k | |
5809 @item C-k | |
5810 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
|
5811 to it in the original Org file. If the text to be deleted remotely |
84308 | 5812 is longer than one line, the kill needs to be confirmed by the user. See |
5813 variable @code{org-agenda-confirm-kill}. | |
5814 @c | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5815 @kindex a |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5816 @item a |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5817 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
|
5818 @c |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5819 @kindex A |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5820 @item A |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5821 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
|
5822 Sibling}. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5823 @c |
84308 | 5824 @kindex $ |
5825 @item $ | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5826 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
|
5827 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
|
5828 different file. |
84308 | 5829 @c |
5830 @kindex T | |
5831 @item T | |
5832 Show all tags associated with the current item. Because of | |
5833 inheritance, this may be more than the tags listed in the line itself. | |
5834 @c | |
5835 @kindex : | |
5836 @item : | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5837 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
|
5838 agenda, change a tag for all headings in the region. |
84308 | 5839 @c |
5840 @kindex , | |
5841 @item , | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5842 Set the priority for the current item. Org mode prompts for the |
84308 | 5843 priority character. If you reply with @key{SPC}, the priority cookie |
5844 is removed from the entry. | |
5845 @c | |
5846 @kindex P | |
5847 @item P | |
5848 Display weighted priority of current item. | |
5849 @c | |
5850 @kindex + | |
5851 @kindex S-@key{up} | |
5852 @item + | |
5853 @itemx S-@key{up} | |
5854 Increase the priority of the current item. The priority is changed in | |
5855 the original buffer, but the agenda is not resorted. Use the @kbd{r} | |
5856 key for this. | |
5857 @c | |
5858 @kindex - | |
5859 @kindex S-@key{down} | |
5860 @item - | |
5861 @itemx S-@key{down} | |
5862 Decrease the priority of the current item. | |
5863 @c | |
5864 @kindex C-c C-s | |
5865 @item C-c C-s | |
5866 Schedule this item | |
5867 @c | |
5868 @kindex C-c C-d | |
5869 @item C-c C-d | |
5870 Set a deadline for this item. | |
5871 @c | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5872 @kindex k |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5873 @item k |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5874 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
|
5875 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
|
5876 additonal key: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5877 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5878 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
|
5879 @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
|
5880 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
|
5881 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
|
5882 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
|
5883 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5884 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
|
5885 command. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
5886 @c |
84308 | 5887 @kindex S-@key{right} |
5888 @item S-@key{right} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5889 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
|
5890 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
|
5891 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
|
5892 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
|
5893 the agenda buffer. Use the @kbd{r} key to update the buffer. |
84308 | 5894 @c |
5895 @kindex S-@key{left} | |
5896 @item S-@key{left} | |
5897 Change the time stamp associated with the current line by one day | |
5898 into the past. | |
5899 @c | |
5900 @kindex > | |
5901 @item > | |
5902 Change the time stamp associated with the current line to today. | |
5903 The key @kbd{>} has been chosen, because it is the same as @kbd{S-.} | |
5904 on my keyboard. | |
5905 @c | |
5906 @kindex I | |
5907 @item I | |
5908 Start the clock on the current item. If a clock is running already, it | |
5909 is stopped first. | |
5910 @c | |
5911 @kindex O | |
5912 @item O | |
5913 Stop the previously started clock. | |
5914 @c | |
5915 @kindex X | |
5916 @item X | |
5917 Cancel the currently running clock. | |
5918 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5919 @kindex J |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5920 @item J |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5921 Jump to the running clock in another window. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
5922 |
84308 | 5923 @tsubheading{Calendar commands} |
5924 @cindex calendar commands, from agenda | |
5925 @kindex c | |
5926 @item c | |
5927 Open the Emacs calendar and move to the date at the agenda cursor. | |
5928 @c | |
5929 @item c | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5930 When in the calendar, compute and show the Org mode agenda for the |
84308 | 5931 date at the cursor. |
5932 @c | |
5933 @cindex diary entries, creating from agenda | |
5934 @kindex i | |
5935 @item i | |
5936 Insert a new entry into the diary. Prompts for the type of entry | |
5937 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new | |
5938 entry in the diary, just as @kbd{i d} etc. would do in the calendar. | |
5939 The date is taken from the cursor position. | |
5940 @c | |
5941 @kindex M | |
5942 @item M | |
5943 Show the phases of the moon for the three months around current date. | |
5944 @c | |
5945 @kindex S | |
5946 @item S | |
5947 Show sunrise and sunset times. The geographical location must be set | |
5948 with calendar variables, see documentation of the Emacs calendar. | |
5949 @c | |
5950 @kindex C | |
5951 @item C | |
5952 Convert the date at cursor into many other cultural and historic | |
5953 calendars. | |
5954 @c | |
5955 @kindex H | |
5956 @item H | |
5957 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
|
5958 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5959 @item M-x org-export-icalendar-combine-agenda-files |
84308 | 5960 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
|
5961 This is a globally available command, and also available in the agenda menu. |
84308 | 5962 |
5963 @tsubheading{Exporting to a file} | |
5964 @kindex C-x C-w | |
5965 @item C-x C-w | |
5966 @cindex exporting agenda views | |
5967 @cindex agenda views, exporting | |
5968 Write the agenda view to a file. Depending on the extension of the | |
5969 selected file name, the view will be exported as HTML (extension | |
5970 @file{.html} or @file{.htm}), Postscript (extension @file{.ps}), or | |
5971 plain text (any other extension). Use the variable | |
5972 @code{org-agenda-exporter-settings} to set options for @file{ps-print} | |
5973 and for @file{htmlize} to be used during export. | |
5974 | |
5975 @tsubheading{Quit and Exit} | |
5976 @kindex q | |
5977 @item q | |
5978 Quit agenda, remove the agenda buffer. | |
5979 @c | |
5980 @kindex x | |
5981 @cindex agenda files, removing buffers | |
5982 @item x | |
5983 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs | |
5984 for the compilation of the agenda. Buffers created by the user to | |
5985 visit org files will not be removed. | |
5986 @end table | |
5987 | |
5988 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
5989 @node Custom agenda views, Agenda column view, Agenda commands, Agenda Views |
84308 | 5990 @section Custom agenda views |
5991 @cindex custom agenda views | |
5992 @cindex agenda views, custom | |
5993 | |
5994 Custom agenda commands serve two purposes: to store and quickly access | |
5995 frequently used TODO and tags searches, and to create special composite | |
5996 agenda buffers. Custom agenda commands will be accessible through the | |
5997 dispatcher (@pxref{Agenda dispatcher}), just like the default commands. | |
5998 | |
5999 @menu | |
6000 * Storing searches:: Type once, use often | |
6001 * Block agenda:: All the stuff you need in a single buffer | |
6002 * 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
|
6003 * 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
|
6004 * Using the agenda elsewhere:: Using agenda information in other programs |
84308 | 6005 @end menu |
6006 | |
6007 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views | |
6008 @subsection Storing searches | |
6009 | |
6010 The first application of custom searches is the definition of keyboard | |
6011 shortcuts for frequently used searches, either creating an agenda | |
6012 buffer, or a sparse tree (the latter covering of course only the current | |
6013 buffer). | |
6014 @kindex C-c a C | |
6015 Custom commands are configured in the variable | |
6016 @code{org-agenda-custom-commands}. You can customize this variable, for | |
6017 example by pressing @kbd{C-c a C}. You can also directly set it with | |
6018 Emacs Lisp in @file{.emacs}. The following example contains all valid | |
6019 search types: | |
6020 | |
6021 @lisp | |
6022 @group | |
6023 (setq org-agenda-custom-commands | |
6024 '(("w" todo "WAITING") | |
6025 ("W" todo-tree "WAITING") | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6026 ("u" tags "+boss-urgent") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6027 ("v" tags-todo "+boss-urgent") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6028 ("U" tags-tree "+boss-urgent") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6029 ("f" occur-tree "\\<FIXME\\>") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6030 ("h" . "HOME+Name tags searches") ; description for "h" prefix |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6031 ("hl" tags "+home+Lisa") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6032 ("hp" tags "+home+Peter") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6033 ("hk" tags "+home+Kim"))) |
84308 | 6034 @end group |
6035 @end lisp | |
6036 | |
6037 @noindent | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6038 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
|
6039 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
|
6040 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
|
6041 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
|
6042 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
|
6043 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
|
6044 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
|
6045 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
|
6046 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
|
6047 therefore define: |
84308 | 6048 |
6049 @table @kbd | |
6050 @item C-c a w | |
6051 as a global search for TODO entries with @samp{WAITING} as the TODO | |
6052 keyword | |
6053 @item C-c a W | |
6054 as the same search, but only in the current buffer and displaying the | |
6055 results as a sparse tree | |
6056 @item C-c a u | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6057 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
|
6058 @samp{:urgent:} |
84308 | 6059 @item C-c a v |
6060 as the same search as @kbd{C-c a u}, but limiting the search to | |
6061 headlines that are also TODO items | |
6062 @item C-c a U | |
6063 as the same search as @kbd{C-c a u}, but only in the current buffer and | |
6064 displaying the result as a sparse tree | |
6065 @item C-c a f | |
6066 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
|
6067 containing the word @samp{FIXME} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6068 @item C-c a h |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6069 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
|
6070 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
|
6071 Peter, or Kim) as additional tag to match. |
84308 | 6072 @end table |
6073 | |
6074 @node Block agenda, Setting Options, Storing searches, Custom agenda views | |
6075 @subsection Block agenda | |
6076 @cindex block agenda | |
6077 @cindex agenda, with block views | |
6078 | |
6079 Another possibility is the construction of agenda views that comprise | |
6080 the results of @emph{several} commands, each of which creates a block in | |
6081 the agenda buffer. The available commands include @code{agenda} for the | |
6082 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
|
6083 for the global TODO list (as constructed with @kbd{C-c a t}), and the |
84308 | 6084 matching commands discussed above: @code{todo}, @code{tags}, and |
6085 @code{tags-todo}. Here are two examples: | |
6086 | |
6087 @lisp | |
6088 @group | |
6089 (setq org-agenda-custom-commands | |
6090 '(("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
|
6091 ((agenda "") |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6092 (tags-todo "home") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6093 (tags "garden"))) |
84308 | 6094 ("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
|
6095 ((agenda "") |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6096 (tags-todo "work") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6097 (tags "office"))))) |
84308 | 6098 @end group |
6099 @end lisp | |
6100 | |
6101 @noindent | |
6102 This will define @kbd{C-c a h} to create a multi-block view for stuff | |
6103 you need to attend to at home. The resulting agenda buffer will contain | |
6104 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
|
6105 @samp{home}, and also all lines tagged with @samp{garden}. Finally the |
84308 | 6106 command @kbd{C-c a o} provides a similar view for office tasks. |
6107 | |
6108 @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
|
6109 @subsection Setting options for custom commands |
84308 | 6110 @cindex options, for custom agenda views |
6111 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6112 Org mode contains a number of variables regulating agenda construction |
84308 | 6113 and display. The global variables define the behavior for all agenda |
6114 commands, including the custom commands. However, if you want to change | |
6115 some settings just for a single custom view, you can do so. Setting | |
6116 options requires inserting a list of variable names and values at the | |
6117 right spot in @code{org-agenda-custom-commands}. For example: | |
6118 | |
6119 @lisp | |
6120 @group | |
6121 (setq org-agenda-custom-commands | |
6122 '(("w" todo "WAITING" | |
6123 ((org-agenda-sorting-strategy '(priority-down)) | |
6124 (org-agenda-prefix-format " Mixed: "))) | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6125 ("U" tags-tree "+boss-urgent" |
84308 | 6126 ((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
|
6127 (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
|
6128 ("N" search "" |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6129 ((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
|
6130 (org-agenda-text-search-extra-files nil))))) |
84308 | 6131 @end group |
6132 @end lisp | |
6133 | |
6134 @noindent | |
6135 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
|
6136 priority, and the prefix format is modified to just say @samp{ Mixed: } |
84308 | 6137 instead of giving the category of the entry. The sparse tags tree of |
6138 @kbd{C-c a U} will now turn out ultra-compact, because neither the | |
6139 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
|
6140 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
|
6141 to only a single file. |
84308 | 6142 |
6143 For command sets creating a block agenda, | |
6144 @code{org-agenda-custom-commands} has two separate spots for setting | |
6145 options. You can add options that should be valid for just a single | |
6146 command in the set, and options that should be valid for all commands in | |
6147 the set. The former are just added to the command entry, the latter | |
6148 must come after the list of command entries. Going back to the block | |
6149 agenda example (@pxref{Block agenda}), let's change the sorting strategy | |
6150 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort | |
6151 the results for GARDEN tags query in the opposite order, | |
6152 @code{priority-up}. This would look like this: | |
6153 | |
6154 @lisp | |
6155 @group | |
6156 (setq org-agenda-custom-commands | |
6157 '(("h" "Agenda and Home-related tasks" | |
6158 ((agenda) | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6159 (tags-todo "home") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6160 (tags "garden" |
84308 | 6161 ((org-agenda-sorting-strategy '(priority-up))))) |
6162 ((org-agenda-sorting-strategy '(priority-down)))) | |
6163 ("o" "Agenda and Office-related tasks" | |
6164 ((agenda) | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6165 (tags-todo "work") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6166 (tags "office"))))) |
84308 | 6167 @end group |
6168 @end lisp | |
6169 | |
6170 As you see, the values and parenthesis setting is a little complex. | |
6171 When in doubt, use the customize interface to set this variable - it | |
6172 fully supports its structure. Just one caveat: When setting options in | |
6173 this interface, the @emph{values} are just lisp expressions. So if the | |
6174 value is a string, you need to add the double quotes around the value | |
6175 yourself. | |
6176 | |
6177 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6178 @node Exporting Agenda Views, Using the agenda elsewhere, Setting Options, Custom agenda views |
84308 | 6179 @subsection Exporting Agenda Views |
6180 @cindex agenda views, exporting | |
6181 | |
6182 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
|
6183 printed version of some agenda views to carry around. Org mode can |
84308 | 6184 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
|
6185 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
|
6186 files. If you want to do this only occasionally, use the command |
84308 | 6187 |
6188 @table @kbd | |
6189 @kindex C-x C-w | |
6190 @item C-x C-w | |
6191 @cindex exporting agenda views | |
6192 @cindex agenda views, exporting | |
6193 Write the agenda view to a file. Depending on the extension of the | |
6194 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
|
6195 @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
|
6196 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
|
6197 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
|
6198 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
|
6199 export, for example |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6200 |
84308 | 6201 @lisp |
6202 (setq org-agenda-exporter-settings | |
6203 '((ps-number-of-columns 2) | |
6204 (ps-landscape-mode t) | |
6205 (htmlize-output-type 'css))) | |
6206 @end lisp | |
6207 @end table | |
6208 | |
6209 If you need to export certain agenda views frequently, you can associate | |
6210 any custom agenda command with a list of output file names | |
6211 @footnote{If you want to store standard views like the weekly agenda | |
6212 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
|
6213 them in order to be able to specify file names.}. Here is an example |
84308 | 6214 that first does define custom commands for the agenda and the global |
6215 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
|
6216 Then we define two block agenda commands and specify file names for them |
84308 | 6217 as well. File names can be relative to the current working directory, |
6218 or absolute. | |
6219 | |
6220 @lisp | |
6221 @group | |
6222 (setq org-agenda-custom-commands | |
6223 '(("X" agenda "" nil ("agenda.html" "agenda.ps")) | |
6224 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps")) | |
6225 ("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
|
6226 ((agenda "") |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6227 (tags-todo "home") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6228 (tags "garden")) |
84308 | 6229 nil |
6230 ("~/views/home.html")) | |
6231 ("o" "Agenda and Office-related tasks" | |
6232 ((agenda) | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6233 (tags-todo "work") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6234 (tags "office")) |
84308 | 6235 nil |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6236 ("~/views/office.ps" "~/calendars/office.ics")))) |
84308 | 6237 @end group |
6238 @end lisp | |
6239 | |
6240 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
|
6241 @file{.html}, Org mode will use the @file{htmlize.el} package to convert |
84308 | 6242 the buffer to HTML and save it to this file name. If the extension is |
6243 @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
|
6244 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
|
6245 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
|
6246 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
|
6247 extension produces a plain ASCII file. |
84308 | 6248 |
6249 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
|
6250 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
|
6251 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
|
6252 files in one step: |
84308 | 6253 |
6254 @table @kbd | |
6255 @kindex C-c a e | |
6256 @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
|
6257 Export all agenda views that have export file names associated with |
84308 | 6258 them. |
6259 @end table | |
6260 | |
6261 You can use the options section of the custom agenda commands to also | |
6262 set options for the export commands. For example: | |
6263 | |
6264 @lisp | |
6265 (setq org-agenda-custom-commands | |
6266 '(("X" agenda "" | |
6267 ((ps-number-of-columns 2) | |
6268 (ps-landscape-mode t) | |
6269 (org-agenda-prefix-format " [ ] ") | |
6270 (org-agenda-with-colors nil) | |
6271 (org-agenda-remove-tags t)) | |
6272 ("theagenda.ps")))) | |
6273 @end lisp | |
6274 | |
6275 @noindent | |
6276 This command sets two options for the postscript exporter, to make it | |
6277 print in two columns in landscape format - the resulting page can be cut | |
6278 in two and then used in a paper agenda. The remaining settings modify | |
6279 the agenda prefix to omit category and scheduling information, and | |
6280 instead include a checkbox to check off items. We also remove the tags | |
6281 to make the lines compact, and we don't want to use colors for the | |
6282 black-and-white printer. Settings specified in | |
6283 @code{org-agenda-exporter-settings} will also apply, but the settings | |
6284 in @code{org-agenda-custom-commands} take precedence. | |
6285 | |
6286 @noindent | |
6287 From the command line you may also use | |
6288 @example | |
6289 emacs -f org-batch-store-agenda-views -kill | |
6290 @end example | |
6291 @noindent | |
6292 or, if you need to modify some parameters | |
6293 @example | |
6294 emacs -eval '(org-batch-store-agenda-views \ | |
6295 org-agenda-ndays 30 \ | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
6296 org-agenda-start-day "2007-11-01" \ |
84308 | 6297 org-agenda-include-diary nil \ |
6298 org-agenda-files (quote ("~/org/project.org")))' \ | |
6299 -kill | |
6300 @end example | |
6301 @noindent | |
6302 which will create the agenda views restricted to the file | |
6303 @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
|
6304 extent. |
84308 | 6305 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6306 @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
|
6307 @subsection Using agenda information outside of Org |
84308 | 6308 @cindex agenda, pipe |
6309 @cindex Scripts, for agenda processing | |
6310 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6311 Org provides commands to access agenda information for the command |
84308 | 6312 line in emacs batch mode. This extracted information can be sent |
6313 directly to a printer, or it can be read by a program that does further | |
6314 processing of the data. The first of these commands is the function | |
6315 @code{org-batch-agenda}, that produces an agenda view and sends it as | |
6316 ASCII text to STDOUT. The command takes a single string as parameter. | |
6317 If the string has length 1, it is used as a key to one of the commands | |
6318 you have configured in @code{org-agenda-custom-commands}, basically any | |
6319 key you can use after @kbd{C-c a}. For example, to directly print the | |
6320 current TODO list, you could use | |
6321 | |
6322 @example | |
6323 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr | |
6324 @end example | |
6325 | |
6326 If the parameter is a string with 2 or more characters, it is used as a | |
6327 tags/todo match string. For example, to print your local shopping list | |
6328 (all items with the tag @samp{shop}, but excluding the tag | |
6329 @samp{NewYork}), you could use | |
6330 | |
6331 @example | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
6332 emacs -batch -l ~/.emacs \ |
84308 | 6333 -eval '(org-batch-agenda "+shop-NewYork")' | lpr |
6334 @end example | |
6335 | |
6336 @noindent | |
6337 You may also modify parameters on the fly like this: | |
6338 | |
6339 @example | |
6340 emacs -batch -l ~/.emacs \ | |
6341 -eval '(org-batch-agenda "a" \ | |
6342 org-agenda-ndays 30 \ | |
6343 org-agenda-include-diary nil \ | |
6344 org-agenda-files (quote ("~/org/project.org")))' \ | |
6345 | lpr | |
6346 @end example | |
6347 | |
6348 @noindent | |
6349 which will produce a 30 day agenda, fully restricted to the Org file | |
6350 @file{~/org/projects.org}, not even including the diary. | |
6351 | |
6352 If you want to process the agenda data in more sophisticated ways, you | |
6353 can use the command @code{org-batch-agenda-csv} to get a comma-separated | |
6354 list of values for each agenda item. Each line in the output will | |
6355 contain a number of fields separated by commas. The fields in a line | |
6356 are: | |
6357 | |
6358 @example | |
6359 category @r{The category of the item} | |
6360 head @r{The headline, without TODO kwd, TAGS and PRIORITY} | |
6361 type @r{The type of the agenda entry, can be} | |
6362 todo @r{selected in TODO match} | |
6363 tagsmatch @r{selected in tags match} | |
6364 diary @r{imported from diary} | |
6365 deadline @r{a deadline} | |
6366 scheduled @r{scheduled} | |
6367 timestamp @r{appointment, selected by timestamp} | |
6368 closed @r{entry was closed on date} | |
6369 upcoming-deadline @r{warning about nearing deadline} | |
6370 past-scheduled @r{forwarded scheduled item} | |
6371 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
|
6372 todo @r{The TODO keyword, if any} |
84308 | 6373 tags @r{All tags including inherited ones, separated by colons} |
6374 date @r{The relevant date, like 2007-2-14} | |
6375 time @r{The time, like 15:00-16:50} | |
6376 extra @r{String with extra planning info} | |
6377 priority-l @r{The priority letter if any was given} | |
6378 priority-n @r{The computed numerical priority} | |
6379 @end example | |
6380 | |
6381 @noindent | |
6382 Time and date will only be given if a timestamp (or deadline/scheduled) | |
6383 lead to the selection of the item. | |
6384 | |
6385 A CSV list like this is very easy to use in a post processing script. | |
6386 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
|
6387 Emacs/Org and prints all the items, preceded by a checkbox: |
84308 | 6388 |
6389 @example | |
6390 @group | |
6391 #!/usr/bin/perl | |
6392 | |
6393 # define the Emacs command to run | |
6394 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'"; | |
6395 | |
6396 # run it and capture the output | |
6397 $agenda = qx@{$cmd 2>/dev/null@}; | |
6398 | |
6399 # loop over all lines | |
6400 foreach $line (split(/\n/,$agenda)) @{ | |
6401 | |
6402 # get the individual values | |
6403 ($category,$head,$type,$todo,$tags,$date,$time,$extra, | |
6404 $priority_l,$priority_n) = split(/,/,$line); | |
6405 | |
6406 # proccess and print | |
6407 print "[ ] $head\n"; | |
6408 @} | |
6409 @end group | |
6410 @end example | |
6411 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6412 @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
|
6413 @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
|
6414 @cindex column view, in agenda |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6415 @cindex agenda, column view |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6416 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6417 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
|
6418 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
|
6419 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
|
6420 collected by certain criteria. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6421 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6422 @table @kbd |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6423 @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
|
6424 @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
|
6425 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
|
6426 @end table |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6427 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6428 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
|
6429 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
|
6430 This causes the following issues: |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6431 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6432 @enumerate |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6433 @item |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6434 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
|
6435 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
|
6436 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
|
6437 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
|
6438 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
|
6439 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
|
6440 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
|
6441 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
|
6442 @item |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6443 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
|
6444 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
|
6445 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
|
6446 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
|
6447 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
|
6448 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
|
6449 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
|
6450 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
|
6451 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
|
6452 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
|
6453 some values will count double. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6454 @item |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6455 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
|
6456 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
|
6457 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
|
6458 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
|
6459 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
|
6460 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
|
6461 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
|
6462 the agenda). |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6463 @end enumerate |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6464 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6465 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6466 @node Embedded LaTeX, Exporting, Agenda Views, Top |
84308 | 6467 @chapter Embedded LaTeX |
6468 @cindex @TeX{} interpretation | |
6469 @cindex La@TeX{} interpretation | |
6470 | |
6471 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
|
6472 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
|
6473 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
|
6474 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
|
6475 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
|
6476 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
|
6477 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
|
6478 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
|
6479 because it can be readily processed into images for HTML production. |
84308 | 6480 |
6481 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
|
6482 If you observe a few conventions, Org mode knows how to find it and what |
84308 | 6483 to do with it. |
6484 | |
6485 @menu | |
6486 * 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
|
6487 * Subscripts and superscripts:: Simple syntax for raising/lowering text |
84308 | 6488 * LaTeX fragments:: Complex formulas made easy |
6489 * Processing LaTeX fragments:: Previewing LaTeX processing | |
6490 * CDLaTeX mode:: Speed up entering of formulas | |
6491 @end menu | |
6492 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6493 @node Math symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX |
84308 | 6494 @section Math symbols |
6495 @cindex math symbols | |
6496 @cindex TeX macros | |
6497 | |
6498 You can use La@TeX{} macros to insert special symbols like @samp{\alpha} | |
6499 to indicate the Greek letter, or @samp{\to} to indicate an arrow. | |
6500 Completion for these macros is available, just type @samp{\} and maybe a | |
6501 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
|
6502 Unlike La@TeX{} code, Org mode allows these macros to be present |
84308 | 6503 without surrounding math delimiters, for example: |
6504 | |
6505 @example | |
6506 Angles are written as Greek letters \alpha, \beta and \gamma. | |
6507 @end example | |
6508 | |
6509 During HTML export (@pxref{HTML export}), these symbols are translated | |
6510 into the proper syntax for HTML, for the above examples this is | |
6511 @samp{α} and @samp{→}, respectively. | |
6512 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6513 @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
|
6514 @section Subscripts and superscripts |
84308 | 6515 @cindex subscript |
6516 @cindex superscript | |
6517 | |
6518 Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super- | |
6519 and subscripts. Again, these can be used without embedding them in | |
6520 math-mode delimiters. To increase the readability of ASCII text, it is | |
6521 not necessary (but OK) to surround multi-character sub- and superscripts | |
6522 with curly braces. For example | |
6523 | |
6524 @example | |
6525 The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of | |
6526 the sun is R_@{sun@} = 6.96 x 10^8 m. | |
6527 @end example | |
6528 | |
6529 To avoid interpretation as raised or lowered text, you can quote | |
6530 @samp{^} and @samp{_} with a backslash: @samp{\_} and @samp{\^}. | |
6531 | |
6532 During HTML export (@pxref{HTML export}), subscript and superscripts | |
6533 are surrounded with @code{<sub>} and @code{<sup>} tags, respectively. | |
6534 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6535 @node LaTeX fragments, Processing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX |
84308 | 6536 @section LaTeX fragments |
6537 @cindex LaTeX fragments | |
6538 | |
6539 With symbols, sub- and superscripts, HTML is pretty much at its end when | |
6540 it comes to representing mathematical formulas@footnote{Yes, there is | |
6541 MathML, but that is not yet fully supported by many browsers, and there | |
6542 is no decent converter for turning La@TeX{} or ASCII representations of | |
6543 formulas into MathML. So for the time being, converting formulas into | |
6544 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
|
6545 formula processor. To this end, Org mode can contain arbitrary La@TeX{} |
84308 | 6546 fragments. It provides commands to preview the typeset result of these |
6547 fragments, and upon export to HTML, all fragments will be converted to | |
6548 images and inlined into the HTML document@footnote{The La@TeX{} export | |
6549 will not use images for displaying La@TeX{} fragments but include these | |
6550 fragments directly into the La@TeX{} code.}. For this to work you | |
6551 need to be on a system with a working La@TeX{} installation. You also | |
6552 need the @file{dvipng} program, available at | |
6553 @url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that | |
6554 will be used when processing a fragment can be configured with the | |
6555 variable @code{org-format-latex-header}. | |
6556 | |
6557 La@TeX{} fragments don't need any special marking at all. The following | |
6558 snippets will be identified as La@TeX{} source code: | |
6559 @itemize @bullet | |
6560 @item | |
6561 Environments of any kind. The only requirement is that the | |
6562 @code{\begin} statement appears on a new line, preceded by only | |
6563 whitespace. | |
6564 @item | |
6565 Text within the usual La@TeX{} math delimiters. To avoid conflicts with | |
6566 currency specifications, single @samp{$} characters are only recognized | |
6567 as math delimiters if the enclosed text contains at most two line breaks, | |
6568 is directly attached to the @samp{$} characters with no whitespace in | |
6569 between, and if the closing @samp{$} is followed by whitespace or | |
6570 punctuation. For the other delimiters, there is no such restriction, so | |
6571 when in doubt, use @samp{\(...\)} as inline math delimiters. | |
6572 @end itemize | |
6573 | |
6574 @noindent For example: | |
6575 | |
6576 @example | |
6577 \begin@{equation@} % arbitrary environments, | |
6578 x=\sqrt@{b@} % even tables, figures | |
6579 \end@{equation@} % etc | |
6580 | |
6581 If $a^2=b$ and \( b=2 \), then the solution must be | |
6582 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \]. | |
6583 @end example | |
6584 | |
6585 @noindent | |
6586 If you need any of the delimiter ASCII sequences for other purposes, you | |
6587 can configure the option @code{org-format-latex-options} to deselect the | |
6588 ones you do not wish to have interpreted by the La@TeX{} converter. | |
6589 | |
6590 @node Processing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX | |
6591 @section Processing LaTeX fragments | |
6592 @cindex LaTeX fragments, preview | |
6593 | |
6594 La@TeX{} fragments can be processed to produce a preview images of the | |
6595 typeset expressions: | |
6596 | |
6597 @table @kbd | |
6598 @kindex C-c C-x C-l | |
6599 @item C-c C-x C-l | |
6600 Produce a preview image of the La@TeX{} fragment at point and overlay it | |
6601 over the source code. If there is no fragment at point, process all | |
6602 fragments in the current entry (between two headlines). When called | |
6603 with a prefix argument, process the entire subtree. When called with | |
6604 two prefix arguments, or when the cursor is before the first headline, | |
6605 process the entire buffer. | |
6606 @kindex C-c C-c | |
6607 @item C-c C-c | |
6608 Remove the overlay preview images. | |
6609 @end table | |
6610 | |
6611 During HTML export (@pxref{HTML export}), all La@TeX{} fragments are | |
6612 converted into images and inlined into the document if the following | |
6613 setting is active: | |
6614 | |
6615 @lisp | |
6616 (setq org-export-with-LaTeX-fragments t) | |
6617 @end lisp | |
6618 | |
6619 @node CDLaTeX mode, , Processing LaTeX fragments, Embedded LaTeX | |
6620 @section Using CDLaTeX to enter math | |
6621 @cindex CDLaTeX | |
6622 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6623 CDLaTeX mode is a minor mode that is normally used in combination with a |
84308 | 6624 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
|
6625 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
|
6626 some of the features of CDLaTeX mode. You need to install |
84308 | 6627 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with |
6628 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
|
6629 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
|
6630 version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it |
84308 | 6631 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
|
6632 Org files with |
84308 | 6633 |
6634 @lisp | |
6635 (add-hook 'org-mode-hook 'turn-on-org-cdlatex) | |
6636 @end lisp | |
6637 | |
6638 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
|
6639 details see the documentation of CDLaTeX mode): |
84308 | 6640 @itemize @bullet |
6641 @kindex C-c @{ | |
6642 @item | |
6643 Environment templates can be inserted with @kbd{C-c @{}. | |
6644 @item | |
6645 @kindex @key{TAB} | |
6646 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
|
6647 La@TeX{} fragment@footnote{Org mode has a method to test if the cursor is |
84308 | 6648 inside such a fragment, see the documentation of the function |
6649 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will | |
6650 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor | |
6651 correctly inside the first brace. Another @key{TAB} will get you into | |
6652 the second brace. Even outside fragments, @key{TAB} will expand | |
6653 environment abbreviations at the beginning of a line. For example, if | |
6654 you write @samp{equ} at the beginning of a line and press @key{TAB}, | |
6655 this abbreviation will be expanded to an @code{equation} environment. | |
6656 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}. | |
6657 @item | |
6658 @kindex _ | |
6659 @kindex ^ | |
6660 Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these | |
6661 characters together with a pair of braces. If you use @key{TAB} to move | |
6662 out of the braces, and if the braces surround only a single character or | |
6663 macro, they are removed again (depending on the variable | |
6664 @code{cdlatex-simplify-sub-super-scripts}). | |
6665 @item | |
6666 @kindex ` | |
6667 Pressing the backquote @kbd{`} followed by a character inserts math | |
6668 macros, also outside La@TeX{} fragments. If you wait more than 1.5 seconds | |
6669 after the backquote, a help window will pop up. | |
6670 @item | |
6671 @kindex ' | |
6672 Pressing the normal quote @kbd{'} followed by another character modifies | |
6673 the symbol before point with an accent or a font. If you wait more than | |
6674 1.5 seconds after the backquote, a help window will pop up. Character | |
6675 modification will work only inside La@TeX{} fragments, outside the quote | |
6676 is normal. | |
6677 @end itemize | |
6678 | |
6679 @node Exporting, Publishing, Embedded LaTeX, Top | |
6680 @chapter Exporting | |
6681 @cindex exporting | |
6682 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
6683 Org mode documents can be exported into a variety of other formats. For |
84308 | 6684 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
|
6685 simple version of an Org file. HTML export allows you to publish a |
84308 | 6686 notes file on the web, while the XOXO format provides a solid base for |
6687 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
|
6688 you use Org mode and its structured editing functions to easily create |
84308 | 6689 La@TeX{} files. To incorporate entries with associated times like |
6690 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
|
6691 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
|
6692 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
|
6693 |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6694 @menu |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6695 * Markup rules:: Which structures are recognized? |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6696 * 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
|
6697 * 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
|
6698 * 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
|
6699 * HTML export:: Exporting to HTML |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6700 * LaTeX export:: Exporting to LaTeX |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6701 * 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
|
6702 * 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
|
6703 @end menu |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6704 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6705 @node Markup rules, Export options, Exporting, Exporting |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6706 @section Markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6707 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6708 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
|
6709 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
|
6710 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
|
6711 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
|
6712 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
|
6713 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6714 @menu |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6715 * 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
|
6716 * 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
|
6717 * 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
|
6718 * 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
|
6719 * 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
|
6720 * 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
|
6721 * 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
|
6722 * 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
|
6723 * Tables exported:: Tables are exported richly |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6724 * Footnotes:: Numbers like [1] |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6725 * 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
|
6726 * 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
|
6727 * 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
|
6728 * 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
|
6729 @end menu |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6730 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6731 @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
|
6732 @subheading Document title |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6733 @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
|
6734 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6735 @noindent |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6736 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
|
6737 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6738 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6739 #+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
|
6740 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6741 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6742 @noindent |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6743 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
|
6744 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
|
6745 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
|
6746 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
|
6747 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6748 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
|
6749 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
|
6750 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
|
6751 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6752 @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
|
6753 @subheading Headings and sections |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6754 @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
|
6755 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6756 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
|
6757 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
|
6758 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
|
6759 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
|
6760 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
|
6761 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
|
6762 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
|
6763 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6764 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6765 #+OPTIONS: H:4 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6766 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6767 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6768 @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
|
6769 @subheading Table of contents |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6770 @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
|
6771 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6772 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
|
6773 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
|
6774 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
|
6775 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
|
6776 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
|
6777 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
|
6778 @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
|
6779 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6780 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6781 #+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
|
6782 #+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
|
6783 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6784 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6785 @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
|
6786 @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
|
6787 @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
|
6788 @cindex #+TEXT |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6789 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6790 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
|
6791 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
|
6792 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
|
6793 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
|
6794 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6795 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
|
6796 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
|
6797 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
|
6798 @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
|
6799 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
|
6800 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6801 @noindent |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6802 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
|
6803 @code{#+TEXT} construct: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6804 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6805 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6806 #+OPTIONS: skip:t |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6807 #+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
|
6808 #+TEXT: [TABLE-OF-CONTENTS] |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6809 #+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
|
6810 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6811 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6812 @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
|
6813 @subheading Lists |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6814 @cindex lists, markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6815 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6816 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
|
6817 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
|
6818 description lists. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6819 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6820 @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
|
6821 @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
|
6822 @cindex paragraphs, markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6823 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6824 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
|
6825 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
|
6826 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6827 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
|
6828 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
|
6829 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6830 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6831 #+BEGIN_VERSE |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6832 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
|
6833 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
|
6834 #+END_VERSE |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6835 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6836 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6837 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
|
6838 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
|
6839 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
|
6840 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6841 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6842 #+BEGIN_QUOTE |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6843 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
|
6844 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
|
6845 #+END_QUOTE |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6846 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6847 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6848 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6849 @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
|
6850 @subheading Literal examples |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6851 @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
|
6852 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6853 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
|
6854 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
|
6855 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
|
6856 @cindex #+BEGIN_EXAMPLE |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6857 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6858 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6859 #+BEGIN_EXAMPLE |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6860 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
|
6861 #+END_EXAMPLE |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6862 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6863 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6864 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
|
6865 lines with a colon: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6866 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6867 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6868 : 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
|
6869 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6870 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6871 @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
|
6872 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
|
6873 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
|
6874 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
|
6875 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
|
6876 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
|
6877 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
|
6878 example: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6879 @cindex #+BEGIN_SRC |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6880 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6881 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6882 #+BEGIN_SRC emacs-lisp |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6883 (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
|
6884 "Exclusive or." |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6885 (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
|
6886 #+END_SRC |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6887 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6888 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6889 @table @kbd |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6890 @kindex C-c ' |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6891 @item C-c ' |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6892 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
|
6893 switching to an indirect buffer, narrowing the buffer and switching to the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6894 other mode. You need to exit by pressing @kbd{C-c '} again. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6895 @end table |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6896 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6897 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6898 @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
|
6899 @subheading Include files |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6900 @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
|
6901 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6902 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
|
6903 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
|
6904 @cindex #+INCLUDE |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6905 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6906 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6907 #+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
|
6908 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6909 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6910 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
|
6911 @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
|
6912 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
|
6913 given, the text will be assumed to be in Org mode format and will be |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6914 processed normally. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6915 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6916 @table @kbd |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6917 @kindex C-c ' |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6918 @item C-c ' |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6919 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
|
6920 @end table |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6921 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6922 @node Tables exported, Footnotes, Include files, Markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6923 @subheading Tables |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6924 @cindex tables, markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6925 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6926 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
|
6927 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
|
6928 the lines before the first horizontal separator line will become table header |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6929 lines. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6930 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6931 @node Footnotes, Emphasis and monospace, Tables exported, Markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6932 @subheading Footnotes |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6933 @cindex footnotes, markup rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6934 @cindex @file{footnote.el} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6935 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6936 @kindex C-c ! |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6937 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
|
6938 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
|
6939 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
|
6940 @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
|
6941 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
|
6942 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
|
6943 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
|
6944 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
|
6945 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
|
6946 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6947 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6948 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
|
6949 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6950 [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
|
6951 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6952 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6953 @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
|
6954 @subheading Emphasis and monospace |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6955 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6956 @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
|
6957 @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
|
6958 @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
|
6959 @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
|
6960 @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
|
6961 @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
|
6962 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
|
6963 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
|
6964 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
|
6965 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
|
6966 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6967 @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
|
6968 @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
|
6969 @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
|
6970 @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
|
6971 @cindex HTML entities |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6972 @cindex LaTeX entities |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6973 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6974 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
|
6975 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
|
6976 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
|
6977 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
|
6978 @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
|
6979 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
|
6980 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
|
6981 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
|
6982 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
|
6983 (@pxref{Completion}). |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6984 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6985 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
|
6986 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
|
6987 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6988 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
|
6989 @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
|
6990 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
|
6991 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6992 @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
|
6993 @subheading Horizontal rules |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6994 @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
|
6995 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
|
6996 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
|
6997 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
6998 @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
|
6999 @subheading Comment lines |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7000 @cindex comment lines |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7001 @cindex exporting, not |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7002 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7003 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
|
7004 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
|
7005 @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
|
7006 @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
|
7007 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7008 @table @kbd |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7009 @kindex C-c ; |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7010 @item C-c ; |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7011 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
|
7012 @end table |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7013 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7014 @node Export options, The export dispatcher, Markup rules, Exporting |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7015 @section Export options |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7016 @cindex options, for export |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7017 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7018 @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
|
7019 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
|
7020 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
|
7021 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
|
7022 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
|
7023 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
|
7024 (@pxref{Completion}). |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7025 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7026 @table @kbd |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7027 @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
|
7028 @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
|
7029 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
|
7030 @end table |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7031 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7032 @cindex #+TITLE: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7033 @cindex #+AUTHOR: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7034 @cindex #+DATE: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7035 @cindex #+EMAIL: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7036 @cindex #+LANGUAGE: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7037 @cindex #+TEXT: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7038 @cindex #+OPTIONS: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7039 @cindex #+LINK_UP: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7040 @cindex #+LINK_HOME: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7041 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7042 #+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
|
7043 #+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
|
7044 #+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
|
7045 #+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
|
7046 #+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
|
7047 #+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
|
7048 #+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
|
7049 #+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
|
7050 #+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
|
7051 #+LINK_HOME: the ``home'' 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
|
7052 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7053 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7054 @noindent |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7055 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
|
7056 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
|
7057 you can: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7058 @cindex headline levels |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7059 @cindex section-numbers |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7060 @cindex table of contents |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7061 @cindex line-break preservation |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7062 @cindex quoted HTML tags |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7063 @cindex fixed-width sections |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7064 @cindex tables |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7065 @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
|
7066 @cindex footnotes |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7067 @cindex special strings |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7068 @cindex emphasized text |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7069 @cindex @TeX{} macros |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7070 @cindex La@TeX{} fragments |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7071 @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
|
7072 @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
|
7073 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7074 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
|
7075 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
|
7076 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
|
7077 \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
|
7078 @@: @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
|
7079 :: @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
|
7080 |: @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
|
7081 ^: @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
|
7082 @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
|
7083 @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
|
7084 -: @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
|
7085 f: @r{turn on/off footnotes like this[1].} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7086 *: @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
|
7087 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
|
7088 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
|
7089 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
|
7090 author: @r{turn on/off inclusion of author name/email into exported file} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7091 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
|
7092 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
|
7093 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7094 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7095 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
|
7096 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
|
7097 @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
|
7098 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7099 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
|
7100 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
|
7101 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
|
7102 @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
|
7103 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7104 @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
|
7105 @section The export dispatcher |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7106 @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
|
7107 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7108 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
|
7109 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
|
7110 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
|
7111 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
|
7112 the subtrees are exported. |
84308 | 7113 |
7114 @table @kbd | |
7115 @kindex C-c C-e | |
7116 @item C-c C-e | |
7117 Dispatcher for export and publishing commands. Displays a help-window | |
7118 listing the additional key(s) needed to launch an export or publishing | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7119 command. The prefix arg is passed through to the exporter. If the option |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7120 @code{org-export-run-in-background} is set, Org will run the command in the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7121 background if that seems useful for the specific command (i.e. commands that |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7122 write to a file). |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7123 @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
|
7124 @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
|
7125 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
|
7126 (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
|
7127 @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
|
7128 @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
|
7129 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
|
7130 @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
|
7131 not set, or force processing in the current Emacs process if st. |
84308 | 7132 @end table |
7133 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7134 @node ASCII export, HTML export, The export dispatcher, Exporting |
84308 | 7135 @section ASCII export |
7136 @cindex ASCII export | |
7137 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7138 ASCII export produces a simple and very readable version of an Org mode |
84308 | 7139 file. |
7140 | |
7141 @cindex region, active | |
7142 @cindex active region | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7143 @cindex Transient mark mode |
84308 | 7144 @table @kbd |
7145 @kindex C-c C-e a | |
7146 @item C-c C-e a | |
7147 Export as ASCII file. For an org file @file{myfile.org}, the ASCII file | |
7148 will be @file{myfile.txt}. The file will be overwritten without | |
7149 warning. If there is an active region, 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
|
7150 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
|
7151 current subtree, use @kbd{C-c @@}.}, the tree head will |
84308 | 7152 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
|
7153 @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
|
7154 export. |
84308 | 7155 @kindex C-c C-e v a |
7156 @item C-c C-e v a | |
7157 Export only the visible part of the document. | |
7158 @end table | |
7159 | |
7160 @cindex headline levels, for exporting | |
7161 In the exported version, the first 3 outline levels will become | |
7162 headlines, defining a general document structure. Additional levels | |
7163 will be exported as itemized lists. If you want that transition to occur | |
7164 at a different level, specify it with a prefix argument. For example, | |
7165 | |
7166 @example | |
7167 @kbd{C-1 C-c C-e a} | |
7168 @end example | |
7169 | |
7170 @noindent | |
7171 creates only top level headlines and does the rest as items. When | |
7172 headlines are converted to items, the indentation of the text following | |
7173 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
|
7174 the assumption that the first body line indicates the base indentation of |
84308 | 7175 the body text. Any indentation larger than this is adjusted to preserve |
7176 the layout relative to the first line. Should there be lines with less | |
7177 indentation than the first, these are left alone. | |
7178 | |
7179 @node HTML export, LaTeX export, ASCII export, Exporting | |
7180 @section HTML export | |
7181 @cindex HTML export | |
7182 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7183 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive |
84308 | 7184 HTML formatting, in ways similar to John Grubers @emph{markdown} |
7185 language, but with additional support for tables. | |
7186 | |
7187 @menu | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7188 * 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
|
7189 * Quoting HTML tags:: Using direct HTML in Org mode |
84308 | 7190 * Links:: Transformation of links for HTML |
7191 * Images:: How to include images | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7192 * 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
|
7193 * Javascript support:: Info and Folding in a web browser |
84308 | 7194 @end menu |
7195 | |
7196 @node HTML Export commands, Quoting HTML tags, HTML export, HTML export | |
7197 @subsection HTML export commands | |
7198 | |
7199 @cindex region, active | |
7200 @cindex active region | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7201 @cindex Transient mark mode |
84308 | 7202 @table @kbd |
7203 @kindex C-c C-e h | |
7204 @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
|
7205 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
|
7206 the ASCII file will be @file{myfile.html}. The file will be overwritten |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7207 without warning. If there is an active region, only the region will be |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7208 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
|
7209 current subtree, use @kbd{C-c @@}.}, the tree head will become the document |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7210 title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7211 property, that name will be used for the export. |
84308 | 7212 @kindex C-c C-e b |
7213 @item C-c C-e b | |
7214 Export as HTML file and immediately open it with a browser. | |
7215 @kindex C-c C-e H | |
7216 @item C-c C-e H | |
7217 Export to a temporary buffer, do not create a file. | |
7218 @kindex C-c C-e R | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7219 @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
|
7220 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
|
7221 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
|
7222 the region. This is good for cut-and-paste operations. |
84308 | 7223 @kindex C-c C-e v h |
7224 @kindex C-c C-e v b | |
7225 @kindex C-c C-e v H | |
7226 @kindex C-c C-e v R | |
7227 @item C-c C-e v h | |
7228 @item C-c C-e v b | |
7229 @item C-c C-e v H | |
7230 @item C-c C-e v R | |
7231 Export only the visible part of the document. | |
7232 @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
|
7233 Convert the region to HTML under the assumption that it was Org mode |
84308 | 7234 syntax before. This is a global command that can be invoked in any |
7235 buffer. | |
7236 @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
|
7237 Replace the active region (assumed to be in Org mode syntax) by HTML |
84308 | 7238 code. |
7239 @end table | |
7240 | |
7241 @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
|
7242 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
|
7243 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
|
7244 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
|
7245 specify it with a numeric prefix argument. For example, |
84308 | 7246 |
7247 @example | |
7248 @kbd{C-2 C-c C-e b} | |
7249 @end example | |
7250 | |
7251 @noindent | |
7252 creates two levels of headings and does the rest as items. | |
7253 | |
7254 @node Quoting HTML tags, Links, HTML Export commands, HTML export | |
7255 @subsection Quoting HTML tags | |
7256 | |
7257 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and | |
7258 @samp{>} in HTML export. If you want to include simple HTML tags | |
7259 which should be interpreted as such, mark them with @samp{@@} as in | |
7260 @samp{@@<b>bold text@@</b>}. Note that this really works only for | |
7261 simple tags. For more extensive HTML that should be copied verbatim to | |
7262 the exported file use either | |
7263 | |
7264 @example | |
7265 #+HTML: Literal HTML code for export | |
7266 @end example | |
7267 | |
7268 @noindent or | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7269 @cindex #+BEGIN_HTML |
84308 | 7270 |
7271 @example | |
7272 #+BEGIN_HTML | |
7273 All lines between these markers are exported literally | |
7274 #+END_HTML | |
7275 @end example | |
7276 | |
7277 | |
7278 @node Links, Images, Quoting HTML tags, HTML export | |
7279 @subsection Links | |
7280 | |
7281 @cindex links, in HTML export | |
7282 @cindex internal links, in HTML export | |
7283 @cindex external links, in HTML export | |
7284 Internal links (@pxref{Internal links}) will continue to work in HTML | |
7285 files only if they match a dedicated @samp{<<target>>}. Automatic links | |
7286 created by radio targets (@pxref{Radio targets}) will also work in the | |
7287 HTML file. Links to external files will still work if the HTML file is | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7288 in the same directory as the Org file. Links to other @file{.org} |
84308 | 7289 files will be translated into HTML links under the assumption that an |
7290 HTML version also exists of the linked file. For information related to | |
7291 linking files while publishing them to a publishing directory see | |
7292 @ref{Publishing links}. | |
7293 | |
7294 @node Images, CSS support, Links, HTML export | |
7295 @subsection Images | |
7296 | |
7297 @cindex images, inline in HTML | |
7298 @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
|
7299 HTML export can inline images given as links in the Org file, and |
84308 | 7300 it can make an image the clickable part of a link. By |
7301 default@footnote{but see the variable | |
7302 @code{org-export-html-inline-images}}, images are inlined if a link does | |
7303 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined, | |
7304 while @samp{[[file:myimg.jpg][the image]]} will just produce a link | |
7305 @samp{the image} that points to the image. If the description part | |
7306 itself is a @code{file:} link or a @code{http:} URL pointing to an | |
7307 image, this image will be inlined and activated so that clicking on the | |
7308 image will activate the link. For example, to include a thumbnail that | |
7309 will link to a high resolution version of the image, you could use: | |
7310 | |
7311 @example | |
7312 [[file:highres.jpg][file:thumb.jpg]] | |
7313 @end example | |
7314 | |
7315 @noindent | |
7316 and you could use @code{http} addresses just as well. | |
7317 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7318 @node CSS support, Javascript support, Images, HTML export |
84308 | 7319 @subsection CSS support |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7320 @cindex CSS, for HTML export |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7321 @cindex HTML export, CSS |
84308 | 7322 |
7323 You can also give style information for the exported file. The HTML | |
7324 exporter assigns the following CSS classes to appropriate parts of the | |
7325 document - your style specifications may change these: | |
7326 @example | |
7327 .todo @r{TODO keywords} | |
7328 .done @r{the DONE keyword} | |
7329 .timestamp @r{time stamp} | |
7330 .timestamp-kwd @r{keyword associated with a time stamp, like SCHEDULED} | |
7331 .tag @r{tag in a headline} | |
7332 .target @r{target for links} | |
7333 @end example | |
7334 | |
7335 The default style specification can be configured through the option | |
7336 @code{org-export-html-style}. If you want to use a file-local style, | |
7337 you may use file variables, best wrapped into a COMMENT section at the | |
7338 end of the outline tree. For example@footnote{Under Emacs 21, the | |
7339 continuation lines for a variable value should have no @samp{#} at the | |
7340 start of the line.}: | |
7341 | |
7342 @example | |
7343 * COMMENT html style specifications | |
7344 | |
7345 # Local Variables: | |
7346 # org-export-html-style: " <style type=\"text/css\"> | |
7347 # p @{font-weight: normal; color: gray; @} | |
7348 # h1 @{color: black; @} | |
7349 # </style>" | |
7350 # End: | |
7351 @end example | |
7352 | |
7353 Remember to execute @kbd{M-x normal-mode} after changing this to make | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7354 the new style visible to Emacs. This command restarts Org mode for the |
84308 | 7355 current buffer and forces Emacs to re-evaluate the local variables |
7356 section in the buffer. | |
7357 | |
7358 @c FIXME: More about header and footer styles | |
7359 @c FIXME: Talk about links and targets. | |
7360 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7361 @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
|
7362 @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
|
7363 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7364 @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
|
7365 enhance the web viewing experience of HTML files created with Org. This |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7366 program allows to view large files in two different ways. The first one is |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7367 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
|
7368 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
|
7369 as well, press @kbd{?} for an overview of the available keys). The second |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7370 view type is a @emph{folding} view much like Org provides it inside Emacs. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7371 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
|
7372 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
|
7373 @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
|
7374 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
|
7375 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
|
7376 your own web server. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7377 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7378 To use the script, you need to make sure that the @file{org-jsinfo.el} module |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7379 gets loaded. It should be loaded by default, try @kbd{M-x customize-variable |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7380 @key{RET} org-modules @key{RET}} to convince yourself that this is indeed the |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7381 case. All it then takes to make use of the program is adding a single line |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7382 to the Org file: |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7383 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7384 @example |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7385 #+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
|
7386 @end example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7387 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7388 @noindent |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7389 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
|
7390 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
|
7391 viewing options: |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7392 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7393 @example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7394 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
|
7395 @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
|
7396 @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
|
7397 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
|
7398 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
|
7399 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
|
7400 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
|
7401 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
|
7402 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
|
7403 @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
|
7404 @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
|
7405 @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
|
7406 @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
|
7407 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
|
7408 @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
|
7409 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
|
7410 @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
|
7411 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
|
7412 @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
|
7413 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
|
7414 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
|
7415 @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
|
7416 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
|
7417 @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
|
7418 @end example |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7419 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7420 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
|
7421 @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
|
7422 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
|
7423 |
84308 | 7424 @node LaTeX export, XOXO export, HTML export, Exporting |
7425 @section LaTeX export | |
7426 @cindex LaTeX export | |
7427 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7428 Org mode contains a La@TeX{} exporter written by Bastien Guerry. |
84308 | 7429 |
7430 @menu | |
7431 * LaTeX export commands:: How to invoke LaTeX export | |
7432 * 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
|
7433 * Sectioning structure:: Changing sectioning in LaTeX output |
84308 | 7434 @end menu |
7435 | |
7436 @node LaTeX export commands, Quoting LaTeX code, LaTeX export, LaTeX export | |
7437 @subsection LaTeX export commands | |
7438 | |
7439 @table @kbd | |
7440 @kindex C-c C-e l | |
7441 @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
|
7442 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
|
7443 @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7444 be overwritten without warning. If there is an active region, only the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7445 region will be exported. If the selected region is a single tree@footnote{To |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7446 select the current subtree, use @kbd{C-c @@}.}, the tree head will become the |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7447 document title. If the tree head entry has or inherits an |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7448 @code{EXPORT_FILE_NAME} property, that name will be used for the export. |
84308 | 7449 @kindex C-c C-e L |
7450 @item C-c C-e L | |
7451 Export to a temporary buffer, do not create a file. | |
7452 @kindex C-c C-e v l | |
7453 @kindex C-c C-e v L | |
7454 @item C-c C-e v l | |
7455 @item C-c C-e v L | |
7456 Export only the visible part of the document. | |
7457 @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
|
7458 Convert the region to La@TeX{} under the assumption that it was Org mode |
84308 | 7459 syntax before. This is a global command that can be invoked in any |
7460 buffer. | |
7461 @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
|
7462 Replace the active region (assumed to be in Org mode syntax) by La@TeX{} |
84308 | 7463 code. |
7464 @end table | |
7465 | |
7466 @cindex headline levels, for exporting | |
7467 In the exported version, the first 3 outline levels will become | |
7468 headlines, defining a general document structure. Additional levels | |
7469 will be exported as description lists. The exporter can ignore them or | |
7470 convert them to a custom string depending on | |
7471 @code{org-latex-low-levels}. | |
7472 | |
7473 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
|
7474 with a numeric prefix argument. For example, |
84308 | 7475 |
7476 @example | |
7477 @kbd{C-2 C-c C-e l} | |
7478 @end example | |
7479 | |
7480 @noindent | |
7481 creates two levels of headings and does the rest as items. | |
7482 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7483 @node Quoting LaTeX code, Sectioning structure, LaTeX export commands, LaTeX export |
84308 | 7484 @subsection Quoting LaTeX code |
7485 | |
7486 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
|
7487 inserted into the La@TeX{} file. Furthermore, you can add special code |
84308 | 7488 that should only be present in La@TeX{} export with the following |
7489 constructs: | |
7490 | |
7491 @example | |
7492 #+LaTeX: Literal LaTeX code for export | |
7493 @end example | |
7494 | |
7495 @noindent or | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7496 @cindex #+BEGIN_LaTeX |
84308 | 7497 |
7498 @example | |
7499 #+BEGIN_LaTeX | |
7500 All lines between these markers are exported literally | |
7501 #+END_LaTeX | |
7502 @end example | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7503 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7504 @node Sectioning structure, , Quoting LaTeX code, LaTeX export |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7505 @subsection Sectioning structure |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7506 @cindex LaTeX class |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7507 @cindex LaTeX sectioning structure |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7508 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7509 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
|
7510 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7511 You can change this globally by setting a different value for |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7512 @code{org-export-latex-default-class} or locally by adding an option |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7513 like @code{#+LaTeX_CLASS: myclass} in your file. The class should be |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7514 listed in @code{org-export-latex-classes}, where you can also define the |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7515 sectioning structure for each class. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7516 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7517 |
84308 | 7518 @node XOXO export, iCalendar export, LaTeX export, Exporting |
7519 @section XOXO export | |
7520 @cindex XOXO export | |
7521 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7522 Org mode contains an exporter that produces XOXO-style output. |
84308 | 7523 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
|
7524 does not interpret any additional Org mode features. |
84308 | 7525 |
7526 @table @kbd | |
7527 @kindex C-c C-e x | |
7528 @item C-c C-e x | |
7529 Export as XOXO file @file{myfile.html}. | |
7530 @kindex C-c C-e v | |
7531 @item C-c C-e v x | |
7532 Export only the visible part of the document. | |
7533 @end table | |
7534 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7535 @node iCalendar export, , XOXO export, Exporting |
84308 | 7536 @section iCalendar export |
7537 @cindex iCalendar export | |
7538 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7539 Some people like to use Org mode for keeping track of projects, but |
84308 | 7540 still prefer a standard calendar application for anniversaries and |
7541 appointments. In this case it can be useful to have deadlines and | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7542 other time-stamped items in Org files show up in the calendar |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7543 application. Org mode can export calendar information in the standard |
84308 | 7544 iCalendar format. If you also want to have TODO entries included in the |
7545 export, configure the variable @code{org-icalendar-include-todo}. | |
7546 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7547 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
|
7548 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
|
7549 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
|
7550 @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
|
7551 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
|
7552 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
|
7553 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
|
7554 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
|
7555 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
|
7556 |
84308 | 7557 @table @kbd |
7558 @kindex C-c C-e i | |
7559 @item C-c C-e i | |
7560 Create iCalendar entries for the current file and store them in the same | |
7561 directory, using a file extension @file{.ics}. | |
7562 @kindex C-c C-e I | |
7563 @item C-c C-e I | |
7564 Like @kbd{C-c C-e i}, but do this for all files in | |
7565 @code{org-agenda-files}. For each of these files, a separate iCalendar | |
7566 file will be written. | |
7567 @kindex C-c C-e c | |
7568 @item C-c C-e c | |
7569 Create a single large iCalendar file from all files in | |
7570 @code{org-agenda-files} and write it to the file given by | |
7571 @code{org-combined-agenda-icalendar-file}. | |
7572 @end table | |
7573 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7574 The export will honor SUMMARY, DESCRIPTION and LOCATION properties if |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7575 the selected entries have them. If not, the summary will be derived |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7576 from the headline, and the description from the body (limited to |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7577 @code{org-icalendar-include-body} characters). |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7578 |
84308 | 7579 How this calendar is best read and updated, depends on the application |
7580 you are using. The FAQ covers this issue. | |
7581 | |
7582 @node Publishing, Miscellaneous, Exporting, Top | |
7583 @chapter Publishing | |
7584 @cindex publishing | |
7585 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7586 Org includes@footnote{@file{org-publish.el} is not distributed with |
84308 | 7587 Emacs 21, if you are still using Emacs 21, you need you need to download |
7588 this file separately.} a publishing management system that allows you to | |
7589 configure automatic HTML conversion of @emph{projects} composed of | |
7590 interlinked org files. This system is called @emph{org-publish}. You can | |
7591 also configure org-publish to automatically upload your exported HTML | |
7592 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
|
7593 a web server. Org-publish turns Org into a web-site authoring tool. |
84308 | 7594 |
7595 You can also use Org-publish to convert files into La@TeX{}, or even | |
7596 combine HTML and La@TeX{} conversion so that files are available in both | |
7597 formats on the server@footnote{Since La@TeX{} files on a server are not | |
7598 that helpful, you surely want to perform further conversion on them -- | |
7599 e.g. convert them to @code{PDF} format.}. | |
7600 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7601 Org-publish has been contributed to Org by David O'Toole. |
84308 | 7602 |
7603 @menu | |
7604 * Configuration:: Defining projects | |
7605 * Sample configuration:: Example projects | |
7606 * Triggering publication:: Publication commands | |
7607 @end menu | |
7608 | |
7609 @node Configuration, Sample configuration, Publishing, Publishing | |
7610 @section Configuration | |
7611 | |
7612 Publishing needs significant configuration to specify files, destination | |
7613 and many other properties of a project. | |
7614 | |
7615 @menu | |
7616 * Project alist:: The central configuration variable | |
7617 * Sources and destinations:: From here to there | |
7618 * Selecting files:: What files are part of the project? | |
7619 * Publishing action:: Setting the function doing the publishing | |
7620 * Publishing options:: Tweaking HTML export | |
7621 * Publishing links:: Which links keep working after publishing? | |
7622 * Project page index:: Publishing a list of project files | |
7623 @end menu | |
7624 | |
7625 @node Project alist, Sources and destinations, Configuration, Configuration | |
7626 @subsection The variable @code{org-publish-project-alist} | |
7627 @cindex org-publish-project-alist | |
7628 @cindex projects, for publishing | |
7629 | |
7630 Org-publish is configured almost entirely through setting the value of | |
7631 one variable, called @code{org-publish-project-alist}. | |
7632 Each element of the list configures one project, and may be in one of | |
7633 the two following forms: | |
7634 | |
7635 @lisp | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7636 ("project-name" :property value :property value ...) |
84308 | 7637 |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7638 @r{or} |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7639 |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7640 ("project-name" :components ("project-name" "project-name" ...)) |
84308 | 7641 |
7642 @end lisp | |
7643 | |
7644 In both cases, projects are configured by specifying property values. | |
7645 A project defines the set of files that will be published, as well as | |
7646 the publishing configuration to use when publishing those files. When | |
7647 a project takes the second form listed above, the individual members | |
7648 of the ``components'' property are taken to be components of the | |
7649 project, which group together files requiring different publishing | |
7650 options. When you publish such a ``meta-project'' all the components | |
7651 will also publish. | |
7652 | |
7653 @node Sources and destinations, Selecting files, Project alist, Configuration | |
7654 @subsection Sources and destinations for files | |
7655 @cindex directories, for publishing | |
7656 | |
7657 Most properties are optional, but some should always be set. In | |
7658 particular, org-publish needs to know where to look for source files, | |
7659 and where to put published files. | |
7660 | |
7661 @multitable @columnfractions 0.3 0.7 | |
7662 @item @code{:base-directory} | |
7663 @tab Directory containing publishing source files | |
7664 @item @code{:publishing-directory} | |
7665 @tab Directory (possibly remote) where output files will be published. | |
7666 @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
|
7667 @tab Function called before starting the publishing process, for example to |
84308 | 7668 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
|
7669 @item @code{:completion-function} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7670 @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
|
7671 change permissions of the resulting files. |
84308 | 7672 @end multitable |
7673 @noindent | |
7674 | |
7675 @node Selecting files, Publishing action, Sources and destinations, Configuration | |
7676 @subsection Selecting files | |
7677 @cindex files, selecting for publishing | |
7678 | |
7679 By default, all files with extension @file{.org} in the base directory | |
7680 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
|
7681 properties |
84308 | 7682 @multitable @columnfractions 0.25 0.75 |
7683 @item @code{:base-extension} | |
7684 @tab Extension (without the dot!) of source files. This actually is a | |
7685 regular expression. | |
7686 | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7687 @item @code{:exclude} |
84308 | 7688 @tab Regular expression to match file names that should not be |
7689 published, even though they have been selected on the basis of their | |
7690 extension. | |
7691 | |
7692 @item @code{:include} | |
7693 @tab List of files to be included regardless of @code{:base-extension} | |
7694 and @code{:exclude}. | |
7695 @end multitable | |
7696 | |
7697 @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
|
7698 @subsection Publishing action |
84308 | 7699 @cindex action, for publishing |
7700 | |
7701 Publishing means that a file is copied to the destination directory and | |
7702 possibly transformed in the process. The default transformation is to | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7703 export Org files as HTML files, and this is done by the function |
84308 | 7704 @code{org-publish-org-to-html} which calls the HTML exporter |
7705 (@pxref{HTML export}). But you also can publish your files in La@TeX{} by | |
7706 using the function @code{org-publish-org-to-latex} instead. Other files | |
7707 like images only need to be copied to the publishing destination. For | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7708 non-Org files, you need to specify the publishing function. |
84308 | 7709 |
7710 | |
7711 @multitable @columnfractions 0.3 0.7 | |
7712 @item @code{:publishing-function} | |
7713 @tab Function executing the publication of a file. This may also be a | |
7714 list of functions, which will all be called in turn. | |
7715 @end multitable | |
7716 | |
7717 The function must accept two arguments: a property list containing at | |
7718 least a @code{:publishing-directory} property, and the name of the file | |
7719 to be published. It should take the specified file, make the necessary | |
7720 transformation (if any) and place the result into the destination folder. | |
7721 You can write your own publishing function, but @code{org-publish} | |
7722 provides one for attachments (files that only need to be copied): | |
7723 @code{org-publish-attachment}. | |
7724 | |
7725 @node Publishing options, Publishing links, Publishing action, Configuration | |
7726 @subsection Options for the HTML/LaTeX exporters | |
7727 @cindex options, for publishing | |
7728 | |
7729 The property list can be used to set many export options for the HTML | |
7730 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
|
7731 variables in Org. The table below lists these properties along |
84308 | 7732 with the variable they belong to. See the documentation string for the |
7733 respective variable for details. | |
7734 | |
7735 @multitable @columnfractions 0.3 0.7 | |
7736 @item @code{:language} @tab @code{org-export-default-language} | |
7737 @item @code{:headline-levels} @tab @code{org-export-headline-levels} | |
7738 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers} | |
7739 @item @code{:table-of-contents} @tab @code{org-export-with-toc} | |
7740 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees} | |
7741 @item @code{:emphasize} @tab @code{org-export-with-emphasize} | |
7742 @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
|
7743 @item @code{:special-strings} @tab @code{org-export-with-special-strings} |
84308 | 7744 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros} |
7745 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments} | |
7746 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width} | |
7747 @item @code{:timestamps} .@tab @code{org-export-with-timestamps} | |
7748 @item @code{:tags} .@tab @code{org-export-with-tags} | |
7749 @item @code{:tables} @tab @code{org-export-with-tables} | |
7750 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line} | |
7751 @item @code{:style} @tab @code{org-export-html-style} | |
7752 @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html} | |
7753 @item @code{:inline-images} @tab @code{org-export-html-inline-images} | |
7754 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand} | |
7755 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp} | |
7756 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory} | |
7757 @item @code{:preamble} @tab @code{org-export-html-preamble} | |
7758 @item @code{:postamble} @tab @code{org-export-html-postamble} | |
7759 @item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble} | |
7760 @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble} | |
7761 @item @code{:author} @tab @code{user-full-name} | |
7762 @item @code{:email} @tab @code{user-mail-address} | |
7763 @end multitable | |
7764 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7765 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
|
7766 |
84308 | 7767 Most of the @code{org-export-with-*} variables have the same effect in |
7768 both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and | |
7769 @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the | |
7770 La@TeX{} export. | |
7771 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
7772 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
|
7773 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
|
7774 any) during publishing. Options set within a file (@pxref{Export |
84308 | 7775 options}), however, override everything. |
7776 | |
7777 @node Publishing links, Project page index, Publishing options, Configuration | |
7778 @subsection Links between published files | |
7779 @cindex links, publishing | |
7780 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7781 To create a link from one Org file to another, you would use |
84308 | 7782 something like @samp{[[file:foo.org][The foo]]} or simply |
7783 @samp{file:foo.org.} (@pxref{Hyperlinks}). Upon publishing this link | |
7784 becomes a link to @file{foo.html}. In this way, you can interlink the | |
7785 pages of your "org web" project and the links will work as expected when | |
7786 you publish them to HTML. | |
7787 | |
7788 You may also link to related files, such as images. Provided you are | |
7789 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
|
7790 @code{org-publish} to upload the related files, these links will work |
84308 | 7791 too. @ref{Complex example} for an example of this usage. |
7792 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7793 Sometime an Org file to be published may contain links that are |
84308 | 7794 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
|
7795 location. In this case, use the property |
84308 | 7796 |
7797 @multitable @columnfractions 0.4 0.6 | |
7798 @item @code{:link-validation-function} | |
7799 @tab Function to validate links | |
7800 @end multitable | |
7801 | |
7802 @noindent | |
7803 to define a function for checking link validity. This function must | |
7804 accept two arguments, the file name and a directory relative to which | |
7805 the file name is interpreted in the production environment. If this | |
7806 function returns @code{nil}, then the HTML generator will only insert a | |
7807 description into the HTML file, but no link. One option for this | |
7808 function is @code{org-publish-validate-link} which checks if the given | |
7809 file is part of any project in @code{org-publish-project-alist}. | |
7810 | |
7811 @node Project page index, , Publishing links, Configuration | |
7812 @subsection Project page index | |
7813 @cindex index, of published pages | |
7814 | |
7815 The following properties may be used to control publishing of an | |
7816 index of files or summary page for a given project. | |
7817 | |
7818 @multitable @columnfractions 0.25 0.75 | |
7819 @item @code{:auto-index} | |
7820 @tab When non-nil, publish an index during org-publish-current-project or | |
7821 org-publish-all. | |
7822 | |
7823 @item @code{:index-filename} | |
7824 @tab Filename for output of index. Defaults to @file{index.org} (which | |
7825 becomes @file{index.html}). | |
7826 | |
7827 @item @code{:index-title} | |
7828 @tab Title of index page. Defaults to name of file. | |
7829 | |
7830 @item @code{:index-function} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7831 @tab Plug-in function to use for generation of index. |
84308 | 7832 Defaults to @code{org-publish-org-index}, which generates a plain list |
7833 of links to all files in the project. | |
7834 @end multitable | |
7835 | |
7836 @node Sample configuration, Triggering publication, Configuration, Publishing | |
7837 @section Sample configuration | |
7838 | |
7839 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
|
7840 project publishing only a set of Org files. The second example is |
84308 | 7841 more complex, with a multi-component project. |
7842 | |
7843 @menu | |
7844 * Simple example:: One-component publishing | |
7845 * Complex example:: A multi-component publishing example | |
7846 @end menu | |
7847 | |
7848 @node Simple example, Complex example, Sample configuration, Sample configuration | |
7849 @subsection Example: simple publishing configuration | |
7850 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7851 This example publishes a set of Org files to the @file{public_html} |
84308 | 7852 directory on the local machine. |
7853 | |
7854 @lisp | |
7855 (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
|
7856 '(("org" |
84308 | 7857 :base-directory "~/org/" |
7858 :publishing-directory "~/public_html" | |
7859 :section-numbers nil | |
7860 :table-of-contents nil | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7861 :style "<link rel=stylesheet |
84308 | 7862 href=\"../other/mystyle.css\" |
7863 type=\"text/css\">"))) | |
7864 @end lisp | |
7865 | |
7866 @node Complex example, , Simple example, Sample configuration | |
7867 @subsection Example: complex publishing configuration | |
7868 | |
7869 This more complicated example publishes an entire website, including | |
7870 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
|
7871 style sheets. The publishing-directory is remote and private files are |
84308 | 7872 excluded. |
7873 | |
7874 To ensure that links are preserved, care should be taken to replicate | |
7875 your directory structure on the web server, and to use relative file | |
7876 paths. For example, if your org files are kept in @file{~/org} and your | |
7877 publishable images in @file{~/images}, you'd link to an image with | |
7878 @c | |
7879 @example | |
7880 file:../images/myimage.png | |
7881 @end example | |
7882 @c | |
7883 On the web server, the relative path to the image should be the | |
7884 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
|
7885 right place on the web server, and publishing images to it. |
84308 | 7886 |
7887 @lisp | |
7888 (setq org-publish-project-alist | |
7889 '(("orgfiles" | |
7890 :base-directory "~/org/" | |
7891 :base-extension "org" | |
7892 :publishing-directory "/ssh:user@@host:~/html/notebook/" | |
7893 :publishing-function org-publish-org-to-html | |
7894 :exclude "PrivatePage.org" ;; regexp | |
7895 :headline-levels 3 | |
7896 :section-numbers nil | |
7897 :table-of-contents nil | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7898 :style "<link rel=stylesheet |
84308 | 7899 href=\"../other/mystyle.css\" type=\"text/css\">" |
7900 :auto-preamble t | |
7901 :auto-postamble nil) | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
7902 |
84308 | 7903 ("images" |
7904 :base-directory "~/images/" | |
7905 :base-extension "jpg\\|gif\\|png" | |
7906 :publishing-directory "/ssh:user@@host:~/html/images/" | |
7907 :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
|
7908 |
84308 | 7909 ("other" |
7910 :base-directory "~/other/" | |
7911 :base-extension "css\\|el" | |
7912 :publishing-directory "/ssh:user@@host:~/html/other/" | |
7913 :publishing-function org-publish-attachment) | |
7914 ("website" :components ("orgfiles" "images" "other")))) | |
7915 @end lisp | |
7916 | |
7917 @node Triggering publication, , Sample configuration, Publishing | |
7918 @section Triggering publication | |
7919 | |
7920 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
|
7921 following functions: |
84308 | 7922 |
7923 @table @kbd | |
7924 @item C-c C-e C | |
7925 Prompt for a specific project and publish all files that belong to it. | |
7926 @item C-c C-e P | |
7927 Publish the project containing the current file. | |
7928 @item C-c C-e F | |
7929 Publish only the current file. | |
7930 @item C-c C-e A | |
7931 Publish all projects. | |
7932 @end table | |
7933 | |
7934 Org uses timestamps to track when a file has changed. The above | |
7935 functions normally only publish changed files. You can override this and | |
7936 force publishing of all files by giving a prefix argument. | |
7937 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
7938 @node Miscellaneous, Extensions, Publishing, Top |
84308 | 7939 @chapter Miscellaneous |
7940 | |
7941 @menu | |
7942 * 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
|
7943 * Customization:: Adapting Org to your taste |
84308 | 7944 * In-buffer settings:: Overview of the #+KEYWORDS |
7945 * The very busy C-c C-c key:: When in doubt, press C-c C-c | |
7946 * 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
|
7947 * TTY keys:: Using Org on a tty |
84308 | 7948 * Interaction:: Other Emacs packages |
7949 * Bugs:: Things which do not work perfectly | |
7950 @end menu | |
7951 | |
7952 @node Completion, Customization, Miscellaneous, Miscellaneous | |
7953 @section Completion | |
7954 @cindex completion, of @TeX{} symbols | |
7955 @cindex completion, of TODO keywords | |
7956 @cindex completion, of dictionary words | |
7957 @cindex completion, of option keywords | |
7958 @cindex completion, of tags | |
7959 @cindex completion, of property keys | |
7960 @cindex completion, of link abbreviations | |
7961 @cindex @TeX{} symbol completion | |
7962 @cindex TODO keywords completion | |
7963 @cindex dictionary word completion | |
7964 @cindex option keyword completion | |
7965 @cindex tag completion | |
7966 @cindex link abbreviations, completion of | |
7967 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
7968 Org supports in-buffer completion. This type of completion does |
84308 | 7969 not make use of the minibuffer. You simply type a few letters into |
7970 the buffer and use the key to complete text right there. | |
7971 | |
7972 @table @kbd | |
7973 @kindex M-@key{TAB} | |
7974 @item M-@key{TAB} | |
7975 Complete word at point | |
7976 @itemize @bullet | |
7977 @item | |
7978 At the beginning of a headline, complete TODO keywords. | |
7979 @item | |
7980 After @samp{\}, complete @TeX{} symbols supported by the exporter. | |
7981 @item | |
7982 After @samp{*}, complete headlines in the current buffer so that they | |
7983 can be used in search links like @samp{[[*find this headline]]}. | |
7984 @item | |
7985 After @samp{:} in a headline, complete tags. The list of tags is taken | |
7986 from the variable @code{org-tag-alist} (possibly set through the | |
7987 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created | |
7988 dynamically from all tags used in the current buffer. | |
7989 @item | |
7990 After @samp{:} and not in a headline, complete property keys. The list | |
7991 of keys is constructed dynamically from all keys used in the current | |
7992 buffer. | |
7993 @item | |
7994 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}). | |
7995 @item | |
7996 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
|
7997 @samp{OPTIONS} which set file-specific options for Org mode. When the |
84308 | 7998 option keyword is already complete, pressing @kbd{M-@key{TAB}} again |
7999 will insert example settings for this keyword. | |
8000 @item | |
8001 In the line after @samp{#+STARTUP: }, complete startup keywords, | |
8002 i.e. valid keys for this line. | |
8003 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8004 Elsewhere, complete dictionary words using Ispell. |
84308 | 8005 @end itemize |
8006 @end table | |
8007 | |
8008 @node Customization, In-buffer settings, Completion, Miscellaneous | |
8009 @section Customization | |
8010 @cindex customization | |
8011 @cindex options, for customization | |
8012 @cindex variables, for customization | |
8013 | |
8014 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
|
8015 Org. For the sake of compactness of the manual, I am not |
84308 | 8016 describing the variables here. A structured overview of customization |
8017 variables is available with @kbd{M-x org-customize}. Or select | |
8018 @code{Browse Org Group} from the @code{Org->Customization} menu. Many | |
8019 settings can also be activated on a per-file basis, by putting special | |
8020 lines into the buffer (@pxref{In-buffer settings}). | |
8021 | |
8022 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous | |
8023 @section Summary of in-buffer settings | |
8024 @cindex in-buffer settings | |
8025 @cindex special keywords | |
8026 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8027 Org mode uses special lines in the buffer to define settings on a |
84308 | 8028 per-file basis. These lines start with a @samp{#+} followed by a |
8029 keyword, a colon, and then individual words defining a setting. Several | |
8030 setting words can be in the same line, but you can also have multiple | |
8031 lines for the keyword. While these settings are described throughout | |
8032 the manual, here is a summary. After changing any of those lines in the | |
8033 buffer, press @kbd{C-c C-c} with the cursor still in the line to | |
8034 activate the changes immediately. Otherwise they become effective only | |
8035 when the file is visited again in a new Emacs session. | |
8036 | |
8037 @table @kbd | |
8038 @item #+ARCHIVE: %s_done:: | |
8039 This line sets the archive location for the agenda file. It applies for | |
8040 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end | |
8041 of the file. The first such line also applies to any entries before it. | |
8042 The corresponding variable is @code{org-archive-location}. | |
8043 @item #+CATEGORY: | |
8044 This line sets the category for the agenda file. The category applies | |
8045 for all subsequent lines until the next @samp{#+CATEGORY} line, or the | |
8046 end of the file. The first such line also applies to any entries before it. | |
8047 @item #+COLUMNS: %25ITEM ..... | |
8048 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
|
8049 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
|
8050 applies. |
84308 | 8051 @item #+CONSTANTS: name1=value1 ... |
8052 Set file-local values for constants to be used in table formulas. This | |
8053 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
|
8054 The global version of this variable is |
84308 | 8055 @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
|
8056 @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
|
8057 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
|
8058 top-level entries. |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8059 @item #+DRAWERS: NAME1 ..... |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8060 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
|
8061 @code{org-drawers}. |
84308 | 8062 @item #+LINK: linkword replace |
8063 These lines (several are allowed) specify link abbreviations. | |
8064 @xref{Link abbreviations}. The corresponding variable is | |
8065 @code{org-link-abbrev-alist}. | |
8066 @item #+PRIORITIES: highest lowest default | |
8067 This line sets the limits and the default for the priorities. All three | |
8068 must be either letters A-Z or numbers 0-9. The highest priority must | |
8069 have a lower ASCII number that the lowest priority. | |
8070 @item #+PROPERTY: Property_Name Value | |
8071 This line sets a default inheritance value for entries in the current | |
8072 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
|
8073 @item #+SETUPFILE: file |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8074 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
|
8075 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
|
8076 (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
|
8077 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
|
8078 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
|
8079 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
|
8080 cursor is in the line with @kbd{C-c '}. |
84308 | 8081 @item #+STARTUP: |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8082 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
|
8083 Org file is being visited. The first set of options deals with the |
84308 | 8084 initial visibility of the outline tree. The corresponding variable for |
8085 global default settings is @code{org-startup-folded}, with a default | |
8086 value @code{t}, which means @code{overview}. | |
8087 @cindex @code{overview}, STARTUP keyword | |
8088 @cindex @code{content}, STARTUP keyword | |
8089 @cindex @code{showall}, STARTUP keyword | |
8090 @example | |
8091 overview @r{top-level headlines only} | |
8092 content @r{all headlines} | |
8093 showall @r{no folding at all, show everything} | |
8094 @end example | |
8095 Then there are options for aligning tables upon visiting a file. This | |
8096 is useful in files containing narrowed table columns. The corresponding | |
8097 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
|
8098 @code{nil}. |
84308 | 8099 @cindex @code{align}, STARTUP keyword |
8100 @cindex @code{noalign}, STARTUP keyword | |
8101 @example | |
8102 align @r{align all tables} | |
8103 noalign @r{don't align tables on startup} | |
8104 @end example | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
8105 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
|
8106 (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
|
8107 @code{org-log-repeat}) can be configured using these options. |
84308 | 8108 @cindex @code{logdone}, STARTUP keyword |
8109 @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
|
8110 @cindex @code{nologdone}, STARTUP keyword |
84308 | 8111 @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
|
8112 @cindex @code{nolognoteclock-out}, STARTUP keyword |
84308 | 8113 @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
|
8114 @cindex @code{lognoterepeat}, STARTUP keyword |
84308 | 8115 @cindex @code{nologrepeat}, STARTUP keyword |
8116 @example | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
8117 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
|
8118 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
|
8119 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
|
8120 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
|
8121 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
|
8122 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
|
8123 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
|
8124 nolognoteclock-out @r{don't record a note when clocking out} |
84308 | 8125 @end example |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8126 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
|
8127 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
|
8128 @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
|
8129 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}). |
84308 | 8130 @cindex @code{hidestars}, STARTUP keyword |
8131 @cindex @code{showstars}, STARTUP keyword | |
8132 @cindex @code{odd}, STARTUP keyword | |
8133 @cindex @code{even}, STARTUP keyword | |
8134 @example | |
8135 hidestars @r{make all but one of the stars starting a headline invisible.} | |
8136 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
|
8137 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
|
8138 noindent @r{no virtual indentation according to outline level} |
84308 | 8139 odd @r{allow only odd outline levels (1,3,...)} |
8140 oddeven @r{allow all outline levels} | |
8141 @end example | |
8142 To turn on custom format overlays over time stamps (variables | |
8143 @code{org-put-time-stamp-overlays} and | |
8144 @code{org-time-stamp-overlay-formats}), use | |
8145 @cindex @code{customtime}, STARTUP keyword | |
8146 @example | |
8147 customtime @r{overlay custom time format} | |
8148 @end example | |
8149 The following options influence the table spreadsheet (variable | |
8150 @code{constants-unit-system}). | |
8151 @cindex @code{constcgs}, STARTUP keyword | |
8152 @cindex @code{constSI}, STARTUP keyword | |
8153 @example | |
8154 constcgs @r{@file{constants.el} should use the c-g-s unit system} | |
8155 constSI @r{@file{constants.el} should use the SI unit system} | |
8156 @end example | |
8157 @item #+TAGS: TAG1(c1) TAG2(c2) | |
92148 | 8158 These lines (several such lines are allowed) specify the valid tags in |
84308 | 8159 this file, and (potentially) the corresponding @emph{fast tag selection} |
8160 keys. The corresponding variable is @code{org-tag-alist}. | |
8161 @item #+TBLFM: | |
8162 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
|
8163 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS, #+DATE: |
84308 | 8164 These lines provide settings for exporting files. For more details see |
8165 @ref{Export options}. | |
8166 @item #+SEQ_TODO: #+TYP_TODO: | |
8167 These lines set the TODO keywords and their interpretation in the | |
8168 current file. The corresponding variables are @code{org-todo-keywords} | |
8169 and @code{org-todo-interpretation}. | |
8170 @end table | |
8171 | |
8172 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous | |
8173 @section The very busy C-c C-c key | |
8174 @kindex C-c C-c | |
8175 @cindex C-c C-c, overview | |
8176 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8177 The key @kbd{C-c C-c} has many purposes in Org, which are all |
84308 | 8178 mentioned scattered throughout this manual. One specific function of |
8179 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
|
8180 other circumstances it means something like @emph{Hey Org, look |
84308 | 8181 here and update according to what you see here}. Here is a summary of |
8182 what this means in different contexts. | |
8183 | |
8184 @itemize @minus | |
8185 @item | |
8186 If there are highlights in the buffer from the creation of a sparse | |
8187 tree, or from clock display, remove these highlights. | |
8188 @item | |
8189 If the cursor is in one of the special @code{#+KEYWORD} lines, this | |
8190 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
|
8191 information. |
84308 | 8192 @item |
8193 If the cursor is inside a table, realign the table. This command | |
8194 works even if the automatic table editor has been turned off. | |
8195 @item | |
8196 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to | |
8197 the entire table. | |
8198 @item | |
8199 If the cursor is inside a table created by the @file{table.el} package, | |
8200 activate that table. | |
8201 @item | |
8202 If the current buffer is a remember buffer, close the note and file it. | |
8203 With a prefix argument, file it, without further interaction, to the | |
8204 default location. | |
8205 @item | |
8206 If the cursor is on a @code{<<<target>>>}, update radio targets and | |
8207 corresponding links in this buffer. | |
8208 @item | |
8209 If the cursor is in a property line or at the start or end of a property | |
8210 drawer, offer property commands. | |
8211 @item | |
8212 If the cursor is in a plain list item with a checkbox, toggle the status | |
8213 of the checkbox. | |
8214 @item | |
8215 If the cursor is on a numbered item in a plain list, renumber the | |
8216 ordered list. | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8217 @item |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8218 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
|
8219 block is updated. |
84308 | 8220 @end itemize |
8221 | |
8222 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous | |
8223 @section A cleaner outline view | |
8224 @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
|
8225 @cindex dynamic indentation |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8226 @cindex odd-levels-only outlines |
84308 | 8227 @cindex clean outline view |
8228 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8229 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
|
8230 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
|
8231 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
|
8232 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
|
8233 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
|
8234 cleaner, as can be seen by comparing the two columns in the following |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8235 example: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8236 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8237 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8238 @group |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8239 * 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
|
8240 ** Second level | * Second level |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8241 *** 3rd level | * 3rd level |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8242 some text | some text |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8243 *** 3rd level | * 3rd level |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8244 more text | more text |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8245 * 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
|
8246 @end group |
84308 | 8247 @end example |
8248 | |
8249 @noindent | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8250 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
|
8251 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
|
8252 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8253 @enumerate |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8254 @item |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8255 @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
|
8256 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
|
8257 with the headline, like |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8258 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8259 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8260 *** 3rd level |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8261 more text, now indented |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8262 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8263 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8264 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
|
8265 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
|
8266 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
|
8267 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
|
8268 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
|
8269 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
|
8270 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
|
8271 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8272 @item |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8273 @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
|
8274 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
|
8275 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
|
8276 with |
84308 | 8277 |
8278 @example | |
8279 #+STARTUP: showstars | |
8280 #+STARTUP: hidestars | |
8281 @end example | |
8282 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8283 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
|
8284 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8285 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8286 @group |
84308 | 8287 * Top level headline |
8288 * Second level | |
8289 * 3rd level | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8290 ... |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8291 @end group |
84308 | 8292 @end example |
8293 | |
8294 @noindent | |
8295 Note that the leading stars are not truly replaced by whitespace, they | |
8296 are only fontified with the face @code{org-hide} that uses the | |
8297 background color as font color. If you are not using either white or | |
8298 black background, you may have to customize this face to get the wanted | |
8299 effect. Another possibility is to set this font such that the extra | |
8300 stars are @i{almost} invisible, for example using the color | |
8301 @code{grey90} on a white background. | |
8302 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8303 @item |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8304 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
|
8305 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
|
8306 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
|
8307 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
|
8308 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
|
8309 @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
|
8310 following lines: |
84308 | 8311 |
8312 @example | |
8313 #+STARTUP: odd | |
8314 #+STARTUP: oddeven | |
8315 @end example | |
8316 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8317 You can convert an Org file from single-star-per-level to the |
84308 | 8318 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels |
8319 RET} in that file. The reverse operation is @kbd{M-x | |
8320 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
|
8321 @end enumerate |
84308 | 8322 |
8323 @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
|
8324 @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
|
8325 @cindex tty key bindings |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8326 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8327 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
|
8328 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
|
8329 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
|
8330 @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
|
8331 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
|
8332 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
|
8333 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
|
8334 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
|
8335 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
|
8336 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
|
8337 tty you would rather use @kbd{C-c .} to re-insert the timestamp. |
84308 | 8338 |
8339 @multitable @columnfractions 0.15 0.2 0.2 | |
8340 @item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2} | |
8341 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab | |
8342 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{@key{Esc} @key{left}} | |
8343 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab | |
8344 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{@key{Esc} @key{right}} | |
8345 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab | |
8346 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{@key{Esc} @key{up}} | |
8347 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab | |
8348 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{@key{Esc} @key{down}} | |
8349 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab | |
8350 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab | |
8351 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{@key{Esc} @key{RET}} | |
8352 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab | |
8353 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab | |
8354 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab | |
8355 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab | |
8356 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab | |
8357 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab | |
8358 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab | |
8359 @end multitable | |
8360 | |
8361 @node Interaction, Bugs, TTY keys, Miscellaneous | |
8362 @section Interaction with other packages | |
8363 @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
|
8364 Org lives in the world of GNU Emacs and interacts in various ways |
84308 | 8365 with other code out there. |
8366 | |
8367 @menu | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8368 * Cooperation:: Packages Org cooperates with |
84308 | 8369 * Conflicts:: Packages that lead to conflicts |
8370 @end menu | |
8371 | |
8372 @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
|
8373 @subsection Packages that Org cooperates with |
84308 | 8374 |
8375 @table @asis | |
8376 @cindex @file{calc.el} | |
8377 @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
|
8378 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
|
8379 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
|
8380 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
|
8381 @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
|
8382 been installed properly. As of Emacs 22, Calc is part of the Emacs |
84308 | 8383 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
|
8384 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
|
8385 , Embedded Mode, Calc, GNU Emacs Calc Manual}. |
84308 | 8386 @cindex @file{constants.el} |
8387 @item @file{constants.el} by Carsten Dominik | |
8388 In a table formula (@pxref{The spreadsheet}), it is possible to use | |
8389 names for natural constants or units. Instead of defining your own | |
8390 constants in the variable @code{org-table-formula-constants}, install | |
8391 the @file{constants} package which defines a large number of constants | |
8392 and units, and lets you use unit prefixes like @samp{M} for | |
8393 @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
|
8394 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for |
84308 | 8395 the function @code{constants-get}, which has to be autoloaded in your |
8396 setup. See the installation instructions in the file | |
8397 @file{constants.el}. | |
8398 @item @file{cdlatex.el} by Carsten Dominik | |
8399 @cindex @file{cdlatex.el} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8400 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
|
8401 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
|
8402 @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
|
8403 @cindex @file{imenu.el} |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8404 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
|
8405 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
|
8406 @lisp |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
8407 (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
|
8408 (lambda () (imenu-add-to-menubar "Imenu"))) |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8409 @end lisp |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8410 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
|
8411 the option @code{org-imenu-depth}. |
84308 | 8412 @item @file{remember.el} by John Wiegley |
8413 @cindex @file{remember.el} | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8414 Org cooperates with remember, see @ref{Remember}. |
84308 | 8415 @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
|
8416 @item @file{speedbar.el} by Eric M. Ludlam |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8417 @cindex @file{speedbar.el} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8418 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
|
8419 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
|
8420 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
|
8421 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
|
8422 the command @kbd{<} in the Speedbar frame. |
84308 | 8423 @cindex @file{table.el} |
8424 @item @file{table.el} by Takaaki Ota | |
8425 @kindex C-c C-c | |
8426 @cindex table editor, @file{table.el} | |
8427 @cindex @file{table.el} | |
8428 | |
8429 Complex ASCII tables with automatic line wrapping, column- and | |
8430 row-spanning, and alignment can be created using the Emacs table | |
8431 package by Takaaki Ota (@uref{http://sourceforge.net/projects/table}, | |
8432 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
|
8433 When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org mode |
84308 | 8434 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
|
8435 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
|
8436 to execute Org mode-related commands, leave the table. |
84308 | 8437 |
8438 @table @kbd | |
8439 @kindex C-c C-c | |
8440 @item C-c C-c | |
8441 Recognize @file{table.el} table. Works when the cursor is in a | |
8442 table.el table. | |
8443 @c | |
8444 @kindex C-c ~ | |
8445 @item C-c ~ | |
8446 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
|
8447 command converts it between the table.el format and the Org mode |
84308 | 8448 format. See the documentation string of the command |
8449 @code{org-convert-table} for the restrictions under which this is | |
8450 possible. | |
8451 @end table | |
8452 @file{table.el} is part of Emacs 22. | |
8453 @cindex @file{footnote.el} | |
8454 @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
|
8455 Org mode recognizes numerical footnotes as provided by this package |
84308 | 8456 (@pxref{Footnotes}). |
8457 @end table | |
8458 | |
8459 @node Conflicts, , Cooperation, Interaction | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8460 @subsection Packages that lead to conflicts with Org mode |
84308 | 8461 |
8462 @table @asis | |
8463 | |
8464 @cindex @file{allout.el} | |
8465 @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
|
8466 Startup of Org may fail with the error message |
84308 | 8467 @code{(wrong-type-argument keymapp nil)} when there is an outdated |
8468 version @file{allout.el} on the load path, for example the version | |
8469 distributed with Emacs 21.x. Upgrade to Emacs 22 and this problem will | |
8470 disappear. If for some reason you cannot do this, make sure that org.el | |
8471 is loaded @emph{before} @file{allout.el}, for example by putting | |
8472 @code{(require 'org)} early enough into your @file{.emacs} file. | |
8473 | |
8474 @cindex @file{CUA.el} | |
8475 @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
|
8476 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
|
8477 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
|
8478 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
|
8479 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
|
8480 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
|
8481 in the agenda buffer (but not during date selection). |
84308 | 8482 |
8483 @example | |
8484 S-UP -> M-p S-DOWN -> M-n | |
8485 S-LEFT -> M-- S-RIGHT -> M-+ | |
8486 @end example | |
8487 | |
8488 Yes, these are unfortunately more difficult to remember. If you want | |
8489 to have other replacement keys, look at the variable | |
8490 @code{org-disputed-keys}. | |
8491 @item @file{windmove.el} by Hovav Shacham | |
8492 @cindex @file{windmove.el} | |
8493 Also this package uses the @kbd{S-<cursor>} keys, so everything written | |
8494 in the paragraph above about CUA mode also applies here. | |
8495 | |
8496 @cindex @file{footnote.el} | |
8497 @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
|
8498 Org supports the syntax of the footnote package, but only the |
84308 | 8499 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
|
8500 commands, @kbd{C-c !} is already used by Org. You could use the |
84308 | 8501 variable @code{footnote-prefix} to switch footnotes commands to another |
8502 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
|
8503 @code{org-disputed-keys} to change the settings in Org. |
84308 | 8504 |
8505 @end table | |
8506 | |
8507 | |
8508 @node Bugs, , Interaction, Miscellaneous | |
8509 @section Bugs | |
8510 @cindex bugs | |
8511 | |
8512 Here is a list of things that should work differently, but which I | |
8513 have found too hard to fix. | |
8514 | |
8515 @itemize @bullet | |
8516 @item | |
8517 If a table field starts with a link, and if the corresponding table | |
8518 column is narrowed (@pxref{Narrow columns}) to a width too small to | |
8519 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
|
8520 not. To prevent this, Org throws an error. The work-around is to |
84308 | 8521 make the column wide enough to fit the link, or to add some text (at |
8522 least 2 characters) before the link in the same field. | |
8523 @item | |
8524 Narrowing table columns does not work on XEmacs, because the | |
8525 @code{format} function does not transport text properties. | |
8526 @item | |
8527 Text in an entry protected with the @samp{QUOTE} keyword should not | |
8528 autowrap. | |
8529 @item | |
8530 When the application called by @kbd{C-c C-o} to open a file link fails | |
8531 (for example because the application does not exist or refuses to open | |
8532 the file), it does so silently. No error message is displayed. | |
8533 @item | |
8534 Recalculating a table line applies the formulas from left to right. | |
8535 If a formula uses @emph{calculated} fields further down the row, | |
8536 multiple recalculation may be needed to get all fields consistent. You | |
8537 may use the command @code{org-table-iterate} (@kbd{C-u C-c *}) to | |
8538 recalculate until convergence. | |
8539 @item | |
8540 The exporters work well, but could be made more efficient. | |
8541 @end itemize | |
8542 | |
8543 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8544 @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
|
8545 @appendix Extensions |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8546 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8547 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
|
8548 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
|
8549 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
|
8550 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8551 @menu |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8552 * 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
|
8553 * 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
|
8554 @end menu |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8555 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8556 @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
|
8557 @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
|
8558 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8559 @table @asis |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8560 @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
|
8561 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
|
8562 the annotated file. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8563 @item @file{org-annotation-helper.el} by @i{Bastien Guerry and Daniel E. German} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8564 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
|
8565 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
|
8566 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
|
8567 detailes description is in |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8568 @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
|
8569 @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
|
8570 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
|
8571 @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
|
8572 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
|
8573 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
|
8574 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
|
8575 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
|
8576 @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
|
8577 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
|
8578 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
|
8579 @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
|
8580 The @code{<lisp>} tag, adapted from Emacs Wiki and Emacs Muse, allows |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8581 to include text in a document that is the result of evaluating some |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8582 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
|
8583 this package as well. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8584 @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
|
8585 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
|
8586 @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
|
8587 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
|
8588 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
|
8589 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
|
8590 @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
|
8591 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
|
8592 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
|
8593 more tags or keywords. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8594 @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
|
8595 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
|
8596 @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
|
8597 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
|
8598 @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
|
8599 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
|
8600 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
|
8601 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
|
8602 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
|
8603 @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
|
8604 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
|
8605 @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
|
8606 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
|
8607 file or location. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8608 @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
|
8609 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
|
8610 @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
|
8611 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
|
8612 @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
|
8613 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
|
8614 and easy visibility cycling. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8615 @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
|
8616 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
|
8617 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
|
8618 @end table |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8619 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8620 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8621 @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
|
8622 @section Other extensions |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8623 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8624 @i{TO BE DONE} |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8625 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8626 @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
|
8627 @appendix Hacking |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8628 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8629 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
|
8630 Org. |
84308 | 8631 |
8632 @menu | |
8633 * Adding hyperlink types:: New custom link types | |
8634 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs | |
8635 * Dynamic blocks:: Automatically filled blocks | |
8636 * Special agenda views:: Customized views | |
8637 * 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
|
8638 * Using the mapping API:: Mapping over all or selected entries |
84308 | 8639 @end menu |
8640 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8641 @node Adding hyperlink types, Tables in arbitrary syntax, Hacking, Hacking |
84308 | 8642 @section Adding hyperlink types |
8643 @cindex hyperlinks, adding new types | |
8644 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8645 Org has a large number of hyperlink types built-in |
84308 | 8646 (@pxref{Hyperlinks}). If you would like to add new link types, it |
8647 provides an interface for doing so. Lets look at an example file | |
8648 @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
|
8649 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside |
84308 | 8650 emacs: |
8651 | |
8652 @lisp | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8653 ;;; org-man.el - Support for links to manpages in Org |
84308 | 8654 |
8655 (require 'org) | |
8656 | |
8657 (org-add-link-type "man" 'org-man-open) | |
8658 (add-hook 'org-store-link-functions 'org-man-store-link) | |
8659 | |
8660 (defcustom org-man-command 'man | |
8661 "The Emacs command to be used to display a man page." | |
8662 :group 'org-link | |
8663 :type '(choice (const man) (const woman))) | |
8664 | |
8665 (defun org-man-open (path) | |
8666 "Visit the manpage on PATH. | |
8667 PATH should be a topic that can be thrown at the man command." | |
8668 (funcall org-man-command path)) | |
8669 | |
8670 (defun org-man-store-link () | |
8671 "Store a link to a manpage." | |
8672 (when (memq major-mode '(Man-mode woman-mode)) | |
8673 ;; This is a man page, we do make this link | |
8674 (let* ((page (org-man-get-page-name)) | |
8675 (link (concat "man:" page)) | |
8676 (description (format "Manpage for %s" page))) | |
8677 (org-store-link-props | |
8678 :type "man" | |
8679 :link link | |
8680 :description description)))) | |
8681 | |
8682 (defun org-man-get-page-name () | |
8683 "Extract the page name from the buffer name." | |
8684 ;; This works for both `Man-mode' and `woman-mode'. | |
8685 (if (string-match " \\(\\S-+\\)\\*" (buffer-name)) | |
8686 (match-string 1 (buffer-name)) | |
8687 (error "Cannot create link to this man page"))) | |
8688 | |
8689 (provide 'org-man) | |
8690 | |
8691 ;;; org-man.el ends here | |
8692 @end lisp | |
8693 | |
8694 @noindent | |
8695 You would activate this new link type in @file{.emacs} with | |
8696 | |
8697 @lisp | |
8698 (require 'org-man) | |
8699 @end lisp | |
8700 | |
8701 @noindent | |
8702 Lets go through the file and see what it does. | |
8703 @enumerate | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
8704 @item |
84308 | 8705 It does @code{(require 'org)} to make sure that @file{org.el} has been |
8706 loaded. | |
8707 @item | |
8708 The next line calls @code{org-add-link-type} to define a new link type | |
8709 with prefix @samp{man}. The call also contains the name of a function | |
8710 that will be called to follow such a link. | |
8711 @item | |
8712 The next line adds a function to @code{org-store-link-functions}, in | |
8713 order to allow the command @kbd{C-c l} to record a useful link in a | |
8714 buffer displaying a man page. | |
8715 @end enumerate | |
8716 | |
8717 The rest of the file defines the necessary variables and functions. | |
8718 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
|
8719 command should be used to display man pages. There are two options, |
84308 | 8720 @code{man} and @code{woman}. Then the function to follow a link is |
8721 defined. It gets the link path as an argument - in this case the link | |
8722 path is just a topic for the manual command. The function calls the | |
8723 value of @code{org-man-command} to display the man page. | |
8724 | |
8725 Finally the function @code{org-man-store-link} is defined. When you try | |
8726 to store a link with @kbd{C-c l}, also this function will be called to | |
8727 try to make a link. The function must first decide if it is supposed to | |
8728 create the link for this buffer type, we do this by checking the value | |
8729 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
|
8730 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
|
8731 manual topic from the buffer name and prefixing it with the string |
84308 | 8732 @samp{man:}. Then it must call the command @code{org-store-link-props} |
8733 and set the @code{:type} and @code{:link} properties. Optionally you | |
8734 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
|
8735 the link description when the link is later inserted into an Org |
84308 | 8736 buffer with @kbd{C-c C-l}. |
8737 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8738 @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
|
8739 @section Tables and lists in arbitrary syntax |
84308 | 8740 @cindex tables, in other modes |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8741 @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
|
8742 @cindex Orgtbl mode |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8743 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8744 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a |
84308 | 8745 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
|
8746 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
|
8747 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
|
8748 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
|
8749 editor. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8750 |
84308 | 8751 |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8752 This appendix describes a different approach. We keep the Orgtbl mode |
84308 | 8753 table in its native format (the @i{source table}), and use a custom |
8754 function to @i{translate} the table to the correct syntax, and to | |
8755 @i{install} it in the right location (the @i{target table}). This puts | |
8756 the burden of writing conversion functions on the user, but it allows | |
8757 for a very flexible system. | |
8758 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8759 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
|
8760 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
|
8761 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
|
8762 or Texinfo.) |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8763 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8764 |
84308 | 8765 @menu |
8766 * Radio tables:: Sending and receiving | |
8767 * A LaTeX example:: Step by step, almost a tutorial | |
8768 * 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
|
8769 * Radio lists:: Doing the same for lists |
84308 | 8770 @end menu |
8771 | |
8772 @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax | |
8773 @subsection Radio tables | |
8774 @cindex radio tables | |
8775 | |
8776 To define the location of the target table, you first need to create two | |
8777 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
|
8778 Orgtbl mode to find. Orgtbl mode will insert the translated table |
84308 | 8779 between these lines, replacing whatever was there before. For example: |
8780 | |
8781 @example | |
8782 /* BEGIN RECEIVE ORGTBL table_name */ | |
8783 /* END RECEIVE ORGTBL table_name */ | |
8784 @end example | |
8785 | |
8786 @noindent | |
8787 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
|
8788 Orgtbl mode how to translate this table and where to install it. For |
84308 | 8789 example: |
8790 @example | |
8791 #+ORGTBL: SEND table_name translation_function arguments.... | |
8792 @end example | |
8793 | |
8794 @noindent | |
8795 @code{table_name} is the reference name for the table that is also used | |
8796 in the receiver lines. @code{translation_function} is the Lisp function | |
8797 that does the translation. Furthermore, the line can contain a list of | |
8798 arguments (alternating key and value) at the end. The arguments will be | |
8799 passed as a property list to the translation function for | |
8800 interpretation. A few standard parameters are already recognized and | |
8801 acted upon before the translation function is called: | |
8802 | |
8803 @table @code | |
8804 @item :skip N | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8805 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
|
8806 this parameter! |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8807 |
84308 | 8808 @item :skipcols (n1 n2 ...) |
8809 List of columns that should be skipped. If the table has a column with | |
8810 calculation marks, that column is automatically discarded as well. | |
8811 Please note that the translator function sees the table @emph{after} the | |
8812 removal of these columns, the function never knows that there have been | |
8813 additional columns. | |
8814 @end table | |
8815 | |
8816 @noindent | |
8817 The one problem remaining is how to keep the source table in the buffer | |
8818 without disturbing the normal workings of the file, for example during | |
8819 compilation of a C file or processing of a La@TeX{} file. There are a | |
8820 number of different solutions: | |
8821 | |
8822 @itemize @bullet | |
8823 @item | |
8824 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
|
8825 language. For example, in C mode you could wrap the table between |
84308 | 8826 @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
|
8827 @item |
84308 | 8828 Sometimes it is possible to put the table after some kind of @i{END} |
8829 statement, for example @samp{\bye} in TeX and @samp{\end@{document@}} | |
8830 in La@TeX{}. | |
8831 @item | |
8832 You can just comment the table line by line whenever you want to process | |
8833 the file, and uncomment it whenever you need to edit the table. This | |
8834 only sounds tedious - the command @kbd{M-x orgtbl-toggle-comment} does | |
8835 make this comment-toggling very easy, in particular if you bind it to a | |
8836 key. | |
8837 @end itemize | |
8838 | |
8839 @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
|
8840 @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
|
8841 @cindex LaTeX, and Orgtbl mode |
84308 | 8842 |
8843 The best way to wrap the source table in La@TeX{} is to use the | |
8844 @code{comment} environment provided by @file{comment.sty}. It has to be | |
8845 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
|
8846 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
|
8847 default this works only for La@TeX{}, HTML, and Texinfo. Configure the |
84308 | 8848 variable @code{orgtbl-radio-tables} to install templates for other |
8849 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will | |
8850 be prompted for a table name, lets say we use @samp{salesfigures}. You | |
8851 will then get the following template: | |
8852 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8853 @cindex #+ORGTBL: SEND |
84308 | 8854 @example |
8855 % BEGIN RECEIVE ORGTBL salesfigures | |
8856 % END RECEIVE ORGTBL salesfigures | |
8857 \begin@{comment@} | |
8858 #+ORGTBL: SEND salesfigures orgtbl-to-latex | |
8859 | | | | |
8860 \end@{comment@} | |
8861 @end example | |
8862 | |
8863 @noindent | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8864 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function |
84308 | 8865 @code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it |
8866 into the receiver location with name @code{salesfigures}. You may now | |
8867 fill in the table, feel free to use the spreadsheet features@footnote{If | |
8868 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
|
8869 this may cause problems with font-lock in LaTeX mode. As shown in the |
84308 | 8870 example you can fix this by adding an extra line inside the |
8871 @code{comment} environment that is used to balance the dollar | |
8872 expressions. If you are using AUCTeX with the font-latex library, a | |
8873 much better solution is to add the @code{comment} environment to the | |
8874 variable @code{LaTeX-verbatim-environments}.}: | |
8875 | |
8876 @example | |
8877 % BEGIN RECEIVE ORGTBL salesfigures | |
8878 % END RECEIVE ORGTBL salesfigures | |
8879 \begin@{comment@} | |
8880 #+ORGTBL: SEND salesfigures orgtbl-to-latex | |
8881 | Month | Days | Nr sold | per day | | |
8882 |-------+------+---------+---------| | |
8883 | Jan | 23 | 55 | 2.4 | | |
8884 | Feb | 21 | 16 | 0.8 | | |
8885 | March | 22 | 278 | 12.6 | | |
8886 #+TBLFM: $4=$3/$2;%.1f | |
8887 % $ (optional extra dollar to keep font-lock happy, see footnote) | |
8888 \end@{comment@} | |
8889 @end example | |
8890 | |
8891 @noindent | |
8892 When you are done, press @kbd{C-c C-c} in the table to get the converted | |
8893 table inserted between the two marker lines. | |
8894 | |
8895 Now lets assume you want to make the table header by hand, because you | |
8896 want to control how columns are aligned etc. In this case we make sure | |
8897 that the table translator does skip the first 2 lines of the source | |
8898 table, and tell the command to work as a @i{splice}, i.e. to not produce | |
8899 header and footer commands of the target table: | |
8900 | |
8901 @example | |
8902 \begin@{tabular@}@{lrrr@} | |
8903 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\ | |
8904 % BEGIN RECEIVE ORGTBL salesfigures | |
8905 % END RECEIVE ORGTBL salesfigures | |
8906 \end@{tabular@} | |
8907 % | |
8908 \begin@{comment@} | |
8909 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2 | |
8910 | Month | Days | Nr sold | per day | | |
8911 |-------+------+---------+---------| | |
8912 | Jan | 23 | 55 | 2.4 | | |
8913 | Feb | 21 | 16 | 0.8 | | |
8914 | March | 22 | 278 | 12.6 | | |
8915 #+TBLFM: $4=$3/$2;%.1f | |
8916 \end@{comment@} | |
8917 @end example | |
8918 | |
8919 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
|
8920 Orgtbl mode. It uses a @code{tabular} environment to typeset the table |
84308 | 8921 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
|
8922 interprets the following parameters (see also @ref{Translator functions}): |
84308 | 8923 |
8924 @table @code | |
8925 @item :splice nil/t | |
8926 When set to t, return only table body lines, don't wrap them into a | |
8927 tabular environment. Default is nil. | |
8928 | |
8929 @item :fmt fmt | |
8930 A format to be used to wrap each field, should contain @code{%s} for the | |
8931 original field value. For example, to wrap each field value in dollars, | |
8932 you could use @code{:fmt "$%s$"}. This may also be a property list with | |
8933 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
|
8934 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
|
8935 function must return a formatted string. |
84308 | 8936 |
8937 @item :efmt efmt | |
8938 Use this format to print numbers with exponentials. The format should | |
8939 have @code{%s} twice for inserting mantissa and exponent, for example | |
8940 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This | |
8941 may also be a property list with column numbers and formats, for example | |
8942 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After | |
8943 @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
|
8944 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
|
8945 supplied instead of strings. |
84308 | 8946 @end table |
8947 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
8948 @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax |
84308 | 8949 @subsection Translator functions |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
8950 @cindex HTML, and Orgtbl mode |
84308 | 8951 @cindex translator function |
8952 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
8953 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
|
8954 (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
|
8955 @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
|
8956 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
|
8957 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
|
8958 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
|
8959 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
|
8960 @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
|
8961 hands over to the generic translator. Here is the entire code: |
84308 | 8962 |
8963 @lisp | |
8964 @group | |
8965 (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
|
8966 "Convert the Orgtbl mode TABLE to LaTeX." |
84308 | 8967 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l")) |
8968 org-table-last-alignment "")) | |
8969 (params2 | |
8970 (list | |
8971 :tstart (concat "\\begin@{tabular@}@{" alignment "@}") | |
8972 :tend "\\end@{tabular@}" | |
8973 :lstart "" :lend " \\\\" :sep " & " | |
8974 :efmt "%s\\,(%s)" :hline "\\hline"))) | |
8975 (orgtbl-to-generic table (org-combine-plists params2 params)))) | |
8976 @end group | |
8977 @end lisp | |
8978 | |
8979 As you can see, the properties passed into the function (variable | |
8980 @var{PARAMS}) are combined with the ones newly defined in the function | |
8981 (variable @var{PARAMS2}). The ones passed into the function (i.e. the | |
8982 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you | |
8983 would like to use the La@TeX{} translator, but wanted the line endings to | |
8984 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just | |
8985 overrule the default with | |
8986 | |
8987 @example | |
8988 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]" | |
8989 @end example | |
8990 | |
8991 For a new language, you can either write your own converter function in | |
8992 analogy with the La@TeX{} translator, or you can use the generic function | |
8993 directly. For example, if you have a language where a table is started | |
8994 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are | |
8995 started with @samp{!BL!}, ended with @samp{!EL!} and where the field | |
8996 separator is a TAB, you could call the generic translator like this (on | |
8997 a single line!): | |
8998 | |
8999 @example | |
9000 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!" | |
9001 :lstart "!BL! " :lend " !EL!" :sep "\t" | |
9002 @end example | |
9003 | |
9004 @noindent | |
9005 Please check the documentation string of the function | |
9006 @code{orgtbl-to-generic} for a full list of parameters understood by | |
9007 that function and remember that you can pass each of them into | |
9008 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function | |
9009 using the generic function. | |
9010 | |
9011 Of course you can also write a completely new function doing complicated | |
9012 things the generic translator cannot do. A translator function takes | |
9013 two arguments. The first argument is the table, a list of lines, each | |
9014 line either the symbol @code{hline} or a list of fields. The second | |
9015 argument is the property list containing all parameters specified in the | |
9016 @samp{#+ORGTBL: SEND} line. The function must return a single string | |
9017 containing the formatted table. If you write a generally useful | |
9018 translator, please post it on @code{emacs-orgmode@@gnu.org} so that | |
9019 others can benefit from your work. | |
9020 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9021 @node Radio lists, , Translator functions, Tables in arbitrary syntax |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9022 @subsection Radio lists |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9023 @cindex radio lists |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9024 @cindex org-list-insert-radio-list |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9025 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9026 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
|
9027 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
|
9028 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
|
9029 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
|
9030 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
|
9031 calling @code{org-list-insert-radio-list}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9032 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9033 Here are the differences with radio tables: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9034 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9035 @itemize @minus |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9036 @item |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9037 Use @code{ORGLST} instead of @code{ORGTBL}. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9038 @item |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9039 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
|
9040 parameters. |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
9041 @item |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9042 `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
|
9043 @end itemize |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9044 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9045 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
|
9046 La@TeX{} file: |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9047 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9048 @example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9049 % BEGIN RECEIVE ORGLST to-buy |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9050 % END RECEIVE ORGLST to-buy |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9051 \begin@{comment@} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9052 #+ORGLIST: SEND to-buy orgtbl-to-latex |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9053 - a new house |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9054 - a new computer |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9055 + a new keyboard |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9056 + a new mouse |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9057 - a new life |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9058 \end@{comment@} |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9059 @end example |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9060 |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9061 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
|
9062 La@TeX{} list between the two marker lines. |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9063 |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9064 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking |
84308 | 9065 @section Dynamic blocks |
9066 @cindex dynamic blocks | |
9067 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9068 Org documents can contain @emph{dynamic blocks}. These are |
84308 | 9069 specially marked regions that are updated by some user-written function. |
9070 A good example for such a block is the clock table inserted by the | |
9071 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}). | |
9072 | |
9073 Dynamic block are enclosed by a BEGIN-END structure that assigns a name | |
9074 to the block and can also specify parameters for the function producing | |
9075 the content of the block. | |
9076 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9077 #+BEGIN:dynamic block |
84308 | 9078 @example |
9079 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ... | |
9080 | |
9081 #+END: | |
9082 @end example | |
9083 | |
9084 Dynamic blocks are updated with the following commands | |
9085 | |
9086 @table @kbd | |
9087 @kindex C-c C-x C-u | |
9088 @item C-c C-x C-u | |
9089 Update dynamic block at point. | |
9090 @kindex C-u C-c C-x C-u | |
9091 @item C-u C-c C-x C-u | |
9092 Update all dynamic blocks in the current file. | |
9093 @end table | |
9094 | |
9095 Updating a dynamic block means to remove all the text between BEGIN and | |
9096 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
|
9097 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
|
9098 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
|
9099 extra parameter @code{:content}. |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
9100 |
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
9101 For a block with name @code{myblock}, the writer function is |
84308 | 9102 @code{org-dblock-write:myblock} with as only parameter a property list |
9103 with the parameters given in the begin line. Here is a trivial example | |
9104 of a block that keeps track of when the block update function was last | |
9105 run: | |
9106 | |
9107 @example | |
9108 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M" | |
9109 | |
9110 #+END: | |
9111 @end example | |
9112 | |
9113 @noindent | |
9114 The corresponding block writer function could look like this: | |
9115 | |
9116 @lisp | |
9117 (defun org-dblock-write:block-update-time (params) | |
9118 (let ((fmt (or (plist-get params :format) "%d. %m. %Y"))) | |
9119 (insert "Last block update at: " | |
9120 (format-time-string fmt (current-time))))) | |
9121 @end lisp | |
9122 | |
9123 If you want to make sure that all dynamic blocks are always up-to-date, | |
9124 you could add the function @code{org-update-all-dblocks} to a hook, for | |
9125 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
|
9126 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
|
9127 @code{org-mode}. |
84308 | 9128 |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9129 @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
|
9130 @section Special agenda views |
84308 | 9131 @cindex agenda views, user-defined |
9132 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9133 Org provides a special hook that can be used to narrow down the |
84308 | 9134 selection made by any of the agenda views. You may specify a function |
9135 that is used at each match to verify if the match should indeed be part | |
9136 of the agenda view, and if not, how much should be skipped. | |
9137 | |
9138 Let's say you want to produce a list of projects that contain a WAITING | |
9139 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
|
9140 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
|
9141 PROJECT. In this case you would run a TODO search for the keyword |
84308 | 9142 PROJECT, but skip the match unless there is a WAITING tag anywhere in |
9143 the subtree belonging to the project line. | |
9144 | |
9145 To achieve this, you must write a function that searches the subtree for | |
9146 the tag. If the tag is found, the function must return @code{nil} to | |
9147 indicate that this match should not be skipped. If there is no such | |
9148 tag, return the location of the end of the subtree, to indicate that | |
9149 search should continue from there. | |
9150 | |
9151 @lisp | |
9152 (defun my-skip-unless-waiting () | |
9153 "Skip trees that are not waiting" | |
9154 (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
|
9155 (if (re-search-forward ":waiting:" subtree-end t) |
84308 | 9156 nil ; tag found, do not skip |
9157 subtree-end))) ; tag not found, continue after end of subtree | |
9158 @end lisp | |
9159 | |
9160 Now you may use this function in an agenda custom command, for example | |
9161 like this: | |
9162 | |
9163 @lisp | |
9164 (org-add-agenda-custom-command | |
9165 '("b" todo "PROJECT" | |
9166 ((org-agenda-skip-function 'my-org-waiting-projects) | |
9167 (org-agenda-overriding-header "Projects waiting for something: ")))) | |
9168 @end lisp | |
9169 | |
9170 Note that this also binds @code{org-agenda-overriding-header} to get a | |
9171 meaningful header in the agenda view. | |
9172 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9173 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
|
9174 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
|
9175 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
|
9176 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
|
9177 have. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9178 |
84308 | 9179 You may also put a Lisp form into @code{org-agenda-skip-function}. In |
9180 particular, you may use the functions @code{org-agenda-skip-entry-if} | |
9181 and @code{org-agenda-skip-subtree-if} in this form, for example: | |
9182 | |
9183 @table @code | |
9184 @item '(org-agenda-skip-entry-if 'scheduled) | |
9185 Skip current entry if it has been scheduled. | |
9186 @item '(org-agenda-skip-entry-if 'notscheduled) | |
9187 Skip current entry if it has not been scheduled. | |
9188 @item '(org-agenda-skip-entry-if 'deadline) | |
9189 Skip current entry if it has a deadline. | |
9190 @item '(org-agenda-skip-entry-if 'scheduled 'deadline) | |
9191 Skip current entry if it has a deadline, or if it is scheduled. | |
9192 @item '(org-agenda-skip-entry 'regexp "regular expression") | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9193 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
|
9194 @item '(org-agenda-skip-entry 'notregexp "regular expression") |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9195 Skip current entry unless the regular expression matches. |
84308 | 9196 @item '(org-agenda-skip-subtree-if 'regexp "regular expression") |
9197 Same as above, but check and skip the entire subtree. | |
9198 @end table | |
9199 | |
9200 Therefore we could also have written the search for WAITING projects | |
9201 like this, even without defining a special function: | |
9202 | |
9203 @lisp | |
9204 (org-add-agenda-custom-command | |
9205 '("b" todo "PROJECT" | |
9206 ((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
|
9207 'regexp ":waiting:")) |
84308 | 9208 (org-agenda-overriding-header "Projects waiting for something: ")))) |
9209 @end lisp | |
9210 | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9211 @node Using the property API, Using the mapping API, Special agenda views, Hacking |
84308 | 9212 @section Using the property API |
9213 @cindex API, for properties | |
9214 @cindex properties, API | |
9215 | |
9216 Here is a description of the functions that can be used to work with | |
9217 properties. | |
9218 | |
9219 @defun org-entry-properties &optional pom which | |
9220 Get all properties of the entry at point-or-marker POM. | |
9221 This includes the TODO keyword, the tags, time strings for deadline, | |
9222 scheduled, and clocking, and any additional properties defined in the | |
9223 entry. The return value is an alist, keys may occur multiple times | |
9224 if the property key was used several times. | |
9225 POM may also be nil, in which case the current entry is used. | |
9226 If WHICH is nil or `all', get all properties. If WHICH is | |
9227 `special' or `standard', only get that subclass. | |
9228 @end defun | |
9229 @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
|
9230 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
|
9231 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
|
9232 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
|
9233 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
|
9234 @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
|
9235 @code{org-use-property-inheritance} selects PROPERTY for inheritance. |
84308 | 9236 @end defun |
9237 | |
9238 @defun org-entry-delete pom property | |
9239 Delete the property PROPERTY from entry at point-or-marker POM. | |
9240 @end defun | |
9241 | |
9242 @defun org-entry-put pom property value | |
9243 Set PROPERTY to VALUE for entry at point-or-marker POM. | |
9244 @end defun | |
9245 | |
9246 @defun org-buffer-property-keys &optional include-specials | |
9247 Get all property keys in the current buffer. | |
9248 @end defun | |
9249 | |
9250 @defun org-insert-property-drawer | |
9251 Insert a property drawer at point. | |
9252 @end defun | |
9253 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9254 @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
|
9255 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
|
9256 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
|
9257 @end defun |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9258 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9259 @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
|
9260 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
|
9261 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
|
9262 @end defun |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9263 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9264 @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
|
9265 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
|
9266 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
|
9267 @end defun |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9268 |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9269 @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
|
9270 @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
|
9271 @cindex API, for mapping |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9272 @cindex mapping entries, API |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9273 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9274 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
|
9275 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
|
9276 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
|
9277 functions for each or selected entries. The main entry point for this API |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9278 is: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9279 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9280 @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
|
9281 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
|
9282 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9283 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
|
9284 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
|
9285 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
|
9286 returned as a list. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9287 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9288 MATCH is a tags/property/todo match as it is used in the agenda tags view. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9289 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
|
9290 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
|
9291 visited by the iteration. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9292 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9293 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
|
9294 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9295 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9296 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
|
9297 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
|
9298 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
|
9299 file-with-archives |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9300 @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
|
9301 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
|
9302 agenda-with-archives |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9303 @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
|
9304 (file1 file2 ...) |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9305 @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
|
9306 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9307 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9308 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
|
9309 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
|
9310 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9311 @example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9312 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
|
9313 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
|
9314 function or Lisp form |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9315 @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
|
9316 @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
|
9317 @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
|
9318 @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
|
9319 @end example |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9320 @end defun |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9321 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9322 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
|
9323 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
|
9324 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
|
9325 Here are a couple of functions that might be handy: |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9326 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9327 @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
|
9328 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
|
9329 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
|
9330 @end defun |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9331 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9332 @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
|
9333 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
|
9334 possible values for ACTION. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9335 @end defun |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9336 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9337 @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
|
9338 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
|
9339 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
|
9340 @end defun |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9341 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9342 @defun org-promote |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9343 Promote the current entry. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9344 @end defun |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9345 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9346 @defun org-demote |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9347 Demote the current entry. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9348 @end defun |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9349 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9350 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
|
9351 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
|
9352 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
|
9353 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9354 @lisp |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9355 (org-map-entries |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9356 '(org-todo "UPCOMING") |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9357 "+TOMORROW" 'file 'archive 'comment) |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9358 @end lisp |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9359 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9360 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
|
9361 @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
|
9362 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9363 @lisp |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9364 (length (org-map-entries t "/+WAITING" nil 'agenda)) |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9365 @end lisp |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9366 |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9367 @node History and Acknowledgments, Main Index, Hacking, Top |
84308 | 9368 @appendix History and Acknowledgments |
9369 @cindex acknowledgments | |
9370 @cindex history | |
9371 @cindex thanks | |
9372 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9373 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
|
9374 of the Emacs Outline mode. I was trying to organize my notes and |
84308 | 9375 projects, and using Emacs seemed to be the natural way to go. However, |
9376 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
|
9377 command, only to hide and show parts of the outline tree, that seemed |
84308 | 9378 entirely unacceptable to me. Also, when using outlines to take notes, I |
9379 constantly want to restructure the tree, organizing it parallel to my | |
9380 thoughts and plans. @emph{Visibility cycling} and @emph{structure | |
9381 editing} were originally implemented in the package | |
9382 @file{outline-magic.el}, but quickly moved to the more general | |
9383 @file{org.el}. As this environment became comfortable for project | |
9384 planning, the next step was adding @emph{TODO entries}, basic @emph{time | |
9385 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
|
9386 goals that Org still has today: To create a new, outline-based, |
84308 | 9387 plain text mode with innovative and intuitive editing features, and to |
9388 incorporate project planning functionality directly into a notes file. | |
9389 | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9390 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
|
9391 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
|
9392 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
|
9393 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
|
9394 |
84308 | 9395 Since the first release, literally thousands of emails to me or on |
9396 @code{emacs-orgmode@@gnu.org} have provided a constant stream of bug | |
9397 reports, feedback, new ideas, and sometimes patches and add-on code. | |
9398 Many thanks to everyone who has helped to improve this package. I am | |
9399 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
|
9400 in shaping one or more aspects of Org. The list may not be |
84308 | 9401 complete, if I have forgotten someone, please accept my apologies and |
9402 let me know. | |
9403 | |
9404 @itemize @bullet | |
9405 | |
9406 @item | |
9407 @i{Russel Adams} came up with the idea for drawers. | |
9408 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9409 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}. |
84308 | 9410 @item |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9411 @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
|
9412 Org-mode website. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9413 @item |
84308 | 9414 @i{Alex Bochannek} provided a patch for rounding time stamps. |
9415 @item | |
9416 @i{Charles Cave}'s suggestion sparked the implementation of templates | |
9417 for Remember. | |
9418 @item | |
9419 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with | |
9420 specified time. | |
9421 @item | |
9422 @i{Gregory Chernov} patched support for lisp forms into table | |
9423 calculations and improved XEmacs compatibility, in particular by porting | |
9424 @file{nouline.el} to XEmacs. | |
9425 @item | |
9426 @i{Sacha Chua} suggested to copy some linking code from Planner. | |
9427 @item | |
9428 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also | |
9429 came up with the idea of properties, and that there should be an API for | |
9430 them. | |
9431 @item | |
9432 @i{Kees Dullemond} used to edit projects lists directly in HTML and so | |
9433 inspired some of the early development, including HTML export. He also | |
9434 asked for a way to narrow wide table columns. | |
9435 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9436 @i{Christian Egli} converted the documentation into Texinfo format, |
84308 | 9437 patched CSS formatting into the HTML exporter, and inspired the agenda. |
9438 @item | |
9439 @i{David Emery} provided a patch for custom CSS support in exported | |
9440 HTML agendas. | |
9441 @item | |
9442 @i{Nic Ferrier} contributed mailcap and XOXO support. | |
9443 @item | |
92864
8fc0a6fd114c
* org.texi (Exporting Agenda Views): Document agenda export to
Carsten Dominik <dominik@science.uva.nl>
parents:
92148
diff
changeset
|
9444 @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
|
9445 @item |
84308 | 9446 @i{John Foerch} figured out how to make incremental search show context |
9447 around a match in a hidden outline tree. | |
9448 @item | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9449 @i{Niels Giesen} had the idea to automatically archive DONE trees. |
84308 | 9450 @item |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9451 @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
|
9452 has been prolific with patches, ideas, and bug reports. |
84308 | 9453 @item |
9454 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages. | |
9455 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9456 @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
|
9457 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
|
9458 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
|
9459 @item |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9460 @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
|
9461 @item |
84308 | 9462 @i{Scott Jaderholm} proposed footnotes, control over whitespace between |
9463 folded entries, and column view for properties. | |
9464 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9465 @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
|
9466 @item |
84308 | 9467 @i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also |
9468 provided frequent feedback and some patches. | |
9469 @item | |
9470 @i{Jason F. McBrayer} suggested agenda export to CSV format. | |
9471 @item | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9472 @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
|
9473 @item |
84308 | 9474 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file |
9475 basis. | |
9476 @item | |
9477 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler | |
9478 happy. | |
9479 @item | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9480 @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
|
9481 and to be able to quickly restrict the agenda to a subtree. |
84308 | 9482 @item |
9483 @i{Todd Neal} provided patches for links to Info files and elisp forms. | |
9484 @item | |
9485 @i{Tim O'Callaghan} suggested in-file links, search options for general | |
9486 file links, and TAGS. | |
9487 @item | |
9488 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial | |
9489 into Japanese. | |
9490 @item | |
9491 @i{Oliver Oppitz} suggested multi-state TODO items. | |
9492 @item | |
9493 @i{Scott Otterson} sparked the introduction of descriptive text for | |
9494 links, among other things. | |
9495 @item | |
9496 @i{Pete Phillips} helped during the development of the TAGS feature, and | |
9497 provided frequent feedback. | |
9498 @item | |
9499 @i{T.V. Raman} reported bugs and suggested improvements. | |
9500 @item | |
9501 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality | |
9502 control. | |
9503 @item | |
9504 @i{Kevin Rogers} contributed code to access VM files on remote hosts. | |
9505 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9506 @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
|
9507 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
|
9508 single key navigation. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9509 @item |
84308 | 9510 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a |
9511 conflict with @file{allout.el}. | |
9512 @item | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9513 @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
|
9514 extensive patches. |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9515 @item |
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9516 @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
|
9517 of feedback, developed and applied standards to the Org documentation. |
84308 | 9518 @item |
9519 @i{Christian Schlauer} proposed angular brackets around links, among | |
9520 other things. | |
9521 @item | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9522 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s |
84308 | 9523 @file{organizer-mode.el}. |
9524 @item | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9525 @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
|
9526 @item |
84308 | 9527 @i{Daniel Sinder} came up with the idea of internal archiving by locking |
9528 subtrees. | |
9529 @item | |
9530 @i{Dale Smith} proposed link abbreviations. | |
9531 @item | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9532 @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
|
9533 extension system, added support for mairix, and proposed the mapping API. |
84308 | 9534 @item |
9535 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual | |
9536 chapter about publishing. | |
9537 @item | |
9538 @i{J@"urgen Vollmer} contributed code generating the table of contents | |
9539 in HTML output. | |
9540 @item | |
9541 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE} | |
9542 keyword. | |
9543 @item | |
9544 @i{David Wainberg} suggested archiving, and improvements to the linking | |
9545 system. | |
9546 @item | |
96044
c1ef445563bb
2008-06-17 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
95933
diff
changeset
|
9547 @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
|
9548 @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
|
9549 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
|
9550 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
|
9551 at John's code and learned a lot from it. John has also contributed a |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9552 number of great ideas and patches directly to Org, including the file |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9553 @code{org-mac-message.el}' |
84308 | 9554 @item |
9555 @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
|
9556 linking to Gnus. |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9557 @item |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9558 @i{Roland Winkler} requested additional key bindings to make Org |
84308 | 9559 work on a tty. |
9560 @item | |
9561 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks | |
9562 and contributed various ideas and code snippets. | |
9563 @end itemize | |
9564 | |
9565 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9566 @node Main Index, Key Index, History and Acknowledgments, Top |
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9567 @unnumbered The Main Index |
84308 | 9568 |
9569 @printindex cp | |
9570 | |
87836
22ad67b23797
(Property inheritance): New section
Carsten Dominik <dominik@science.uva.nl>
parents:
84329
diff
changeset
|
9571 @node Key Index, , Main Index, Top |
84308 | 9572 @unnumbered Key Index |
9573 | |
9574 @printindex ky | |
9575 | |
9576 @bye | |
9577 | |
9578 @ignore | |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9579 arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac |
84308 | 9580 @end ignore |
94409
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9581 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9582 @c Local variables: |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9583 @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
|
9584 @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
|
9585 @c fill-column: 77 |
e0901c47caf2
Massive changes in all parts of the documentation.
Carsten Dominik <dominik@science.uva.nl>
parents:
93759
diff
changeset
|
9586 @c End: |