Mercurial > emacs
annotate man/org.texi @ 81015:72b9f4dba30d
(show-paren-function): Undo 2007-04-19 and 2007-04-20 changes.
author | Chong Yidong <cyd@stupidchicken.com> |
---|---|
date | Mon, 21 May 2007 20:09:57 +0000 |
parents | 88224dc74061 |
children | 02b9a9aa5b0c bf0c02ef2719 |
rev | line source |
---|---|
58792 | 1 \input texinfo |
2 @c %**start of header | |
65245
8a283bd1b6c0
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
65244
diff
changeset
|
3 @setfilename ../info/org |
71098
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
4 @settitle Org Mode Manual |
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
5 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6 @set VERSION 4.67 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7 @set DATE February 2007 |
58792 | 8 |
9 @dircategory Emacs | |
10 @direntry | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
11 * Org Mode: (org). Outline-based notes management and organizer |
58792 | 12 @end direntry |
13 | |
14 @c Version and Contact Info | |
15 @set MAINTAINERSITE @uref{http://www.astro.uva.nl/~dominik/Tools/org/,maintainers webpage} | |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
16 @set AUTHOR Carsten Dominik |
58792 | 17 @set MAINTAINER Carsten Dominik |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
18 @set MAINTAINEREMAIL @email{dominik at science dot uva dot nl} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
19 @set MAINTAINERCONTACT @uref{mailto:dominik at science dot uva dot nl,contact the maintainer} |
58792 | 20 @c %**end of header |
21 @finalout | |
22 | |
23 @c Macro definitions | |
24 | |
69999
bd591cbbcdec
(Updating settings): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
69929
diff
changeset
|
25 @c Subheadings inside a table. |
58792 | 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 | |
36 This manual is for Org-mode (version @value{VERSION}). | |
37 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
38 Copyright @copyright{} 2004, 2005, 2006, 2007 Free Software Foundation |
58792 | 39 |
40 @quotation | |
41 Permission is granted to copy, distribute and/or modify this document | |
65656 | 42 under the terms of the GNU Free Documentation License, Version 1.1 or |
58792 | 43 any later version published by the Free Software Foundation; with no |
44 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' | |
45 and with the Back-Cover Texts as in (a) below. A copy of the | |
46 license is included in the section entitled ``GNU Free Documentation | |
47 License.'' | |
48 | |
49 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify | |
50 this GNU Manual, like GNU software. Copies published by the Free | |
51 Software Foundation raise funds for GNU development.'' | |
52 @end quotation | |
53 @end copying | |
54 | |
55 @titlepage | |
56 @title Org Mode Manual | |
57 | |
58 @subtitle Release @value{VERSION} | |
59 @author by Carsten Dominik | |
60 | |
61 @c The following two commands start the copyright page. | |
62 @page | |
63 @vskip 0pt plus 1filll | |
64 @insertcopying | |
65 @end titlepage | |
66 | |
67 @c Output the table of contents at the beginning. | |
68 @contents | |
69 | |
70 @ifnottex | |
71 @node Top, Introduction, (dir), (dir) | |
72 @top Org Mode Manual | |
73 | |
74 @insertcopying | |
75 @end ifnottex | |
76 | |
77 @menu | |
78 * Introduction:: Getting started | |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
79 * Document structure:: A tree works like your brain |
58792 | 80 * Tables:: Pure magic for quick formatting |
81 * Hyperlinks:: Notes in context | |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
82 * TODO items:: Every tree branch can be a TODO item |
58792 | 83 * Timestamps:: Assign date and time to items |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
84 * Tags:: Tagging headlines and matching sets of tags |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
85 * Agenda views:: Collecting information into views |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
86 * Embedded LaTeX:: LaTeX fragments and formulas |
58792 | 87 * Exporting:: Sharing and publishing of notes |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
88 * Publishing:: Create a web site of linked Org-mode files |
58792 | 89 * Miscellaneous:: All the rest which did not fit elsewhere |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
90 * Extensions and Hacking:: It is possible to write add-on code |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
91 * History and Acknowledgments:: How Org-mode came into being |
77235 | 92 * GNU Free Documentation License:: The license for this documentation. |
58792 | 93 * Index:: The fast road to specific information |
94 * Key Index:: Key bindings and where they are described | |
95 | |
96 @detailmenu | |
97 --- The Detailed Node Listing --- | |
98 | |
99 Introduction | |
100 | |
101 * Summary:: Brief summary of what Org-mode does | |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
102 * Installation:: How to install a downloaded version of Org-mode |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
103 * Activation:: How to activate Org-mode for certain buffers. |
64517 | 104 * Feedback:: Bug reports, ideas, patches etc. |
58792 | 105 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
106 Document Structure |
58792 | 107 |
108 * Outlines:: Org-mode is based on outline-mode | |
109 * Headlines:: How to typeset org-tree headlines | |
65656 | 110 * Visibility cycling:: Show and hide, much simplified |
58792 | 111 * Motion:: Jumping to other headlines |
112 * Structure editing:: Changing sequence and level of headlines | |
63362 | 113 * Archiving:: Move done task trees to a different place |
58792 | 114 * Sparse trees:: Matches embedded in context |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
115 * Plain lists:: Additional structure within an entry |
58792 | 116 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
117 Archiving |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
118 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
119 * ARCHIVE tag:: Marking a tree as inactive |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
120 * Moving subtrees:: Moving a tree to an archive file |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
121 |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
122 Tables |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
123 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
124 * Built-in table editor:: Simple tables |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
125 * Narrow columns:: Stop wasting space in tables |
63833 | 126 * orgtbl-mode:: The table editor as minor mode |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
127 * The spreadsheet:: The table editor has spreadsheet capabilities. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
128 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
129 The spreadsheet |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
130 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
131 * References:: How to refer to another field or range |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
132 * Formula syntax for Calc:: Using Calc to compute stuff |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
133 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
134 * Field formulas:: Formulas valid for a single field |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
135 * Column formulas:: Formulas valid for an entire column |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
136 * Editing and debugging formulas:: Fixing formulas |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
137 * Updating the table:: Recomputing all dependent fields |
64517 | 138 * Advanced features:: Field names, parameters and automatic recalc |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
139 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
140 Hyperlinks |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
141 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
142 * Link format:: How links in Org-mode are formatted |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
143 * Internal links:: Links to other places in the current file |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
144 * External links:: URL-like links to the world |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
145 * Handling links:: Creating, inserting and following |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
146 * Link abbreviations:: Shortcuts for writing complex links |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
147 * Search options:: Linking to a specific location |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
148 * Custom searches:: When the default search is not enough |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
149 * Remember:: Org-trees store quick notes |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
150 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
151 Internal links |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
152 |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
153 * Radio targets:: Make targets trigger links in plain text. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
154 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
155 Remember |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
156 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
157 * Setting up remember:: Some code for .emacs to get things going |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
158 * Remember templates:: Define the outline of different note types |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
159 * Storing notes:: Directly get the note to where it belongs |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
160 |
58792 | 161 TODO items |
162 | |
163 * TODO basics:: Marking and displaying TODO entries | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
164 * TODO extensions:: Workflow and assignments |
58792 | 165 * Priorities:: Some things are more important than others |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
166 * Breaking down tasks:: Splitting a task into managable pieces |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
167 * Checkboxes:: Tick-off lists |
58792 | 168 |
169 Extended use of TODO keywords | |
170 | |
171 * Workflow states:: From TODO to DONE in steps | |
172 * TODO types:: I do this, Fred the rest | |
173 * Per file keywords:: Different files, different requirements | |
174 | |
175 Timestamps | |
176 | |
177 * Time stamps:: Assigning a time to a tree entry | |
178 * Creating timestamps:: Commands which insert timestamps | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
179 * Custom time format:: If you cannot work with the ISO format |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
180 * Repeating items:: Deadlines that come back again and again |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
181 * Progress logging:: Documenting when what work was done. |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
182 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
183 Creating timestamps |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
184 |
74030 | 185 * The date/time prompt:: How org-mode helps you entering date and time |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
186 |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
187 Progress Logging |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
188 |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
189 * Closing items:: When was this entry marked DONE? |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
190 * Tracking TODO state changes:: When did the status change? |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
191 * Clocking work time:: When exactly did you work on this item? |
58792 | 192 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
193 Tags |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
194 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
195 * Tag inheritance:: Tags use the tree structure of the outline |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
196 * Setting tags:: How to assign tags to a headline |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
197 * Tag searches:: Searching for combinations of tags |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
198 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
199 Agenda Views |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
200 |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
201 * Agenda files:: Files being searched for agenda information |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
202 * Agenda dispatcher:: Keyboard access to agenda views |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
203 * Built-in agenda views:: What is available out of the box? |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
204 * Presentation and sorting:: How agenda items are prepared for display |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
205 * Agenda commands:: Remote editing of org trees |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
206 * Custom agenda views:: Defining special searches and views |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
207 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
208 The built-in agenda views |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
209 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
210 * Weekly/Daily agenda:: The calendar page with current tasks |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
211 * Global TODO list:: All unfinished action items |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
212 * Matching headline tags:: Structured information with fine-tuned search |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
213 * Timeline:: Time-sorted view for single file |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
214 * Stuck projects:: Find projects you need to review |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
215 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
216 Presentation and sorting |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
217 |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
218 * Categories:: Not all tasks are equal |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
219 * Time-of-day specifications:: How the agenda knows the time |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
220 * Sorting of agenda items:: The order of things |
58792 | 221 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
222 Custom agenda views |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
223 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
224 * Storing searches:: Type once, use often |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
225 * Block agenda:: All the stuff you need in a single buffer |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
226 * Setting Options:: Changing the rules |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
227 * Batch processing:: Agenda views from the command line |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
228 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
229 Embedded LaTeX |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
230 |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
231 * Math symbols:: TeX macros for symbols and Greek letters |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
232 * Subscripts and Superscripts:: Simple syntax for raising/lowering text |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
233 * LaTeX fragments:: Complex formulas made easy |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
234 * Processing LaTeX fragments:: Previewing LaTeX processing |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
235 * CDLaTeX mode:: Speed up entering of formulas |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
236 |
58792 | 237 Exporting |
238 | |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
239 * ASCII export:: Exporting to plain ASCII |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
240 * HTML export:: Exporting to HTML |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
241 * XOXO export:: Exporting to XOXO |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
242 * iCalendar export:: Exporting in iCalendar format |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
243 * Text interpretation:: How the exporter looks at the file |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
244 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
245 HTML export |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
246 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
247 * Export commands:: How to invode HTML export |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
248 * Quoting HTML tags:: Using direct HTML in Org-mode |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
249 * Links:: How hyperlinks get transferred to HTML |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
250 * Images:: To inline or not to inline? |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
251 * CSS support:: Style specifications |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
252 |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
253 Text interpretation by the exporter |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
254 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
255 * Comment lines:: Some lines will not be exported |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
256 * Enhancing text:: Subscripts, symbols and more |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
257 * Export options:: How to influence the export settings |
58792 | 258 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
259 Publishing |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
260 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
261 * Configuration:: Defining projects |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
262 * Sample configuration:: Example projects |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
263 * Triggering publication:: Publication commands |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
264 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
265 Configuration |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
266 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
267 * Project alist:: The central configuration variable |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
268 * Sources and destinations:: From here to there |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
269 * Selecting files:: What files are part of the project? |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
270 * Publishing action:: Setting the function doing the publishing |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
271 * Publishing options:: Tweaking HTML export |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
272 * Publishing links:: Which links keep working after publishing? |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
273 * Project page index:: Publishing a list of project files |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
274 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
275 Sample configuration |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
276 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
277 * Simple example:: One-component publishing |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
278 * Complex example:: A multi-component publishing example |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
279 |
58792 | 280 Miscellaneous |
281 | |
282 * Completion:: M-TAB knows what you need | |
283 * Customization:: Adapting Org-mode to your taste | |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
284 * In-buffer settings:: Overview of the #+KEYWORDS |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
285 * The very busy C-c C-c key:: When in doubt, press C-c C-c |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
286 * Clean view:: Getting rid of leading stars in the outline |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
287 * TTY keys:: Using Org-mode on a tty |
58792 | 288 * Interaction:: Other Emacs packages |
63362 | 289 * Bugs:: Things which do not work perfectly |
58792 | 290 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
291 Interaction with other packages |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
292 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
293 * Cooperation:: Packages Org-mode cooperates with |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
294 * Conflicts:: Packages that lead to conflicts |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
295 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
296 Extensions, Hooks and Hacking |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
297 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
298 * Extensions:: Existing 3rd-part extensions |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
299 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
300 * Dynamic blocks:: Automatically filled blocks |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
301 * Special agenda views:: Customized views |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
302 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
303 Tables in arbitrary syntax |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
304 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
305 * Radio tables:: Sending and receiving |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
306 * A LaTeX example:: Step by step, almost a tutorial |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
307 * Translator functions:: Copy and modify |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
308 |
58792 | 309 @end detailmenu |
310 @end menu | |
311 | |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
312 @node Introduction, Document structure, Top, Top |
58792 | 313 @chapter Introduction |
314 @cindex introduction | |
315 | |
316 @menu | |
317 * Summary:: Brief summary of what Org-mode does | |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
318 * Installation:: How to install a downloaded version of Org-mode |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
319 * Activation:: How to activate Org-mode for certain buffers. |
64517 | 320 * Feedback:: Bug reports, ideas, patches etc. |
58792 | 321 @end menu |
322 | |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
323 @node Summary, Installation, Introduction, Introduction |
58792 | 324 @section Summary |
325 @cindex summary | |
326 | |
327 Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing | |
328 project planning with a fast and effective plain-text system. | |
329 | |
330 Org-mode develops organizational tasks around NOTES files that contain | |
73967
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
331 lists or information about projects as plain text. Org-mode is |
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
332 implemented on top of outline-mode, which makes it possible to keep the |
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
333 content of large files well structured. Visibility cycling and |
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
334 structure editing help to work with the tree. Tables are easily created |
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
335 with a built-in table editor. Org-mode supports ToDo items, deadlines, |
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
336 time stamps, and scheduling. It dynamically compiles entries into an |
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
337 agenda that utilizes and smoothly integrates much of the Emacs calendar |
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
338 and diary. Plain text URL-like links connect to websites, emails, |
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
339 Usenet messages, BBDB entries, and any files related to the projects. |
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
340 For printing and sharing of notes, an Org-mode file can be exported as a |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
341 structured ASCII file, as HTML, or (todo and agenda items only) as an |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
342 iCalendar file. It can also serve as a publishing tool for a set of |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
343 linked webpages. |
58792 | 344 |
73967
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
345 An important design aspect that distinguishes Org-mode from for example |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
346 Planner/Muse is that it encourages to store every piece of information |
73967
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
347 only once. In Planner, you have project pages, day pages and possibly |
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
348 other files, duplicating some information such as tasks. In Org-mode, |
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
349 you only have notes files. In your notes you mark entries as tasks, |
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
350 label them with tags and timestamps. All necessary lists like a |
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
351 schedule for the day, the agenda for a meeting, tasks lists selected by |
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
352 tags etc are created dynamically when you need them. |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
353 |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
354 Org-mode keeps simple things simple. When first fired up, it should |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
355 feel like a straightforward, easy to use outliner. Complexity is not |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
356 imposed, but a large amount of functionality is available when you need |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
357 it. Org-mode can be used on different levels and in different ways, for |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
358 example as: |
58792 | 359 |
360 @example | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
361 @r{@bullet{} outline extension with visibility cycling and structure editing} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
362 @r{@bullet{} ASCII system and table editor for taking structured notes} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
363 @r{@bullet{} ASCII table editor with spreadsheet-like capabilities} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
364 @r{@bullet{} TODO list editor} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
365 @r{@bullet{} full agenda and planner with deadlines and work scheduling} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
366 @r{@bullet{} environment to implement David Allen's GTD system} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
367 @r{@bullet{} simple hypertext system, with HTML export} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
368 @r{@bullet{} publishing tool to create a set of interlinked webpages} |
58792 | 369 @end example |
370 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
371 Org-mode's automatic, context sensitive table editor with spreadsheet |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
372 capabilities can be integrated into any major mode by activating the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
373 minor Orgtbl-mode. Using a translation step, it can be used to maintain |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
374 tables in arbitray file types, for example in LaTeX. |
59541 | 375 |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
376 @cindex FAQ |
59541 | 377 There is a website for Org-mode which provides links to the newest |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
378 version of Org-mode, as well as additional information, frequently asked |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
379 questions (FAQ), links to tutorials etc. This page is located at |
59541 | 380 @uref{http://www.astro.uva.nl/~dominik/Tools/org/}. |
381 | |
382 @page | |
383 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
384 |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
385 @node Installation, Activation, Summary, Introduction |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
386 @section Installation |
58792 | 387 @cindex installation |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
388 @cindex XEmacs |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
389 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
390 @b{Important:} @i{If Org-mode is part of the Emacs distribution or an |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
391 XEmacs package, please skip this section and go directly to |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
392 @ref{Activation}.} |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
393 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
394 If you have downloaded Org-mode from the Web, you must take the |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
395 following steps to install it: Go into the Org-mode distribution |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
396 directory and edit the top section of the file @file{Makefile}. You |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
397 must set the name of the Emacs binary (likely either @file{emacs} or |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
398 @file{xemacs}), and the paths to the directories where local Lisp and |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
399 Info files are kept. If you don't have access to the system-wide |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
400 directories, create your own two directories for these files, enter them |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
401 into the Makefile, and make sure Emacs finds the Lisp files by adding |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
402 the following line to @file{.emacs}: |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
403 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
404 @example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
405 (setq load-path (cons "~/path/to/lispdir" load-path)) |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
406 @end example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
407 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
408 @b{XEmacs users now need to install the file @file{noutline.el} from |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
409 the @file{xemacs} subdirectory of the Org-mode distribution. Use the |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
410 command:} |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
411 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
412 @example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
413 @b{make install-noutline} |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
414 @end example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
415 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
416 @noindent Now byte-compile and install the Lisp files with the shell |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
417 commands: |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
418 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
419 @example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
420 make |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
421 make install |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
422 @end example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
423 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
424 @noindent If you want to install the info documentation, use this command: |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
425 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
426 @example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
427 make install-info |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
428 @end example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
429 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
430 @noindent Then add to @file{.emacs}: |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
431 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
432 @lisp |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
433 ;; This line only if org-mode is not part of the X/Emacs distribution. |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
434 (require 'org-install) |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
435 @end lisp |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
436 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
437 @node Activation, Feedback, Installation, Introduction |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
438 @section Activation |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
439 @cindex activation |
58792 | 440 @cindex autoload |
441 @cindex global keybindings | |
442 @cindex keybindings, global | |
443 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
444 @iftex |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
445 @b{Important:} @i{If you use copy-and-paste to copy lisp code from the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
446 PDF documentation to your .emacs file, the single quote character comes |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
447 out incorrectly and the code will not work. You need to fix the single |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
448 quotes by hand, or copy from Info documentation.} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
449 @end iftex |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
450 |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
451 Add the following lines to your @file{.emacs} file. The last two lines |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
452 define @emph{global} keys for the commands @command{org-store-link} and |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
453 @command{org-agenda} - please choose suitable keys yourself. |
58792 | 454 |
62548 | 455 @lisp |
456 ;; The following lines are always needed. Choose your own keys. | |
457 (add-to-list 'auto-mode-alist '("\\.org$" . org-mode)) | |
458 (define-key global-map "\C-cl" 'org-store-link) | |
459 (define-key global-map "\C-ca" 'org-agenda) | |
460 @end lisp | |
58792 | 461 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
462 Furthermore, you must activate @code{font-lock-mode} in org-mode |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
463 buffers, because significant functionality depends on font-locking being |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
464 active. You can do this with either one of the following two lines |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
465 (XEmacs user must use the second option): |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
466 @lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
467 (global-font-lock-mode 1) ; for all buffers |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
468 (add-hook 'org-mode-hook 'turn-on-font-lock) ; org-mode buffers only |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
469 @end lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
470 |
58792 | 471 @cindex org-mode, turning on |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
472 With this setup, all files with extension @samp{.org} will be put |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
473 into Org-mode. As an alternative, make the first line of a file look |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
474 like this: |
58792 | 475 |
476 @example | |
477 MY PROJECTS -*- mode: org; -*- | |
478 @end example | |
479 | |
480 @noindent which will select Org-mode for this buffer no matter what | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
481 the file's name is. See also the variable |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
482 @code{org-insert-mode-line-in-empty-file}. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
483 |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
484 @node Feedback, , Activation, Introduction |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
485 @section Feedback |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
486 @cindex feedback |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
487 @cindex bug reports |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
488 @cindex maintainer |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
489 @cindex author |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
490 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
491 If you find problems with Org-mode, or if you have questions, remarks, |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
492 or ideas about it, please contact the maintainer @value{MAINTAINER} at |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
493 @value{MAINTAINEREMAIL}. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
494 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
495 For bug reports, please provide as much information as possible, |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
496 including the version information of Emacs (@kbd{C-h v emacs-version |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
497 @key{RET}}) and Org-mode (@kbd{C-h v org-version @key{RET}}), as well as |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
498 the Org-mode related setup in @file{.emacs}. If an error occurs, a |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
499 backtrace can be very useful (see below on how to create one). Often a |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
500 small example file helps, along with clear information about: |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
501 |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
502 @enumerate |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
503 @item What exactly did you do? |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
504 @item What did you expect to happen? |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
505 @item What happened instead? |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
506 @end enumerate |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
507 @noindent Thank you for helping to improve this mode. |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
508 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
509 @subsubheading How to create a useful backtrace |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
510 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
511 @cindex backtrace of an error |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
512 If working with Org-mode produces an error with a message you don't |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
513 understand, you may have hit a bug. The best way to report this is by |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
514 providing, in addition to what was mentioned above, a @emph{Backtrace}. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
515 This is information from the built-in debugger about where and how the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
516 error occurred. Here is how to produce a useful backtrace: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
517 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
518 @enumerate |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
519 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
520 Start a fresh Emacs or XEmacs, and make sure that it will load the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
521 original Lisp code in @file{org.el} instead of the compiled version in |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
522 @file{org.elc}. The backtrace contains much more information if it is |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
523 produced with uncompiled code. To do this, either rename @file{org.elc} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
524 to something else before starting Emacs, or ask Emacs explicitly to load |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
525 @file{org.el} by using the command line |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
526 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
527 emacs -l /path/to/org.el |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
528 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
529 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
530 Go to the @code{Options} menu and select @code{Enter Debugger on Error} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
531 (XEmacs has this option in the @code{Troubleshooting} sub-menu). |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
532 @item |
73967
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
533 Do whatever you have to do to hit the error. Don't forget to |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
534 document the steps you take. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
535 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
536 When you hit the error, a @file{*Backtrace*} buffer will appear on the |
73967
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
537 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and |
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
538 attach it to your bug report. |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
539 @end enumerate |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
540 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
541 @node Document structure, Tables, Introduction, Top |
58792 | 542 @chapter Document Structure |
543 @cindex document structure | |
544 @cindex structure of document | |
545 | |
546 Org-mode is based on outline mode and provides flexible commands to | |
547 edit the structure of the document. | |
548 | |
549 @menu | |
550 * Outlines:: Org-mode is based on outline-mode | |
551 * Headlines:: How to typeset org-tree headlines | |
65656 | 552 * Visibility cycling:: Show and hide, much simplified |
58792 | 553 * Motion:: Jumping to other headlines |
554 * Structure editing:: Changing sequence and level of headlines | |
63362 | 555 * Archiving:: Move done task trees to a different place |
58792 | 556 * Sparse trees:: Matches embedded in context |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
557 * Plain lists:: Additional structure within an entry |
58792 | 558 @end menu |
559 | |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
560 @node Outlines, Headlines, Document structure, Document structure |
58792 | 561 @section Outlines |
562 @cindex outlines | |
563 @cindex outline-mode | |
564 | |
565 Org-mode is implemented on top of outline-mode. Outlines allow to | |
566 organize a document in a hierarchical structure, which (at least for | |
567 me) is the best representation of notes and thoughts. Overview over | |
568 this structure is achieved by folding (hiding) large parts of the | |
569 document to show only the general document structure and the parts | |
570 currently being worked on. Org-mode greatly simplifies the use of | |
571 outlines by compressing the entire show/hide functionality into a | |
572 single command @command{org-cycle}, which is bound to the @key{TAB} | |
573 key. | |
574 | |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
575 @node Headlines, Visibility cycling, Outlines, Document structure |
58792 | 576 @section Headlines |
577 @cindex headlines | |
578 @cindex outline tree | |
579 | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
580 Headlines define the structure of an outline tree. The headlines in |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
581 Org-mode start with one or more stars, on the left margin. For |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
582 example: |
58792 | 583 |
584 @example | |
585 * Top level headline | |
586 ** Second level | |
587 *** 3rd level | |
588 some text | |
589 *** 3rd level | |
590 more text | |
591 * Another top level headline | |
592 @end example | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
593 |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
594 @noindent Some people find the many stars too noisy and would prefer an |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
595 outline that has whitespace followed by a single star as headline |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
596 starters. @ref{Clean view} describes a setup to realize this. |
58792 | 597 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
598 @node Visibility cycling, Motion, Headlines, Document structure |
58792 | 599 @section Visibility cycling |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
600 @cindex cycling, visibility |
58792 | 601 @cindex visibility cycling |
602 @cindex trees, visibility | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
603 @cindex show hidden text |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
604 @cindex hide text |
58792 | 605 |
606 Outlines make it possible to hide parts of the text in the buffer. | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
607 Org-mode uses just two commands, bound to @key{TAB} and |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
608 @kbd{S-@key{TAB}} to change the visibility in the buffer. |
58792 | 609 |
610 @cindex subtree visibility states | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
611 @cindex subtree cycling |
58792 | 612 @cindex folded, subtree visibility state |
613 @cindex children, subtree visibility state | |
614 @cindex subtree, subtree visibility state | |
615 @table @kbd | |
616 @kindex @key{TAB} | |
617 @item @key{TAB} | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
618 @emph{Subtree cycling}: Rotate current subtree between the states |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
619 |
58792 | 620 @example |
621 ,-> FOLDED -> CHILDREN -> SUBTREE --. | |
622 '-----------------------------------' | |
623 @end example | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
624 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
625 The cursor must be on a headline for this to work@footnote{see, however, |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
626 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
627 beginning of the buffer and the first line is not a headline, then |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
628 @key{TAB} actually runs global cycling (see below)@footnote{see the |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
629 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
630 argument (@kbd{C-u @key{TAB}}), global cycling is invoked. |
58792 | 631 |
632 @cindex global visibility states | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
633 @cindex global cycling |
58792 | 634 @cindex overview, global visibility state |
635 @cindex contents, global visibility state | |
636 @cindex show all, global visibility state | |
637 @kindex S-@key{TAB} | |
638 @item S-@key{TAB} | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
639 @itemx C-u @key{TAB} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
640 @emph{Global cycling}: Rotate the entire buffer between the states |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
641 |
58792 | 642 @example |
643 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --. | |
644 '--------------------------------------' | |
645 @end example | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
646 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
647 When @kbd{S-@key{TAB}} is called with a numerical prefix N, the CONTENTS |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
648 view up to headlines of level N will be shown. |
58792 | 649 Note that inside tables, @kbd{S-@key{TAB}} jumps to the previous field. |
650 | |
651 @cindex show all, command | |
652 @kindex C-c C-a | |
653 @item C-c C-a | |
654 Show all. | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
655 @kindex C-c C-r |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
656 @item C-c C-r |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
657 Reveal context around point, showing the current entry, the following |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
658 heading and the hierarchy above. Useful for working near a location |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
659 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
660 command (@pxref{Agenda commands}). With prefix arg show, on each |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
661 level, all sibling headings. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
662 @kindex C-c C-x b |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
663 @item C-c C-x b |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
664 Show the current subtree in an indirect buffer@footnote{The indirect |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
665 buffer (@pxref{Indirect Buffers,Indirect Buffers,Indirect |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
666 Buffers,emacs,GNU Emacs Manual}) will contain the entire buffer, but |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
667 will be narrowed to the current tree. Editing the indirect buffer will |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
668 also change the original buffer, but without affecting visibility in |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
669 that buffer.}. With numerical prefix ARG, go up to this level and then |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
670 take that tree. If ARG is negative, go up that many levels. With |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
671 @kbd{C-u} prefix, do not remove the previously used indirect buffer. |
58792 | 672 @end table |
673 | |
63833 | 674 When Emacs first visits an Org-mode file, the global state is set to |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
675 OVERVIEW, i.e. only the top level headlines are visible. This can be |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
676 configured through the variable @code{org-startup-folded}, or on a |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
677 per-file basis by adding one of the following lines anywhere in the |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
678 buffer: |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
679 |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
680 @example |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
681 #+STARTUP: overview |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
682 #+STARTUP: content |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
683 #+STARTUP: showall |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
684 @end example |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
685 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
686 @node Motion, Structure editing, Visibility cycling, Document structure |
58792 | 687 @section Motion |
688 @cindex motion, between headlines | |
689 @cindex jumping, to headlines | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
690 @cindex headline navigation |
58792 | 691 The following commands jump to other headlines in the buffer. |
692 | |
693 @table @kbd | |
694 @kindex C-c C-n | |
695 @item C-c C-n | |
696 Next heading. | |
697 @kindex C-c C-p | |
698 @item C-c C-p | |
699 Previous heading. | |
700 @kindex C-c C-f | |
701 @item C-c C-f | |
702 Next heading same level. | |
703 @kindex C-c C-b | |
704 @item C-c C-b | |
705 Previous heading same level. | |
706 @kindex C-c C-u | |
707 @item C-c C-u | |
708 Backward to higher level heading. | |
709 @kindex C-c C-j | |
710 @item C-c C-j | |
711 Jump to a different place without changing the current outline | |
712 visibility. Shows the document structure in a temporary buffer, where | |
713 you can use visibility cycling (@key{TAB}) to find your destination. | |
714 After pressing @key{RET}, the cursor moves to the selected location in | |
715 the original buffer, and the headings hierarchy above it is made | |
716 visible. | |
717 @end table | |
718 | |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
719 @node Structure editing, Archiving, Motion, Document structure |
58792 | 720 @section Structure editing |
721 @cindex structure editing | |
722 @cindex headline, promotion and demotion | |
723 @cindex promotion, of subtrees | |
724 @cindex demotion, of subtrees | |
725 @cindex subtree, cut and paste | |
63833 | 726 @cindex pasting, of subtrees |
727 @cindex cutting, of subtrees | |
728 @cindex copying, of subtrees | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
729 @cindex subtrees, cut and paste |
58792 | 730 |
731 @table @kbd | |
732 @kindex M-@key{RET} | |
733 @item M-@key{RET} | |
67382
62adeda8b0dd
Structure editing): DOcument new fucntionality of
Carsten Dominik <dominik@science.uva.nl>
parents:
67353
diff
changeset
|
734 Insert new heading with same level as current. If the cursor is in a |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
735 plain list item, a new item is created (@pxref{Plain lists}). To force |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
736 creation of a new headline, use a prefix arg, or first press @key{RET} |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
737 to get to the beginning of the next line. When this command is used in |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
738 the middle of a line, the line is split and the rest of the line becomes |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
739 the new headline. If the command is used at the beginning of a |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
740 headline, the new headline is created before the current line. If at |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
741 the beginning of any other line, the content of that line is made the |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
742 new heading. If the command is used at the end of a folded subtree |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
743 (i.e. behind the ellipses at the end of a headline), then a headline |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
744 like the current one will be inserted after the end of the subtree. |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
745 @kindex M-S-@key{RET} |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
746 @item M-S-@key{RET} |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
747 Insert new TODO entry with same level as current heading. |
58792 | 748 @kindex M-@key{left} |
749 @item M-@key{left} | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
750 Promote current heading by one level. |
58792 | 751 @kindex M-@key{right} |
752 @item M-@key{right} | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
753 Demote current heading by one level. |
58792 | 754 @kindex M-S-@key{left} |
755 @item M-S-@key{left} | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
756 Promote the current subtree by one level. |
58792 | 757 @kindex M-S-@key{right} |
758 @item M-S-@key{right} | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
759 Demote the current subtree by one level. |
58792 | 760 @kindex M-S-@key{up} |
761 @item M-S-@key{up} | |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
762 Move subtree up (swap with previous subtree of same |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
763 level). |
58792 | 764 @kindex M-S-@key{down} |
765 @item M-S-@key{down} | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
766 Move subtree down (swap with next subtree of same level). |
65656 | 767 @kindex C-c C-x C-w |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
768 @kindex C-c C-x C-k |
65656 | 769 @item C-c C-x C-w |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
770 @itemx C-c C-x C-k |
58792 | 771 Kill subtree, i.e. remove it from buffer but save in kill ring. |
65656 | 772 @kindex C-c C-x M-w |
773 @item C-c C-x M-w | |
58792 | 774 Copy subtree to kill ring. |
65656 | 775 @kindex C-c C-x C-y |
776 @item C-c C-x C-y | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
777 Yank subtree from kill ring. This does modify the level of the subtree to |
58792 | 778 make sure the tree fits in nicely at the yank position. The yank |
779 level can also be specified with a prefix arg, or by yanking after a | |
780 headline marker like @samp{****}. | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
781 @kindex C-c ^ |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
782 @item C-c ^ |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
783 Sort same-level entries. When there is an active region, all entries in |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
784 the region will be sorted. Otherwise the children of the current |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
785 headline are sorted. The command prompts for the sorting method, which |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
786 can be alphabetically, numerically, by time (using the first time stamp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
787 in each entry), and each of these in reverse order. With a @kbd{C-u} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
788 prefix, sorting will be case-sensitive. With two @kbd{C-u C-u} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
789 prefixes, duplicate entries will also be removed. |
58792 | 790 @end table |
791 | |
792 @cindex region, active | |
793 @cindex active region | |
794 @cindex transient-mark-mode | |
795 When there is an active region (transient-mark-mode), promotion and | |
796 demotion work on all headlines in the region. To select a region of | |
797 headlines, it is best to place both point and mark at the beginning of a | |
798 line, mark at the beginning of the first headline, and point at the line | |
799 just after the last headline to change. Note that when the cursor is | |
800 inside a table (@pxref{Tables}), the Meta-Cursor keys have different | |
801 functionality. | |
802 | |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
803 @node Archiving, Sparse trees, Structure editing, Document structure |
63362 | 804 @section Archiving |
805 @cindex archiving | |
806 | |
63833 | 807 When a project represented by a (sub)tree is finished, you may want |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
808 to move the tree out of the way and to stop it from contributing to the |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
809 agenda. Org-mode knows two ways of archiving. You can mark a tree with |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
810 the ARCHIVE tag, or you can move an entire (sub)tree to a different |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
811 location. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
812 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
813 @menu |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
814 * ARCHIVE tag:: Marking a tree as inactive |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
815 * Moving subtrees:: Moving a tree to an archive file |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
816 @end menu |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
817 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
818 @node ARCHIVE tag, Moving subtrees, Archiving, Archiving |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
819 @subsection The ARCHIVE tag |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
820 @cindex internal archiving |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
821 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
822 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
823 its location in the outline tree, but behaves in the following way: |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
824 @itemize @minus |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
825 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
826 It does not open when you attempt to do so with a visibility cycling |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
827 command (@pxref{Visibility cycling}). You can force cycling archived |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
828 subtrees with @kbd{C-@key{TAB}}, or by setting the option |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
829 @code{org-cycle-open-archived-trees}. Also normal outline commands like |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
830 @code{show-all} will open archived subtrees. |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
831 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
832 During sparse tree construction (@pxref{Sparse trees}), matches in |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
833 archived subtrees are not exposed, unless you configure the option |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
834 @code{org-sparse-tree-open-archived-trees}. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
835 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
836 During agenda view construction (@pxref{Agenda views}), the content of |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
837 archived trees is ignored unless you configure the option |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
838 @code{org-agenda-skip-archived-trees}. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
839 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
840 Archived trees are not exported (@pxref{Exporting}), only the headline |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
841 is. Configure the details using the variable |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
842 @code{org-export-with-archived-trees}. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
843 @end itemize |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
844 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
845 The following commands help managing the ARCHIVE tag: |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
846 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
847 @table @kbd |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
848 @kindex C-c C-x C-a |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
849 @item C-c C-x C-a |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
850 Toggle the ARCHIVE tag for the current headline. When the tag is set, |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
851 the headline changes to a shadowish face, and the subtree below it is |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
852 hidden. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
853 @kindex C-u C-c C-x C-a |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
854 @item C-u C-c C-x C-a |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
855 Check if any direct children of the current headline should be archived. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
856 To do this, each subtree is checked for open TODO entries. If none are |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
857 found, the command offers to set the ARCHIVE tag for the child. If the |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
858 cursor is @emph{not} on a headline when this command is invoked, the |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
859 level 1 trees will be checked. |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
860 @kindex C-@kbd{TAB} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
861 @item C-@kbd{TAB} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
862 Cycle a tree even if it is tagged with ARCHIVE. |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
863 @end table |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
864 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
865 @node Moving subtrees, , ARCHIVE tag, Archiving |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
866 @subsection Moving subtrees |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
867 @cindex external archiving |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
868 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
869 Once an entire project is finished, you may want to move it to a |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
870 different location, either in the current file, or even in a different |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
871 file, the archive file. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
872 |
63362 | 873 @table @kbd |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
874 @kindex C-c C-x C-s |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
875 @item C-c C-x C-s |
63362 | 876 Archive the subtree starting at the cursor position to the location |
877 given by @code{org-archive-location}. | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
878 @kindex C-u C-c C-x C-s |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
879 @item C-u C-c C-x C-s |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
880 Check if any direct children of the current headline could be moved to |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
881 the archive. To do this, each subtree is checked for open TODO entries. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
882 If none are found, the command offers to move it to the archive |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
883 location. If the cursor is @emph{not} on a headline when this command |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
884 is invoked, the level 1 trees will be checked. |
63362 | 885 @end table |
886 | |
887 @cindex archive locations | |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
888 The default archive location is a file in the same directory as the |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
889 current file, with the name derived by appending @file{_archive} to the |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
890 current file name. For information and examples on how to change this, |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
891 see the documentation string of the variable |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
892 @code{org-archive-location}. There is also an in-buffer option for |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
893 setting this variable, for example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
894 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
895 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
896 #+ARCHIVE: %s_done:: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
897 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
898 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
899 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
900 You may have several such lines in the buffer, they will then be valid |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
901 for the entries following the line (the first will also apply to any |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
902 text before it). |
63362 | 903 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
904 @node Sparse trees, Plain lists, Archiving, Document structure |
58792 | 905 @section Sparse trees |
906 @cindex sparse trees | |
907 @cindex trees, sparse | |
908 @cindex folding, sparse trees | |
909 @cindex occur, command | |
910 | |
911 An important feature of Org-mode is the ability to construct | |
912 @emph{sparse trees} for selected information in an outline tree. A | |
913 sparse tree means that the entire document is folded as much as | |
914 possible, but the selected information is made visible along with the | |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
915 headline structure above it@footnote{See also the variables |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
916 @code{org-show-hierarchy-above}, @code{org-show-following-heading}, and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
917 @code{org-show-siblings} for detailed control on how much context is |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
918 shown around each match.}. Just try it out and you will see immediately |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
919 how it works. |
58792 | 920 |
921 Org-mode contains several commands creating such trees. The most | |
922 basic one is @command{org-occur}: | |
923 | |
924 @table @kbd | |
925 @kindex C-c / | |
926 @item C-c / | |
927 Occur. Prompts for a regexp and shows a sparse tree with all matches. | |
928 If the match is in a headline, the headline is made visible. If the | |
929 match is in the body of an entry, headline and body are made visible. | |
930 In order to provide minimal context, also the full hierarchy of | |
931 headlines above the match is shown, as well as the headline following | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
932 the match. Each match is also highlighted; the highlights disappear |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
933 when the buffer is changes an editing command, or by pressing @kbd{C-c |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
934 C-c}. When called with a @kbd{C-u} prefix argument, previous highlights |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
935 are kept, so several calls to this command can be stacked. |
58792 | 936 @end table |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
937 @noindent |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
938 For frequently used sparse trees of specific search strings, you can |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
939 use the variable @code{org-agenda-custom-commands} to define fast |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
940 keyboard access to specific sparse trees. These commands will then be |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
941 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}). |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
942 For example: |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
943 |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
944 @lisp |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
945 (setq org-agenda-custom-commands |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
946 '(("f" occur-tree "FIXME"))) |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
947 @end lisp |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
948 |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
949 @noindent will define the key @kbd{C-c a f} as a shortcut for creating |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
950 a sparse tree matching the string @samp{FIXME}. |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
951 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
952 Other commands use sparse trees as well. For example @kbd{C-c |
58792 | 953 C-v} creates a sparse TODO tree (@pxref{TODO basics}). |
954 | |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
955 @kindex C-c C-e v |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
956 @cindex printing sparse trees |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
957 @cindex visible text, printing |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
958 To print a sparse tree, you can use the Emacs command |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
959 @code{ps-print-buffer-with-faces} which does not print invisible parts |
63833 | 960 of the document @footnote{This does not work under XEmacs, because |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
961 XEmacs uses selective display for outlining, not text properties.}. |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
962 Or you can use the command @kbd{C-c C-e v} to export only the visible |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
963 part of the document and print the resulting file. |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
964 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
965 @node Plain lists, , Sparse trees, Document structure |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
966 @section Plain lists |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
967 @cindex plain lists |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
968 @cindex lists, plain |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
969 @cindex lists, ordered |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
970 @cindex ordered lists |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
971 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
972 Within an entry of the outline tree, hand-formatted lists can provide |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
973 additional structure. They also provide a way to create lists of |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
974 checkboxes (@pxref{Checkboxes}). Org-mode supports editing such lists, |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
975 and the HTML exporter (@pxref{Exporting}) does parse and format them. |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
976 |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
977 Org-mode knows ordered and unordered lists. Unordered list items start |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
978 with @samp{-}, @samp{+}, or @samp{*}@footnote{When using @samp{*} as a |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
979 bullet, lines must be indented or they will be seen as top-level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
980 headlines. Also, when you are hiding leading stars to get a clean |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
981 outline view, plain list items starting with a star are visually |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
982 indistinguishable from true headlines. In short: even though @samp{*} |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
983 is supported, it may be better not to use it for plain list items} as |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
984 bullets. Ordered list items start with @samp{1.} or @samp{1)}. Items |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
985 belonging to the same list must have the same indentation on the first |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
986 line. In particular, if an ordered list reaches number @samp{10.}, then |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
987 the 2--digit numbers must be written left-aligned with the other numbers |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
988 in the list. Indentation also determines the end of a list item. It |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
989 ends before the next line that is indented like the bullet/number, or |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
990 less. For example: |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
991 |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
992 @example |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
993 @group |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
994 ** Lord of the Rings |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
995 My favorite scenes are (in this order) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
996 1. The attack of the Rohirrim |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
997 2. Eowyns fight with the witch king |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
998 + this was already my favorite scene in the book |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
999 + I really like Miranda Otto. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1000 3. Peter Jackson being shot by Legolas |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1001 - on DVD only |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1002 He makes a really funny face when it happens. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1003 But in the end, not individual scenes matter but the film as a whole. |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1004 @end group |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1005 @end example |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1006 |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
1007 Org-mode supports these lists by tuning filling and wrapping commands to |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
1008 deal with them correctly@footnote{Org-mode only changes the filling |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
1009 settings for Emacs. For XEmacs, you should use Kyle E. Jones' |
74030 | 1010 @file{filladapt.el}. To turn this on, put into @file{.emacs}: |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
1011 @example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
1012 (require 'filladapt) |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
1013 @end example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
1014 }. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1015 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1016 The following commands act on items when the cursor is in the first line |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1017 of an item (the line with the bullet or number). |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1018 |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1019 @table @kbd |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1020 @kindex @key{TAB} |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1021 @item @key{TAB} |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1022 Items can be folded just like headline levels if you set the variable |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1023 @code{org-cycle-include-plain-lists}. The level of an item is then |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1024 given by the indentation of the bullet/number. Items are always |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1025 subordinate to real headlines, however; the hierarchies remain |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1026 completely separated. |
67382
62adeda8b0dd
Structure editing): DOcument new fucntionality of
Carsten Dominik <dominik@science.uva.nl>
parents:
67353
diff
changeset
|
1027 @kindex M-@key{RET} |
62adeda8b0dd
Structure editing): DOcument new fucntionality of
Carsten Dominik <dominik@science.uva.nl>
parents:
67353
diff
changeset
|
1028 @item M-@key{RET} |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
1029 Insert new item at current level. With prefix arg, force a new heading |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
1030 (@pxref{Structure editing}). If this command is used in the middle of a |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
1031 line, the line is @emph{split} and the rest of the line becomes the new |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
1032 item. If this command is executed in the @emph{whitespace before a bullet or |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
1033 number}, the new item is created @emph{before} the current item. If the |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
1034 command is executed in the white space before the text that is part of |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
1035 an item but does not contain the bullet, a bullet is added to the |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
1036 current line. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1037 @kindex M-S-@key{RET} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1038 @item M-S-@key{RET} |
71525
f3876738c127
(Checkboxes): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71508
diff
changeset
|
1039 Insert a new item with a checkbox (@pxref{Checkboxes}). |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1040 @kindex S-@key{up} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1041 @kindex S-@key{down} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1042 @item S-@key{up} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1043 @itemx S-@key{down} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1044 Jump to the previous/next item in the current list. |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1045 @kindex M-S-@key{up} |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1046 @kindex M-S-@key{down} |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1047 @item M-S-@key{up} |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1048 @itemx M-S-@key{down} |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1049 Move the item including subitems up/down (swap with previous/next item |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1050 of same indentation). If the list is ordered, renumbering is |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1051 automatic. |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1052 @kindex M-S-@key{left} |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1053 @kindex M-S-@key{right} |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1054 @item M-S-@key{left} |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1055 @itemx M-S-@key{right} |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1056 Decrease/increase the indentation of the item, including subitems. |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1057 Initially, the item tree is selected based on current indentation. |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1058 When these commands are executed several times in direct succession, |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1059 the initially selected region is used, even if the new indentation |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1060 would imply a different hierarchy. To use the new hierarchy, break |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1061 the command chain with a cursor motion or so. |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1062 @kindex C-c C-c |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1063 @item C-c C-c |
71525
f3876738c127
(Checkboxes): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71508
diff
changeset
|
1064 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the |
f3876738c127
(Checkboxes): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71508
diff
changeset
|
1065 state of the checkbox. Otherwise, if this is an ordered list, renumber |
f3876738c127
(Checkboxes): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71508
diff
changeset
|
1066 the ordered list at the cursor. |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1067 @end table |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1068 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
1069 @node Tables, Hyperlinks, Document structure, Top |
58792 | 1070 @chapter Tables |
1071 @cindex tables | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1072 @cindex editing tables |
58792 | 1073 |
63833 | 1074 Org-mode has a very fast and intuitive table editor built-in. |
1075 Spreadsheet-like calculations are supported in connection with the | |
1076 Emacs @file{calc} package. | |
58792 | 1077 |
1078 @menu | |
1079 * Built-in table editor:: Simple tables | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1080 * Narrow columns:: Stop wasting space in tables |
63833 | 1081 * orgtbl-mode:: The table editor as minor mode |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1082 * The spreadsheet:: The table editor has spreadsheet capabilities. |
58792 | 1083 @end menu |
1084 | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1085 @node Built-in table editor, Narrow columns, Tables, Tables |
58792 | 1086 @section The built-in table editor |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1087 @cindex table editor, built-in |
58792 | 1088 |
1089 Org-mode makes it easy to format tables in plain ASCII. Any line with | |
1090 @samp{|} as the first non-white character is considered part of a | |
1091 table. @samp{|} is also the column separator. A table might look | |
1092 like this: | |
1093 | |
1094 @example | |
1095 | Name | Phone | Age | | |
1096 |-------+-------+-----| | |
1097 | Peter | 1234 | 17 | | |
1098 | Anna | 4321 | 25 | | |
1099 @end example | |
1100 | |
1101 A table is re-aligned automatically each time you press @key{TAB} or | |
63833 | 1102 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to |
1103 the next field (@key{RET} to the next row) and creates new table rows | |
1104 at the end of the table or before horizontal lines. The indentation | |
1105 of the table is set by the first line. Any line starting with | |
1106 @samp{|-} is considered as a horizontal separator line and will be | |
1107 expanded on the next re-align to span the whole table width. So, to | |
1108 create the above table, you would only type | |
58792 | 1109 |
1110 @example | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1111 |Name|Phone|Age| |
58792 | 1112 |- |
1113 @end example | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1114 |
58792 | 1115 @noindent and then press @key{TAB} to align the table and start filling in |
1116 fields. | |
1117 | |
65656 | 1118 When typing text into a field, Org-mode treats @key{DEL}, |
1119 @key{Backspace}, and all character keys in a special way, so that | |
1120 inserting and deleting avoids shifting other fields. Also, when | |
1121 typing @emph{immediately after the cursor was moved into a new field | |
1122 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the | |
1123 field is automatically made blank. If this behavior is too | |
1124 unpredictable for you, configure the variables | |
1125 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}. | |
1126 | |
58792 | 1127 @table @kbd |
1128 @tsubheading{Creation and conversion} | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1129 @kindex C-c | |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1130 @item C-c | |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1131 Convert the active region to table. If every line contains at least one |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1132 TAB character, the function assumes that the material is tab separated. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1133 If not, lines are split at whitespace into fields. You can use a prefix |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
1134 argument to indicate the minimum number of consecutive spaces required |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
1135 to identify a field separator (default: just one).@* |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1136 If there is no active region, this command creates an empty Org-mode |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1137 table. But it's easier just to start typing, like |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1138 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}. |
58792 | 1139 |
1140 @tsubheading{Re-aligning and field motion} | |
1141 @kindex C-c C-c | |
1142 @item C-c C-c | |
1143 Re-align the table without moving the cursor. | |
1144 | |
1145 @kindex @key{TAB} | |
1146 @item @key{TAB} | |
1147 Re-align the table, move to the next field. Creates a new row if | |
1148 necessary. | |
1149 | |
1150 @kindex S-@key{TAB} | |
1151 @item S-@key{TAB} | |
63833 | 1152 Re-align, move to previous field. |
58792 | 1153 |
1154 @kindex @key{RET} | |
1155 @item @key{RET} | |
1156 Re-align the table and move down to next row. Creates a new row if | |
1157 necessary. At the beginning or end of a line, @key{RET} still does | |
1158 NEWLINE, so it can be used to split a table. | |
1159 | |
1160 @tsubheading{Column and row editing} | |
1161 @kindex M-@key{left} | |
1162 @kindex M-@key{right} | |
1163 @item M-@key{left} | |
1164 @itemx M-@key{right} | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1165 Move the current column left/right. |
58792 | 1166 |
1167 @kindex M-S-@key{left} | |
1168 @item M-S-@key{left} | |
1169 Kill the current column. | |
1170 | |
1171 @kindex M-S-@key{right} | |
1172 @item M-S-@key{right} | |
1173 Insert a new column to the left of the cursor position. | |
1174 | |
1175 @kindex M-@key{up} | |
1176 @kindex M-@key{down} | |
1177 @item M-@key{up} | |
1178 @itemx M-@key{down} | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1179 Move the current row up/down. |
58792 | 1180 |
1181 @kindex M-S-@key{up} | |
1182 @item M-S-@key{up} | |
1183 Kill the current row or horizontal line. | |
1184 | |
1185 @kindex M-S-@key{down} | |
1186 @item M-S-@key{down} | |
1187 Insert a new row above (with arg: below) the current row. | |
1188 | |
1189 @kindex C-c - | |
1190 @item C-c - | |
63833 | 1191 Insert a horizontal line below current row. With prefix arg, the line |
1192 is created above the current line. | |
58792 | 1193 |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
1194 @kindex C-c ^ |
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
1195 @item C-c ^ |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1196 Sort the table lines in the region. The position of point indicates the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1197 column to be used for sorting, and the range of lines is the range |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1198 between the nearest horizontal separator lines, or the entire table. If |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1199 point is before the first column, you will be prompted for the sorting |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1200 column. If there is an active region, the mark specifies the first line |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1201 and the sorting column, while point should be in the last line to be |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1202 included into the sorting. The command prompts for the sorting type |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1203 (alphabetically, numerically, or by time). When called with a prefix |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1204 argument, alphabetic sorting will be case-sensitive. |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
1205 |
58792 | 1206 @tsubheading{Regions} |
65656 | 1207 @kindex C-c C-x M-w |
1208 @item C-c C-x M-w | |
63833 | 1209 Copy a rectangular region from a table to a special clipboard. Point |
58792 | 1210 and mark determine edge fields of the rectangle. The process ignores |
1211 horizontal separator lines. | |
65656 | 1212 @kindex C-c C-x C-w |
1213 @item C-c C-x C-w | |
63833 | 1214 Copy a rectangular region from a table to a special clipboard, and |
1215 blank all fields in the rectangle. So this is the ``cut'' operation. | |
65656 | 1216 @kindex C-c C-x C-y |
1217 @item C-c C-x C-y | |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
1218 Paste a rectangular region into a table. |
58792 | 1219 The upper right corner ends up in the current field. All involved fields |
1220 will be overwritten. If the rectangle does not fit into the present table, | |
1221 the table is enlarged as needed. The process ignores horizontal separator | |
1222 lines. | |
1223 @kindex C-c C-q | |
1224 @item C-c C-q | |
1225 Wrap several fields in a column like a paragraph. If there is an active | |
1226 region, and both point and mark are in the same column, the text in the | |
1227 column is wrapped to minimum width for the given number of lines. A | |
1228 prefix ARG may be used to change the number of desired lines. If there | |
1229 is no region, the current field is split at the cursor position and the | |
1230 text fragment to the right of the cursor is prepended to the field one | |
1231 line down. If there is no region, but you specify a prefix ARG, the | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1232 current field is made blank, and the content is appended to the field |
58792 | 1233 above. |
1234 | |
1235 @tsubheading{Calculations} | |
63833 | 1236 @cindex formula, in tables |
1237 @cindex calculations, in tables | |
58792 | 1238 |
1239 @cindex region, active | |
1240 @cindex active region | |
1241 @cindex transient-mark-mode | |
1242 @kindex C-c + | |
1243 @item C-c + | |
1244 Sum the numbers in the current column, or in the rectangle defined by | |
63833 | 1245 the active region. The result is shown in the echo area and can |
58792 | 1246 be inserted with @kbd{C-y}. |
1247 | |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
1248 @kindex S-@key{RET} |
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
1249 @item S-@key{RET} |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
1250 When current field is empty, copy from first non-empty field above. |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
1251 When not empty, copy current field down to next row and move cursor |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
1252 along with it. Depending on the variable |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
1253 @code{org-table-copy-increment}, integer field values will be |
63362 | 1254 incremented during copy. This key is also used by CUA-mode |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1255 (@pxref{Cooperation}). |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
1256 |
58792 | 1257 @tsubheading{Miscellaneous} |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1258 @kindex C-c ` |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1259 @item C-c ` |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1260 Edit the current field in a separate window. This is useful for fields |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1261 that are not fully visible (@pxref{Narrow columns}). When called with a |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1262 @kbd{C-u} prefix, just make the full field visible, so that it can be |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1263 edited in place. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1264 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1265 @kindex C-c @key{TAB} |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1266 @item C-c @key{TAB} |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1267 This is an alias for @kbd{C-u C-c `} to make the current field fully |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1268 visible. |
58792 | 1269 |
1270 @item M-x org-table-import | |
1271 Import a file as a table. The table should be TAB- or whitespace | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1272 separated. Useful, for example, to import an Excel table or data from a |
58792 | 1273 database, because these programs generally can write TAB-separated text |
1274 files. This command works by inserting the file into the buffer and | |
1275 then converting the region to a table. Any prefix argument is passed on | |
1276 to the converter, which uses it to determine the separator. | |
1277 | |
1278 @item M-x org-table-export | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1279 Export the table as a TAB-separated file. Useful for data exchange with, |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1280 for example, Excel or database programs. |
58792 | 1281 |
1282 @end table | |
1283 | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1284 If you don't like the automatic table editor because it gets in your |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1285 way on lines which you would like to start with @samp{|}, you can turn |
58792 | 1286 it off with |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1287 |
58792 | 1288 @lisp |
1289 (setq org-enable-table-editor nil) | |
1290 @end lisp | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1291 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1292 @noindent Then the only table command that still works is |
58792 | 1293 @kbd{C-c C-c} to do a manual re-align. |
1294 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1295 @node Narrow columns, orgtbl-mode, Built-in table editor, Tables |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1296 @section Narrow columns |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1297 @cindex narrow columns in tables |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1298 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1299 The width of columns is automatically determined by the table editor. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1300 Sometimes a single field or a few fields need to carry more text, |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
1301 leading to inconveniently wide columns. To limit@footnote{This feature |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1302 does not work on XEmacs.} the width of a column, one field anywhere in |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1303 the column may contain just the string @samp{<N>} where @samp{N} is an |
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1304 integer specifying the width of the column in characters. The next |
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1305 re-align will then set the width of this column to no more than this |
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1306 value. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1307 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1308 @example |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1309 @group |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1310 |---+------------------------------| |---+--------| |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1311 | | | | | <6> | |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1312 | 1 | one | | 1 | one | |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1313 | 2 | two | ----\ | 2 | two | |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1314 | 3 | This is a long chunk of text | ----/ | 3 | This=> | |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1315 | 4 | four | | 4 | four | |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1316 |---+------------------------------| |---+--------| |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1317 @end group |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1318 @end example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1319 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1320 @noindent |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1321 Fields that are wider become clipped and end in the string @samp{=>}. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1322 Note that the full text is still in the buffer, it is only invisible. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1323 To see the full text, hold the mouse over the field - a tooltip window |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1324 will show the full content. To edit such a field, use the command |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1325 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1326 open a new window with the full field. Edit it and finish with @kbd{C-c |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1327 C-c}. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1328 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1329 When visiting a file containing a table with narrowed columns, the |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1330 necessary character hiding has not yet happened, and the table needs to |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1331 be aligned before it looks nice. Setting the option |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1332 @code{org-startup-align-all-tables} will realign all tables in a file |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1333 upon visiting, but also slow down startup. You can also set this option |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1334 on a per-file basis with: |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1335 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1336 @example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1337 #+STARTUP: align |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1338 #+STARTUP: noalign |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1339 @end example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1340 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1341 @node orgtbl-mode, The spreadsheet, Narrow columns, Tables |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1342 @section The Orgtbl minor mode |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1343 @cindex orgtbl-mode |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1344 @cindex minor mode for tables |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1345 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1346 If you like the intuitive way the Org-mode table editor works, you |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1347 might also want to use it in other modes like text-mode or mail-mode. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1348 The minor mode Orgtbl-mode makes this possible. You can always toggle |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1349 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1350 example in mail mode, use |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1351 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1352 @lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1353 (add-hook 'mail-mode-hook 'turn-on-orgtbl) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1354 @end lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1355 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1356 Furthermore, with some special setup, it is possible to maintain tables |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1357 in arbitrary syntax with Orgtbl-mode. For example, it is possible to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1358 construct LaTeX tables with the underlying ease and power of |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1359 Orgtbl-mode, including spreadsheet capabulities. For details, see |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1360 @ref{Tables in arbitrary syntax}. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1361 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1362 @node The spreadsheet, , orgtbl-mode, Tables |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1363 @section The spreadsheet |
63833 | 1364 @cindex calculations, in tables |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1365 @cindex spreadsheet capabilities |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1366 @cindex @file{calc} package |
63833 | 1367 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1368 The table editor makes use of the Emacs @file{calc} package to implement |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1369 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1370 derive fields from other fields. |
63833 | 1371 @menu |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1372 * References:: How to refer to another field or range |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1373 * Formula syntax for Calc:: Using Calc to compute stuff |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1374 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1375 * Field formulas:: Formulas valid for a single field |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1376 * Column formulas:: Formulas valid for an entire column |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1377 * Editing and debugging formulas:: Fixing formulas |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1378 * Updating the table:: Recomputing all dependent fields |
64517 | 1379 * Advanced features:: Field names, parameters and automatic recalc |
63833 | 1380 @end menu |
1381 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1382 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1383 @subsection References |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1384 @cindex references |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1385 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1386 To compute fields in the table from other fields, formulas must |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1387 reference other fields or ranges. In Org-mode, fields can be referenced |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1388 by name, by absolute coordinates, and by relative coordinates. To find |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1389 out what the coordinates of a field are, press @kbd{C-c ?} in that |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1390 field. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1391 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1392 @subsubheading Field references |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1393 @cindex field references |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1394 @cindex references, to fields |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1395 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1396 Formulas can reference the value of another field with the operator |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1397 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1398 @@row$column |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1399 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1400 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1401 Column references can be absolute like @samp{1}, @samp{2},...@samp{N}, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1402 or relative to the current column like @samp{+1} or @samp{-2}. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1403 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1404 The row specification only counts data lines and ignores horizontal |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1405 separator lines (hlines). You can use absolute row numbers |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1406 @samp{1}...@samp{N}, and row numbers relative to the current row like |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1407 @samp{+3} or @samp{-1}. Or specify the row relative to one of the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1408 hlines: @samp{I} refers to the first hline, @samp{II} to the second etc. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1409 @samp{-I} refers to the first such line above the current line, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1410 @samp{+I} to the first such line below the current line. You can also |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1411 write @samp{III+2} which is the second data line after the third hline |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1412 in the table. Relative row numbers like @samp{-3} will not cross hlines |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1413 if the current line is too close to the hline. Instead, the value |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1414 directly at the hline is used. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1415 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1416 @samp{0} refers to the current row and column. Also, if you omit |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1417 either the column or the row part of the reference, the current |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1418 row/column is implied. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1419 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1420 Org-mode's references with @emph{positive} numbers correspond to fixed |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1421 references in other spreadsheet programs. For example, @code{@@3$28} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1422 corresponds to @code{$AB$3}. Org-mode's references with @emph{negative} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1423 numbers behave similar to non-fixed references in other spreadsheet |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1424 programs, because when the same formula is used in several fields, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1425 different fields are referenced each time. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1426 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1427 Here are a few examples: |
64517 | 1428 |
1429 @example | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1430 @@2$3 @r{2nd row, 3rd column} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1431 $5 @r{column 5 in the current row} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1432 @@2 @r{current column, row 2} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1433 @@-1$-3 @r{the field one row up, three columns to the left} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1434 @@-I$2 @r{field just under hline above current row, column 2} |
64517 | 1435 @end example |
1436 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1437 @subsubheading Range references |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1438 @cindex range references |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1439 @cindex references, to ranges |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1440 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1441 You may reference a rectangular range of fields by specifying two field |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1442 references connected by two dots @samp{..}. If both fields are in the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1443 current row, you may simply use @samp{$2..$7}, but if at least one field |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1444 is in a different row, you need to use the general @code{@@row$column} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1445 format at least for the first field (i.e the reference must start with |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1446 @samp{@@} in order to be interpreted correctly). Examples: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1447 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1448 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1449 $1..$3 @r{First three fields in the current row.} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1450 $P..$Q @r{Range, using column names (see under Advanced)} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1451 @@2$1..@@4$3 @r{6 fields between these two fields.} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1452 @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1453 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1454 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1455 @noindent Range references return a vector of values that can be fed |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1456 into Calc vector functions. Empty fields in ranges are normally |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1457 suppressed, so that the vector contains only the non-empty fields (but |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1458 see the @samp{E} mode switch below). If there are no non-empty fields, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1459 @samp{[0]} is returned to avoid syntax errors in formulas. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1460 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1461 @subsubheading Named references |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1462 @cindex named references |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1463 @cindex references, named |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1464 @cindex name, of column or field |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1465 @cindex constants, in calculations |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1466 |
64517 | 1467 @samp{$name} is interpreted as the name of a column, parameter or |
1468 constant. Constants are defined globally through the variable | |
1469 @code{org-table-formula-constants}. If you have the | |
63833 | 1470 @file{constants.el} package, it will also be used to resolve |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
1471 constants, including natural constants like @samp{$h} for Planck's |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1472 constant, and units like @samp{$km} for kilometers. Column names and |
63833 | 1473 parameters can be specified in special table lines. These are |
64517 | 1474 described below, see @ref{Advanced features}. |
63833 | 1475 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1476 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1477 @subsection Formula syntax for Calc |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1478 @cindex formula syntax, Calc |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1479 @cindex syntax, of formulas |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1480 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1481 A formula can be any algebraic expression understood by the Emacs |
77203
bcc16ff22a34
(Formula syntax for Calc): Emphasize the operator precedence in Calc.
Carsten Dominik <dominik@science.uva.nl>
parents:
76138
diff
changeset
|
1482 @file{Calc} package. @b{Note that @file{calc} has the |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1483 non-standard convention that @samp{/} has lower precedence than |
77203
bcc16ff22a34
(Formula syntax for Calc): Emphasize the operator precedence in Calc.
Carsten Dominik <dominik@science.uva.nl>
parents:
76138
diff
changeset
|
1484 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1485 evaluation by @code{calc-eval} (@pxref{Calling Calc from |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1486 Your Programs,calc-eval,Calling calc from Your Lisp Programs,calc,GNU |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1487 Emacs Calc Manual}), |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1488 variable substitution takes place according to the rules described above. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1489 @cindex vectors, in table calculations |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1490 The range vectors can be directly fed into the calc vector functions |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1491 like @samp{vmean} and @samp{vsum}. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1492 |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1493 @cindex format specifier |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1494 @cindex mode, for @file{calc} |
63833 | 1495 A formula can contain an optional mode string after a semicolon. This |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1496 string consists of flags to influence Calc and other modes during |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1497 execution. By default, Org-mode uses the standard calc modes (precision |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1498 12, angular units degrees, fraction and symbolic modes off. The display |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1499 format, however, has been changed to @code{(float 5)} to keep tables |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1500 compact. The default settings can be configured using the variable |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1501 @code{org-calc-default-modes}. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1502 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1503 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1504 p20 @r{switch the internal precision to 20 digits} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1505 n3 s3 e2 f4 @r{normal, scientific, engineering, or fixed display format} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1506 D R @r{angle modes: degrees, radians} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1507 F S @r{fraction and symbolic modes} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1508 N @r{interpret all fields as numbers, use 0 for non-numbers} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1509 T @r{force text interpretation} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1510 E @r{keep empty fields in ranges} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1511 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1512 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1513 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1514 In addition, you may provide a @code{printf} format specifier to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1515 reformat the final result. A few examples: |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1516 |
63833 | 1517 @example |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1518 $1+$2 @r{Sum of first and second field} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1519 $1+$2;%.2f @r{Same, format result to two decimals} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1520 exp($2)+exp($1) @r{Math functions can be used} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1521 $;%.1f @r{Reformat current cell to 1 decimal} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1522 ($3-32)*5/9 @r{Degrees F -> C conversion} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1523 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1524 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1525 sin($1);Dp3%.1e @r{Same, but use printf specifier for display} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1526 vmean($2..$7) @r{Compute column range mean, using vector function} |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1527 vmean($2..$7);EN @r{Same, but treat empty fields as 0} |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1528 taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree} |
63833 | 1529 @end example |
1530 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1531 @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1532 @subsection Emacs Lisp forms as formulas |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1533 @cindex Lisp forms, as table formulas |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1534 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1535 It is also possible to write a formula in Emacs Lisp; this can be useful |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1536 for string manipulation and control structures. If a formula starts |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1537 with a single quote followed by an opening parenthesis, then it is |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1538 evaluated as a lisp form. The evaluation should return either a string |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1539 or a number. Just as with @file{calc} formulas, you can specify modes |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1540 and a printf format after a semicolon. A reference will be replaced |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1541 with a string (in double quotes) containing the field. If you provide |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1542 the @samp{N} mode switch, all referenced elements will be numbers. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1543 Ranges are inserted as space-separated fields, so you can embed them in |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1544 list or vector syntax. A few examples, note how the @samp{N} mode is |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1545 used when we do computations in lisp. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1546 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1547 @example |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1548 @r{Swap the first two characters of the content of column 1} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1549 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2)) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1550 @r{Add columns 1 and 2, equivalent to the Calc's @code{$1+$2}} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1551 '(+ $1 $2);N |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1552 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1553 '(apply '+ '($1..$4));N |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1554 @end example |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1555 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1556 @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1557 @subsection Field formulas |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1558 @cindex field formula |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1559 @cindex formula, for individual table field |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1560 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1561 To assign a formula to a particular field, type it directly into the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1562 field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1563 press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1564 the field, the formula will be stored as the formula for this field, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1565 evaluated, and the current field replaced with the result. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1566 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1567 Formulas are stored in a special line starting with @samp{#+TBLFM:} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1568 directly below the table. If you typed the equation in the 4th field of |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1569 the 3rd data line in the table, the formula will look like |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1570 @samp{@@3$2=$1+$2}. When inserting/deleting/swapping column and rows |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1571 with the appropriate commands, @i{absolute references} (but not relative |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1572 ones) in stored formulas are modified in order to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1573 still reference the same field. Of cause this is not true if you edit |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1574 the table structure with normal editing commands - then you must go and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1575 fix equations yourself. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1576 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1577 Instead of typing an equation into the field, you may also use the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1578 following command |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1579 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1580 @table @kbd |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1581 @kindex C-u C-c = |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1582 @item C-u C-c = |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1583 Install a new formula for the current field. The command prompts for a |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1584 formula, with default taken from the @samp{#+TBLFM:} line, applies |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1585 it to the current field and stores it. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1586 @end table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1587 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1588 @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet |
64517 | 1589 @subsection Column formulas |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1590 @cindex column formula |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1591 @cindex formula, for table column |
63833 | 1592 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1593 Often in a table, the same formula should be used for all fields in a |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1594 particular column. Instead of having to copy the formula to all fields |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1595 in that column, org-mode allows to assign a single formula to an entire |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1596 column. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1597 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1598 To assign a formula to a column, type it directly into any field in the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1599 column, preceded by an equal sign, like @samp{=$1+$2}. When you press |
63833 | 1600 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1601 field, the formula will be stored as the formula for the current column, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1602 evaluated and the current field replaced with the result. If the field |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1603 contains only @samp{=}, the previously stored formula for this column is |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1604 used. For each column, Org-mode will only remember the most recently |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1605 used formula. In the @samp{TBLFM:} line, column formulas will look like |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1606 @samp{$4=$1+$2}. |
63833 | 1607 |
1608 Instead of typing an equation into the field, you may also use the | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1609 following command: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1610 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1611 @table @kbd |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1612 @kindex C-c = |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1613 @item C-c = |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1614 Install a new formula for the current column and replace current field |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1615 with the result of the formula. The command prompts for a formula, with |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1616 default taken from the @samp{#+TBLFM} line, applies it to the current |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1617 field and stores it. With a numerical prefix (e.g. @kbd{C-5 C-c =}) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1618 will apply it to that many consecutive fields in the current column. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1619 @end table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1620 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1621 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1622 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1623 @subsection Editing and Debugging formulas |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1624 @cindex formula editing |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1625 @cindex editing, of table formulas |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1626 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1627 You can edit individual formulas in the minibuffer or directly in the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1628 field. Org-mode can also prepare a special buffer with all active |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1629 formulas of a table. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1630 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1631 @table @kbd |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1632 @kindex C-c = |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1633 @kindex C-u C-c = |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1634 @item C-c = |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1635 @itemx C-u C-c = |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1636 Edit the formula associated with the current column/field in the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1637 minibuffer. See @ref{Column formulas} and @ref{Field formulas}. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1638 @kindex C-u C-u C-c = |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1639 @item C-u C-u C-c = |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1640 Re-insert the active formula (either a |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1641 field formula, or a column formula) into the current field, so that you |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1642 can edit it directly in the field. The advantage over editing in the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1643 minibuffer is that you can use the command @kbd{C-c ?}. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1644 @kindex C-c ? |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1645 @item C-c ? |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1646 While editing a formula in a table field, highlight the field(s) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1647 referenced by the reference at the cursor position in the formula. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1648 @kindex C-c ' |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1649 @item C-c ' |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1650 Edit all formulas for the current table in a special buffer, where the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1651 formulas will be displayed one per line. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1652 While inside the special buffer, Org-mode will automatically highlight |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1653 any field or range reference at the cursor position. You may edit, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1654 remove and add formulas, and use the following commands: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1655 @table @kbd |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1656 @kindex C-c C-c |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1657 @item C-c C-c |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1658 Exit the buffer and store the modified formulas. With @kbd{C-u} prefix, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1659 also apply the new formulas to the entire table. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1660 @kindex C-c C-q |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1661 @item C-c C-q |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1662 Exit the buffer without installing changes. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1663 @kindex @key{TAB} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1664 @item @key{TAB} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1665 Pretty-print or indent lisp formula at point. When in a line containing |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1666 a lisp formula, format the formula according to Emacs Lisp rules. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1667 Another @key{TAB} collapses the formula back again. In the open |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1668 formula, @key{TAB} re-indents just like in Emacs-lisp-mode. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1669 @kindex M-@key{TAB} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1670 @item M-@key{TAB} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1671 Complete Lisp symbols, just like in Emacs-lisp-mode. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1672 @kindex S-@key{up} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1673 @kindex S-@key{down} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1674 @item S-@key{up}/@key{down} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1675 Move the reference line in the Org-mode buffer up and down. This is |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1676 important for highlighting the references of column formulas for |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1677 different rows. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1678 @kindex M-@key{up} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1679 @kindex M-@key{down} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1680 @item M-@key{up}/@key{down} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1681 Scroll the window displaying the table. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1682 @end table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1683 @kindex C-c @} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1684 @item C-c @} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1685 Toggle the display of row and column numbers for a table, using |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1686 overlays. These are uptated each time the table is aligned, you can |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1687 force it with @kbd{C-c C-c}. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1688 @kindex C-c @{ |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1689 @item C-c @{ |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1690 Toggle the formula debugger on and off. See below. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1691 @end table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1692 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1693 Making a table field blank does not remove the formula associated with |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1694 the field, because that is stored in a different line (the @samp{TBLFM} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1695 line) - during the next recalculation the field will be filled again. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1696 To remove a formula from a field, you have to give an empty reply when |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1697 prompted for the formula, or to edit the @samp{#+TBLFM} line. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1698 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1699 @kindex C-c C-c |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1700 You may edit the @samp{#+TBLFM} directly and re-apply the changed |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1701 equations with @kbd{C-c C-c} in that line, or with the normal |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1702 recalculation commands in the table. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1703 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1704 @subsubheading Debugging formulas |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1705 @cindex formula debugging |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1706 @cindex debugging, of table formulas |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1707 When the evaluation of a formula leads to an error, the field content |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1708 becomes the string @samp{#ERROR}. If you would like see what is going |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1709 on during variable substitution and calculation in order to find a bug, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1710 turn on formula debugging in the @code{Tbl} menu and repeat the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1711 calculation, for example by pressing @kbd{C-c = @key{RET}} in a field. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1712 Detailed information will be displayed. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1713 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1714 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1715 @subsection Updating the Table |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1716 @cindex recomputing table fields |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1717 @cindex updating, table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1718 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1719 Recalculation of a table is normally not automatic, but needs to be |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1720 triggered by a command. See @ref{Advanced features} for a way to make |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1721 recalculation at least semi-automatically. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1722 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1723 In order to recalculate a line of a table or the entire table, use the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1724 following commands: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1725 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1726 @table @kbd |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1727 @kindex C-c * |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1728 @item C-c * |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1729 Recalculate the current row by first applying the stored column formulas |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1730 from left to right, and all field formulas in the current row. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1731 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1732 @kindex C-u C-c * |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1733 @item C-u C-c * |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1734 @kindex C-u C-c C-c |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1735 @itemx C-u C-c C-c |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1736 Recompute the entire table, line by line. Any lines before the first |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1737 hline are left alone, assuming that these are part of the table header. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1738 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1739 @kindex C-u C-u C-c * |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1740 @item C-u C-u C-c * |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1741 Iterate the table by recomputing it until no further changes occur. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1742 This may be necessary if some computed fields use the value of other |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1743 fields that are computed @i{later} in the calculation sequence. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1744 @end table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1745 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1746 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1747 @node Advanced features, , Updating the table, The spreadsheet |
64517 | 1748 @subsection Advanced features |
1749 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1750 If you want the recalculation of fields to happen automatically, or if |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1751 you want to be able to assign @i{names} to fields and columns, you need |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1752 to reserve the first column of the table for special marking characters. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1753 @table @kbd |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1754 @kindex C-# |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1755 @item C-# |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1756 Rotate the calculation mark in first column through the states @samp{}, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1757 @samp{#}, @samp{*}, @samp{!}, @samp{$}. The meaning of these characters |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1758 is discussed below. When there is an active region, change all marks in |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1759 the region. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1760 @end table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1761 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1762 Here is an example of a table that collects exam results of students and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1763 makes use of these features: |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1764 |
63833 | 1765 @example |
1766 @group | |
1767 |---+---------+--------+--------+--------+-------+------| | |
1768 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note | | |
1769 |---+---------+--------+--------+--------+-------+------| | |
1770 | ! | | P1 | P2 | P3 | Tot | | | |
1771 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 | | |
64069 | 1772 | ^ | | m1 | m2 | m3 | mt | | |
63833 | 1773 |---+---------+--------+--------+--------+-------+------| |
1774 | # | Peter | 10 | 8 | 23 | 41 | 8.2 | | |
64517 | 1775 | # | Sara | 6 | 14 | 19 | 39 | 7.8 | |
63833 | 1776 | # | Sam | 2 | 4 | 3 | 9 | 1.8 | |
1777 |---+---------+--------+--------+--------+-------+------| | |
64517 | 1778 | | Average | | | | 29.7 | | |
1779 | ^ | | | | | at | | | |
63833 | 1780 | $ | max=50 | | | | | | |
1781 |---+---------+--------+--------+--------+-------+------| | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1782 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f |
63833 | 1783 @end group |
1784 @end example | |
64517 | 1785 |
1786 @noindent @b{Important}: Please note that for these special tables, | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1787 recalculating the table with @kbd{C-u C-c *} will only affect rows that |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1788 are marked @samp{#} or @samp{*}, and fields that have a formula assigned |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1789 to the field itself. The column formulas are not applied in rows with |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1790 empty first field. |
64517 | 1791 |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1792 @cindex marking characters, tables |
64517 | 1793 The marking characters have the following meaning: |
1794 @table @samp | |
1795 @item ! | |
1796 The fields in this line define names for the columns, so that you may | |
1797 refer to a column as @samp{$Tot} instead of @samp{$6}. | |
1798 @item ^ | |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
1799 This row defines names for the fields @emph{above} the row. With such |
64517 | 1800 a definition, any formula in the table may use @samp{$m1} to refer to |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1801 the value @samp{10}. Also, if you assign a formula to a names field, it |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1802 will be stored as @samp{$name=...}. |
64517 | 1803 @item _ |
1804 Similar to @samp{^}, but defines names for the fields in the row | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1805 @emph{below}. |
64517 | 1806 @item $ |
1807 Fields in this row can define @emph{parameters} for formulas. For | |
1808 example, if a field in a @samp{$} row contains @samp{max=50}, then | |
1809 formulas in this table can refer to the value 50 using @samp{$max}. | |
1810 Parameters work exactly like constants, only that they can be defined on | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1811 a per-table basis. |
64517 | 1812 @item # |
1813 Fields in this row are automatically recalculated when pressing | |
1814 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row | |
1815 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked | |
1816 lines will be left alone by this command. | |
1817 @item * | |
1818 Selects this line for global recalculation with @kbd{C-u C-c *}, but | |
1819 not for automatic recalculation. Use this when automatic | |
1820 recalculation slows down editing too much. | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1821 @item |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1822 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}. |
64517 | 1823 All lines that should be recalculated should be marked with @samp{#} |
1824 or @samp{*}. | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1825 @item / |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1826 Do not export this line. Useful for lines that contain the narrowing |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1827 @samp{<N>} markers. |
64517 | 1828 @end table |
1829 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1830 Finally, just to whet your appetite on what can be done with the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1831 fantastic @file{calc} package, here is a table that computes the Taylor |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1832 series of degree @code{n} at location @code{x} for a couple of functions |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1833 (homework: try that with Excel :-) |
63833 | 1834 |
1835 @example | |
1836 @group | |
1837 |---+-------------+---+-----+--------------------------------------| | |
1838 | | Func | n | x | Result | | |
1839 |---+-------------+---+-----+--------------------------------------| | |
1840 | # | exp(x) | 1 | x | 1 + x | | |
1841 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 | | |
1842 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 | | |
1843 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 | | |
1844 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 | | |
1845 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 | | |
1846 |---+-------------+---+-----+--------------------------------------| | |
1847 #+TBLFM: $5=taylor($2,$4,$3);n3 | |
1848 @end group | |
1849 @end example | |
1850 | |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1851 @node Hyperlinks, TODO items, Tables, Top |
58792 | 1852 @chapter Hyperlinks |
1853 @cindex hyperlinks | |
1854 | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1855 Just like HTML, Org-mode provides links inside a file, and external |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1856 links to other files, Usenet articles, emails, and much more. |
58792 | 1857 |
1858 @menu | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1859 * Link format:: How links in Org-mode are formatted |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1860 * Internal links:: Links to other places in the current file |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1861 * External links:: URL-like links to the world |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1862 * Handling links:: Creating, inserting and following |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1863 * Link abbreviations:: Shortcuts for writing complex links |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1864 * Search options:: Linking to a specific location |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1865 * Custom searches:: When the default search is not enough |
58792 | 1866 * Remember:: Org-trees store quick notes |
1867 @end menu | |
1868 | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1869 @node Link format, Internal links, Hyperlinks, Hyperlinks |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1870 @section Link format |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1871 @cindex link format |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1872 @cindex format, of links |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1873 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1874 Org-mode will recognize plain URL-like links and activate them as |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1875 clickable links. The general link format, however, looks like this: |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1876 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1877 @example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1878 [[link][description]] @r{or alternatively} [[link]] |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1879 @end example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1880 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1881 Once a link in the buffer is complete (all brackets present), Org-mode |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1882 will change the display so that @samp{description} is displayed instead |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1883 of @samp{[[link][description]]} and @samp{link} is displayed instead of |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1884 @samp{[[link]]}. Links will be highlighted in the face @code{org-link}, |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1885 which by default is an underlined face. You can directly edit the |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1886 visible part of a link. Note that this can be either the @samp{link} |
71098
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
1887 part (if there is no description) or the @samp{description} part. To |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1888 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1889 cursor on the link. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1890 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1891 If you place the cursor at the beginning or just behind the end of the |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1892 displayed text and press @key{BACKSPACE}, you will remove the |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1893 (invisible) bracket at that location. This makes the link incomplete |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1894 and the internals are again displayed as plain text. Inserting the |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1895 missing bracket hides the link internals again. To show the |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1896 internal structure of all links, use the menu entry |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1897 @code{Org->Hyperlinks->Literal links}. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1898 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1899 @node Internal links, External links, Link format, Hyperlinks |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1900 @section Internal links |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1901 @cindex internal links |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1902 @cindex links, internal |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1903 @cindex targets, for links |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1904 |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1905 If the link does not look like a URL, it is considered to be internal in |
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1906 the current file. Links such as @samp{[[My Target]]} or @samp{[[My |
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1907 Target][Find my target]]} lead to a text search in the current file. |
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1908 The link can be followed with @kbd{C-c C-o} when the cursor is on the |
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1909 link, or with a mouse click (@pxref{Handling links}). The preferred |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1910 match for such a link is a dedicated target: the same string in double |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1911 angular brackets. Targets may be located anywhere; sometimes it is |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1912 convenient to put them into a comment line. For example |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1913 |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1914 @example |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1915 # <<My Target>> |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1916 @end example |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1917 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
1918 @noindent In HTML export (@pxref{HTML export}), such targets will become |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1919 named anchors for direct access through @samp{http} links@footnote{Note |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1920 that text before the first headline will never be exported, so the first |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1921 such target must be after the first headline.}. |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
1922 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1923 If no dedicated target exists, Org-mode will search for the words in the |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1924 link. In the above example the search would be for @samp{my target}. |
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1925 Links starting with a star like @samp{*My Target} restrict the search to |
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1926 headlines. When searching, Org-mode will first try an exact match, but |
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1927 then move on to more and more lenient searches. For example, the link |
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1928 @samp{[[*My Targets]]} will find any of the following: |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1929 |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1930 @example |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1931 ** My targets |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1932 ** TODO my targets are bright |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1933 ** my 20 targets are |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1934 @end example |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1935 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1936 To insert a link targeting a headline, in-buffer completion can be used. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1937 Just type a star followed by a few optional letters into the buffer and |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1938 press @kbd{M-@key{TAB}}. All headlines in the current buffer will be |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1939 offered as completions. @xref{Handling links}, for more commands |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1940 creating links. |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1941 |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1942 Following a link pushes a mark onto Org-mode's own mark ring. You can |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1943 return to the previous position with @kbd{C-c &}. Using this command |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1944 several times in direct succession goes back to positions recorded |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1945 earlier. |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1946 |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1947 @menu |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1948 * Radio targets:: Make targets trigger links in plain text. |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1949 @end menu |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1950 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1951 @node Radio targets, , Internal links, Internal links |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1952 @subsection Radio targets |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1953 @cindex radio targets |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1954 @cindex targets, radio |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1955 @cindex links, radio targets |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1956 |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1957 You can configure Org-mode to link any occurrences of certain target |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1958 names in normal text. So without explicitly creating a link, the text |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1959 connects to the target radioing its position. Radio targets are |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1960 enclosed by triple angular brackets. For example, a target |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1961 @samp{<<<My Target>>>} causes each occurrence of @samp{my target} in |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1962 normal text to become activated as a link. The Org-mode file is |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1963 scanned automatically for radio targets only when the file is first |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1964 loaded into Emacs. To update the target list during editing, press |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1965 @kbd{C-c C-c} with the cursor on or at a target. |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1966 |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1967 @node External links, Handling links, Internal links, Hyperlinks |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1968 @section External links |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1969 @cindex links, external |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1970 @cindex external links |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1971 @cindex links, external |
58792 | 1972 @cindex GNUS links |
1973 @cindex BBDB links | |
63833 | 1974 @cindex URL links |
1975 @cindex file links | |
58792 | 1976 @cindex VM links |
1977 @cindex RMAIL links | |
1978 @cindex WANDERLUST links | |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1979 @cindex MH-E links |
58792 | 1980 @cindex USENET links |
1981 @cindex SHELL links | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1982 @cindex Info links |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1983 @cindex elisp links |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1984 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1985 Org-mode supports links to files, websites, Usenet and email messages, |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1986 and BBDB database entries. External links are URL-like locators. They |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1987 start with a short identifying string followed by a colon. There can be |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1988 no space after the colon. The following list shows examples for each |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1989 link type. |
58792 | 1990 |
1991 @example | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1992 http://www.astro.uva.nl/~dominik @r{on the web} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1993 file:/home/dominik/images/jupiter.jpg @r{file, absolute path} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1994 file:papers/last.pdf @r{file, relative path} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1995 news:comp.emacs @r{Usenet link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1996 mailto:adent@@galaxy.net @r{Mail link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1997 vm:folder @r{VM folder link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1998 vm:folder#id @r{VM message link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1999 vm://myself@@some.where.org/folder#id @r{VM on remote machine} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2000 wl:folder @r{WANDERLUST folder link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2001 wl:folder#id @r{WANDERLUST message link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2002 mhe:folder @r{MH-E folder link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2003 mhe:folder#id @r{MH-E message link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2004 rmail:folder @r{RMAIL folder link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2005 rmail:folder#id @r{RMAIL message link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2006 gnus:group @r{GNUS group link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2007 gnus:group#id @r{GNUS article link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2008 bbdb:Richard Stallman @r{BBDB link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2009 shell:ls *.org @r{A shell command} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2010 elisp:(find-file-other-frame "Elisp.org") @r{An elisp form to evaluate} |
58792 | 2011 @end example |
2012 | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2013 A link should be enclosed in double brackets and may contain a |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2014 descriptive text to be displayed instead of the url (@pxref{Link |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2015 format}), for example: |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2016 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2017 @example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2018 [[http://www.gnu.org/software/emacs/][GNU Emacs]] |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2019 @end example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2020 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2021 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2022 If the description is a file name or URL that points to an image, HTML |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2023 export (@pxref{HTML export}) will inline the image as a clickable |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2024 button. If there is no description at all and the link points to an |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2025 image, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2026 that image will be inlined into the exported HTML file. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2027 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2028 @cindex angular brackets, around links |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2029 @cindex plain text external links |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2030 Org-mode also finds external links in the normal text and activates them |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2031 as links. If spaces must be part of the link (for example in |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2032 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2033 about the end of the link, enclose them in angular brackets. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2034 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2035 @node Handling links, Link abbreviations, External links, Hyperlinks |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
2036 @section Handling links |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2037 @cindex links, handling |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2038 |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2039 Org-mode provides methods to create a link in the correct syntax, to |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2040 insert it into an org-mode file, and to follow the link. |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2041 |
58792 | 2042 @table @kbd |
2043 @kindex C-c l | |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2044 @cindex storing links |
58792 | 2045 @item C-c l |
2046 Store a link to the current location. This is a @emph{global} command | |
2047 which can be used in any buffer to create a link. The link will be | |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
2048 stored for later insertion into an Org-mode buffer (see below). For |
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
2049 Org-mode files, if there is a @samp{<<target>>} at the cursor, the link |
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
2050 points to the target. Otherwise it points to the current headline. For |
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
2051 VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers, the link will |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2052 indicate the current article/entry. For W3 and W3M buffers, the link |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
2053 goes to the current URL. For any other files, the link will point to |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2054 the file, with a search string (@pxref{Search options}) pointing to the |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
2055 contents of the current line. If there is an active region, the |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2056 selected words will form the basis of the search string. If the |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2057 automatically created link is not working correctly or accurately |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2058 enough, you can write custom functions to select the search string and |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2059 to do the search for particular file types - see @ref{Custom searches}. |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
2060 The key binding @kbd{C-c l} is only a suggestion - see @ref{Installation}. |
58792 | 2061 |
2062 @kindex C-c C-l | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2063 @cindex link completion |
63833 | 2064 @cindex completion, of links |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2065 @cindex inserting links |
58792 | 2066 @item C-c C-l |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2067 Insert a link. This prompts for a link to be inserted into the buffer. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2068 You can just type a link, using text for an internal link, or one of the |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2069 link type prefixes mentioned in the examples above. All links stored |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2070 during the current session are part of the history for this prompt, so |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2071 you can access them with @key{up} and @key{down}, or with |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2072 completion@footnote{After insertion of a stored link, the link will be |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
2073 removed from the list of stored links. To keep it in the list later |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
2074 use, use a triple @kbd{C-u} prefix to @kbd{C-c C-l}, or configure the |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2075 option @code{org-keep-stored-link-after-insertion}.}. The link will be |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2076 inserted into the buffer, along with a descriptive text. If some text |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2077 was selected when this command is called, the selected text becomes the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2078 default description.@* Note that you don't have to use this command to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2079 insert a link. Links in Org-mode are plain text, and you can type or |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2080 paste them straight into the buffer. By using this command, the links |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2081 are automatically enclosed in double brackets, and you will be asked for |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2082 the optional descriptive text. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2083 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2084 @c If the link is a @samp{file:} link and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2085 @c the linked file is located in the same directory as the current file or |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2086 @c a subdirectory of it, the path of the file will be inserted relative to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2087 @c the current directory. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2088 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2089 @kindex C-u C-c C-l |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2090 @cindex file name completion |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2091 @cindex completion, of file names |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2092 @item C-u C-c C-l |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2093 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2094 a file will be inserted and you may use file name completion to select |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2095 the name of the file. The path to the file is inserted relative to the |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2096 directory of the current org file, if the linked file is in the current |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2097 directory or in a subdirectory of it, or if the path is written relative |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2098 to the current directory using @samp{../}. Otherwise an absolute path |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2099 is used, if possible with @samp{~/} for your home directory. You can |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2100 force an absolute path with two @kbd{C-u} prefixes. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2101 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2102 @item C-c C-l @r{with cursor on existing link} |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2103 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2104 link and description parts of the link. |
58792 | 2105 |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2106 @cindex following links |
58792 | 2107 @kindex C-c C-o |
2108 @item C-c C-o | |
2109 Open link at point. This will launch a web browser for URLs (using | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2110 @command{browse-url-at-point}), run vm/mh-e/wanderlust/rmail/gnus/bbdb |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2111 for the corresponding links, and execute the command in a shell link. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2112 When the cursor is on an internal link, this commands runs the |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2113 corresponding search. When the cursor is on a TAG list in a headline, |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2114 it creates the corresponding TAGS view. If the cursor is on a time |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2115 stamp, it compiles the agenda for that date. Furthermore, it will visit |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
2116 text and remote files in @samp{file:} links with Emacs and select a |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
2117 suitable application for local non-text files. Classification of files |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
2118 is based on file extension only. See option @code{org-file-apps}. If |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
2119 you want to override the default application and visit the file with |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
2120 Emacs, use a @kbd{C-u} prefix. |
58792 | 2121 |
2122 @kindex mouse-2 | |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
2123 @kindex mouse-1 |
58792 | 2124 @item mouse-2 |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
2125 @itemx mouse-1 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2126 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o} |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
2127 would. Under Emacs 22, also @kbd{mouse-1} will follow a link. |
58792 | 2128 |
2129 @kindex mouse-3 | |
2130 @item mouse-3 | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2131 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2132 internal links to be displayed in another window@footnote{See the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2133 variable @code{org-display-internal-link-with-indirect-buffer}}. |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2134 |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2135 @cindex mark ring |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2136 @kindex C-c % |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2137 @item C-c % |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2138 Push the current position onto the mark ring, to be able to return |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2139 easily. Commands following an internal link do this automatically. |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2140 |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2141 @cindex links, returning to |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2142 @kindex C-c & |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2143 @item C-c & |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2144 Jump back to a recorded position. A position is recorded by the |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2145 commands following internal links, and by @kbd{C-c %}. Using this |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2146 command several times in direct succession moves through a ring of |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2147 previously recorded positions. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2148 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2149 @kindex C-c C-x C-n |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2150 @kindex C-c C-x C-p |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2151 @cindex links, finding next/previous |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2152 @item C-c C-x C-n |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2153 @itemx C-c C-x C-p |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2154 Move forward/backward to the next link in the buffer. At the limit of |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2155 the buffer, the search fails once, and then wraps around. The key |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2156 bindings for this are really too long, you might want to bind this also |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2157 to @kbd{C-n} and @kbd{C-p} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2158 @lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2159 (add-hook 'org-load-hook |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2160 (lambda () |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2161 (define-key 'org-mode-map "\C-n" 'org-next-link) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2162 (define-key 'org-mode-map "\C-p" 'org-previous-link))) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2163 @end lisp |
58792 | 2164 @end table |
2165 | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2166 @node Link abbreviations, Search options, Handling links, Hyperlinks |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2167 @section Link abbreviations |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2168 @cindex link abbreviations |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2169 @cindex abbreviation, links |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2170 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2171 Long URLs can be cumbersome to type, and often many similar links are |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2172 needed in a document. For this you can use link abbreviations. An |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2173 abbreviated link looks like this |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2174 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2175 @example |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2176 [[linkword:tag][description]] |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2177 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2178 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2179 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2180 where the tag is optional. Such abbreviations are resolved according to |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2181 the information in the variable @code{org-link-abbrev-alist} that |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2182 relates the linkwords to replacement text. Here is an example: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2183 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2184 @lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2185 @group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2186 (setq org-link-abbrev-alist |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2187 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=") |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2188 ("google" . "http://www.google.com/search?q=") |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2189 ("ads" . "http://adsabs.harvard.edu/cgi-bin/ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2190 nph-abs_connect?author=%s&db_key=AST"))) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2191 @end group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2192 @end lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2193 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2194 If the replacement text contains the string @samp{%s}, it will be |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2195 replaced with the tag. Otherwise the tag will be appended to the string |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2196 in order to create the link. You may also specify a function that will |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2197 be called with the tag as the only argument to create the link. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2198 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2199 With the above setting, you could link to a specific bug with |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2200 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2201 @code{[[google:OrgMode]]} and find out what the Org-mode author is |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2202 doing besides Emacs hacking with @code{[[ads:Dominik,C]]}. |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2203 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2204 If you need special abbreviations just for a single Org-mode buffer, you |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2205 can define them in the file with |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2206 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2207 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2208 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id= |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2209 #+LINK: google http://www.google.com/search?q=%s |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2210 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2211 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2212 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2213 In-buffer completion @pxref{Completion} can be used after @samp{[} to |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2214 complete link abbreviations. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2215 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2216 @node Search options, Custom searches, Link abbreviations, Hyperlinks |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2217 @section Search options in file links |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2218 @cindex search option in file links |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2219 @cindex file links, searching |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2220 |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2221 File links can contain additional information to make Emacs jump to a |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2222 particular location in the file when following a link. This can be a |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2223 line number or a search option after a double@footnote{For backward |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2224 compatibility, line numbers can also follow a single colon.} colon. For |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2225 example, when the command @kbd{C-c l} creates a link (@pxref{Handling |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2226 links}) to a file, it encodes the words in the current line as a search |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2227 string that can be used to find this line back later when following the |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2228 link with @kbd{C-c C-o}. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2229 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2230 Here is the syntax of the different ways to attach a search to a file |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2231 link, together with an explanation: |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2232 |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2233 @example |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2234 [[file:~/code/main.c::255]] |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2235 [[file:~/xx.org::My Target]] |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2236 [[file:~/xx.org::*My Target]] |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2237 [[file:~/xx.org::/regexp/]] |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2238 @end example |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2239 |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2240 @table @code |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2241 @item 255 |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2242 Jump to line 255. |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2243 @item My Target |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2244 Search for a link target @samp{<<My Target>>}, or do a text search for |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2245 @samp{my target}, similar to the search in internal links, see |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2246 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2247 link will become an HTML reference to the corresponding named anchor in |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2248 the linked file. |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2249 @item *My Target |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2250 In an Org-mode file, restrict search to headlines. |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2251 @item /regexp/ |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2252 Do a regular expression search for @code{regexp}. This uses the Emacs |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2253 command @code{occur} to list all matches in a separate window. If the |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2254 target file is in Org-mode, @code{org-occur} is used to create a |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2255 sparse tree with the matches. |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2256 @c If the target file is a directory, |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2257 @c @code{grep} will be used to search all files in the directory. |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2258 @end table |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2259 |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2260 As a degenerate case, a file link with an empty file name can be used |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2261 to search the current file. For example, @code{[[file:::find me]]} does |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2262 a search for @samp{find me} in the current file, just as |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2263 @samp{[[find me]]} would. |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2264 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2265 @node Custom searches, Remember, Search options, Hyperlinks |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2266 @section Custom Searches |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2267 @cindex custom search strings |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2268 @cindex search strings, custom |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2269 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2270 The default mechanism for creating search strings and for doing the |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2271 actual search related to a file link may not work correctly in all |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2272 cases. For example, BibTeX database files have many entries like |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2273 @samp{year="1993"} which would not result in good search strings, |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2274 because the only unique identification for a BibTeX entry is the |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2275 citation key. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2276 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2277 If you come across such a problem, you can write custom functions to set |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2278 the right search string for a particular file type, and to do the search |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2279 for the string in the file. Using @code{add-hook}, these functions need |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2280 to be added to the hook variables |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2281 @code{org-create-file-search-functions} and |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2282 @code{org-execute-file-search-functions}. See the docstring for these |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2283 variables for more information. Org-mode actually uses this mechanism |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2284 for Bib@TeX{} database files, and you can use the corresponding code as |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2285 an implementation example. Search for @samp{BibTeX links} in the source |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2286 file. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2287 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2288 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2289 @node Remember, , Custom searches, Hyperlinks |
58792 | 2290 @section Remember |
2291 @cindex @file{remember.el} | |
2292 | |
2293 Another way to create org entries with links to other files is through | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2294 the @i{remember} package by John Wiegley. @i{Remember} lets you store |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2295 quick notes with little interruption of your work flow. See |
58792 | 2296 @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2297 information. The notes produced by @i{Remember} can be stored in |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2298 different ways, and Org-mode files are a good target. Org-mode |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2299 significantly expands the possibilities of @i{remember}: You may define |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2300 templates for different note types, and to associate target files and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2301 headlines with specific templates. It also allows you to select the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2302 location where a note should be stored interactively, on the fly. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2303 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2304 @menu |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2305 * Setting up remember:: Some code for .emacs to get things going |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2306 * Remember templates:: Define the outline of different note types |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2307 * Storing notes:: Directly get the note to where it belongs |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2308 @end menu |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2309 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2310 @node Setting up remember, Remember templates, Remember, Remember |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2311 @subsection Setting up remember |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2312 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2313 The following customization will tell @i{remember} to use org files as |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2314 target, and to create annotations compatible with Org-mode links. |
64517 | 2315 |
58792 | 2316 @example |
2317 (setq org-directory "~/path/to/my/orgfiles/") | |
2318 (setq org-default-notes-file "~/.notes") | |
2319 (setq remember-annotation-functions '(org-remember-annotation)) | |
2320 (setq remember-handler-functions '(org-remember-handler)) | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2321 (add-hook 'remember-mode-hook 'org-remember-apply-template) |
58792 | 2322 @end example |
2323 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2324 @node Remember templates, Storing notes, Setting up remember, Remember |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2325 @subsection Remember templates |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2326 @cindex templates, for remember |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2327 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2328 In combination with Org-mode, you can use templates to generate |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2329 different types of @i{remember} notes. For example, if you would like |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2330 to use one template to create general TODO entries, another one for |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2331 journal entries, and a third one for collecting random ideas, you could |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2332 use: |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2333 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2334 @example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2335 (setq org-remember-templates |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2336 '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org") |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2337 (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org") |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2338 (?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas"))) |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2339 @end example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2340 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2341 @noindent In these entries, the character specifies how to select the |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2342 template. The first string specifies the template. Two more (optional) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2343 strings give the file in which, and the headline under which the new |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2344 note should be stored. The file defaults to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2345 @code{org-default-notes-file}, the heading to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2346 @code{org-remember-default-headline}. Both defaults help to get to the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2347 storing location quickly, but you can change the location interactively |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2348 while storing the note. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2349 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2350 When you call @kbd{M-x remember} (or @kbd{M-x org-remember}) to remember |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2351 something, org will prompt for a key to select the template (if you have |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2352 more than one template) and then prepare the buffer like |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2353 @example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2354 * TODO |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2355 [[file:link to where you called remember]] |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2356 @end example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2357 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2358 @noindent or |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2359 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2360 @example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2361 * [2006-03-21 Tue 15:37] |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2362 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2363 [[file:link to where you called remember]] |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2364 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2365 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2366 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2367 During expansion of the template, special @kbd{%}-escapes allow dynamic |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2368 insertion of content: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2369 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2370 %^@{prompt@} @r{prompt the user for a string and replace this sequence with it.} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2371 %t @r{time stamp, date only} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2372 %T @r{time stamp with date and time} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2373 %u, %U @r{like the above, but inactive time stamps} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2374 %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2375 @r{You may define a prompt like @code{%^@{Birthday@}t}} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2376 %n @r{user name (taken from @code{user-full-name})} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2377 %a @r{annotation, normally the link created with @code{org-store-link}} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2378 %i @r{initial content, the region when remember is called with C-u.} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2379 @r{The entire text will be indented like @code{%i} itself.} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2380 %:keyword @r{specific information for certain link types, see below} |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2381 @end example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2382 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2383 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2384 For specific link types, the following keywords will be defined: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2385 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2386 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2387 Link type | Available keywords |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2388 -------------------+---------------------------------------------- |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2389 bbdb | %:name %:company |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2390 vm, wl, mh, rmail | %:type %:subject %:message-id |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2391 | %:from %:fromname %:fromaddress |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2392 | %:to %:toname %:toaddress |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2393 | %: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}.}} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2394 gnus | %:group, @r{for messages also all email fields} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2395 w3, w3m | %:url |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2396 info | %:file %:node |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2397 calendar | %:date" |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2398 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2399 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2400 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2401 If you would like to have the cursor in a specific position after the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2402 template has been expanded: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2403 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2404 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2405 %? @r{After completing the template, position cursor here.} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2406 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2407 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2408 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2409 If you change you mind about which template to use, call |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2410 @code{org-remember} in the remember buffer. You may then select a new |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2411 template that will be filled with the previoous context information. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2412 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2413 @node Storing notes, , Remember templates, Remember |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2414 @subsection Storing notes |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2415 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2416 When you are finished preparing a note with @i{remember}, you have to press |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2417 @kbd{C-c C-c} to file the note away. The handler first prompts for a |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2418 target file - if you press @key{RET}, the value specified for the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2419 template is used. Then the command offers the headings tree of the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2420 selected file, with the cursor position at the default headline (if you |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2421 had specified one in the template). You can either immediately press |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2422 @key{RET} to get the note placed there. Or you can use vertical cursor |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2423 motion (@key{up} and @key{down}) and visibility cycling (@key{TAB}) to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2424 find a better place. Pressing @key{RET} or @key{left} or @key{right} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2425 then leads to the following result. |
58792 | 2426 |
2427 @multitable @columnfractions 0.2 0.1 0.7 | |
2428 @item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted} | |
2429 @item buffer-start @tab @key{RET} @tab as level 2 heading at end of file | |
2430 @item on headline @tab @key{RET} @tab as sublevel of the heading at cursor | |
2431 @item @tab @key{left} @tab as same level, before current heading | |
2432 @item @tab @key{right} @tab as same level, after current heading | |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
2433 @item not on headline @tab @key{RET} |
58792 | 2434 @tab at cursor position, level taken from context. |
2435 Or use prefix arg to specify level manually. | |
2436 @end multitable | |
2437 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2438 So a fast way to store the note to its default location is to press |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2439 @kbd{C-c C-c @key{RET} @key{RET}}. Even shorter would be @kbd{C-u C-c |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2440 C-c}, which does the same without even asking for a file or showing the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2441 tree. |
58792 | 2442 |
2443 Before inserting the text into a tree, the function ensures that the | |
2444 text has a headline, i.e. a first line that starts with a @samp{*}. | |
2445 If not, a headline is constructed from the current date and some | |
2446 additional data. If the variable @code{org-adapt-indentation} is | |
63833 | 2447 non-nil, the entire text is also indented so that it starts in the |
2448 same column as the headline (after the asterisks). | |
58792 | 2449 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2450 |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2451 @node TODO items, Timestamps, Hyperlinks, Top |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2452 @chapter TODO items |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2453 @cindex TODO items |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2454 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2455 Org-mode does not maintain TODO lists as a separate document. TODO |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2456 items are an integral part of the notes file, because TODO items |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2457 usually come up while taking notes! With Org-mode, you simply mark |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2458 any entry in a tree as being a TODO item. In this way, the |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2459 information is not duplicated, and the entire context from which the |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2460 item emerged is always present when you check. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2461 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2462 Of course, this technique causes TODO items to be scattered throughout |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2463 your file. Org-mode provides methods to give you an overview over all |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2464 things you have to do. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2465 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2466 @menu |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2467 * TODO basics:: Marking and displaying TODO entries |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2468 * TODO extensions:: Workflow and assignments |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2469 * Priorities:: Some things are more important than others |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2470 * Breaking down tasks:: Splitting a task into managable pieces |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2471 * Checkboxes:: Tick-off lists |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2472 @end menu |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2473 |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2474 @node TODO basics, TODO extensions, TODO items, TODO items |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2475 @section Basic TODO functionality |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2476 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2477 Any headline can become a TODO item by starting it with the word TODO, |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2478 for example: |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2479 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2480 @example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2481 *** TODO Write letter to Sam Fortune |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2482 @end example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2483 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2484 @noindent |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2485 The most important commands to work with TODO entries are: |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2486 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2487 @table @kbd |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2488 @kindex C-c C-t |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2489 @cindex cycling, of TODO states |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2490 @item C-c C-t |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2491 Rotate the TODO state of the current item between |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2492 |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2493 @example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2494 ,-> (unmarked) -> TODO -> DONE --. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2495 '--------------------------------' |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2496 @end example |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2497 |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2498 The same rotation can also be done ``remotely'' from the timeline and |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2499 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}). |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2500 @kindex S-@key{right} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2501 @kindex S-@key{left} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2502 @item S-@key{right} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2503 @itemx S-@key{left} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2504 Select the following/preceding TODO state, similar to cycling. Mostly |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2505 useful if more than two TODO states are possible (@pxref{TODO extensions}). |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2506 @kindex C-c C-v |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2507 @cindex sparse tree, for TODO |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2508 @item C-c C-v |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2509 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2510 the entire buffer, but shows all TODO items and the headings hierarchy |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2511 above them. With prefix arg, show also the DONE entries. With |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2512 numerical prefix N, show the tree for the Nth keyword in the variable |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2513 @code{org-todo-keywords}. |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2514 @kindex C-c a t |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2515 @item C-c a t |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2516 Show the global TODO list. This collects the TODO items from all |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2517 agenda files (@pxref{Agenda views}) into a single buffer. The buffer is in |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2518 @code{agenda-mode}, so there are commands to examine and manipulate |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2519 the TODO entries directly from that buffer (@pxref{Agenda commands}). |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2520 @xref{Global TODO list}, for more information. |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
2521 @c @item @code{org-agenda-include-all-todo} |
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
2522 @c If you would like to have all your TODO items listed as part of your |
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
2523 @c agenda, customize the variable @code{org-agenda-include-all-todo}. |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2524 @end table |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2525 |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2526 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2527 @node TODO extensions, Priorities, TODO basics, TODO items |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2528 @section Extended use of TODO keywords |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2529 @cindex extended TODO keywords |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2530 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2531 The default implementation of TODO entries is just two states: TODO and |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2532 DONE. You can, however, use the TODO feature for more complicated |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2533 things by configuring the variables @code{org-todo-keywords} and |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2534 @code{org-todo-interpretation}. Using special setup, you can even use |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2535 TODO keywords in different ways in different org files. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2536 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2537 Note that @i{tags} are another way to classify headlines in general and |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2538 TODO items in particular (@pxref{Tags}). |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2539 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2540 @menu |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2541 * Workflow states:: From TODO to DONE in steps |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2542 * TODO types:: I do this, Fred the rest |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2543 * Per file keywords:: Different files, different requirements |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2544 @end menu |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2545 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2546 @node Workflow states, TODO types, TODO extensions, TODO extensions |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2547 @subsection TODO keywords as workflow states |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2548 @cindex TODO workflow |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2549 @cindex workflow states as TODO keywords |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2550 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2551 You can use TODO keywords to indicate different states in the process |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2552 of working on an item, for example: |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2553 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2554 @lisp |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2555 (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE") |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2556 org-todo-interpretation 'sequence) |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2557 @end lisp |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2558 |
63833 | 2559 @cindex completion, of TODO keywords |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2560 Changing these variables only becomes effective in a new Emacs session. |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2561 With this setup, the command @kbd{C-c C-t} will cycle an entry from |
65656 | 2562 TODO to FEEDBACK, then to VERIFY, and finally to DONE. You may also |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2563 use a prefix argument to quickly select a specific state. For example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2564 @kbd{C-3 C-c C-t} will change the state immediately to VERIFY. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2565 If you define many keywords, you can use in-buffer completion (see |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2566 @ref{Completion}) to insert these words into the buffer. Changing a todo |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2567 state can be logged with a timestamp, see @ref{Tracking TODO state |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2568 changes} for more information. |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2569 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2570 @node TODO types, Per file keywords, Workflow states, TODO extensions |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2571 @subsection TODO keywords as types |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2572 @cindex TODO types |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2573 @cindex names as TODO keywords |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2574 @cindex types as TODO keywords |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2575 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2576 The second possibility is to use TODO keywords to indicate different |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2577 types of action items. For example, you might want to indicate that |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
2578 items are for ``work'' or ``home''. If you are into David Allen's |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2579 @emph{Getting Things DONE}, you might want to use todo types |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2580 @samp{NEXTACTION}, @samp{WAITING}, @samp{MAYBE}. Or, when you work |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2581 with several people on a single project, you might want to assign |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2582 action items directly to persons, by using their names as TODO |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2583 keywords. This would be set up like this: |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2584 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2585 @lisp |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2586 (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE") |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2587 org-todo-interpretation 'type) |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2588 @end lisp |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2589 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2590 In this case, different keywords do not indicate a sequence, but |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2591 rather different types. So it is normally not useful to change from |
63833 | 2592 one type to another. Therefore, in this case the behavior of the |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2593 command @kbd{C-c C-t} is changed slightly@footnote{This is also true |
63833 | 2594 for the @kbd{t} command in the timeline and agenda buffers.}. When |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2595 used several times in succession, it will still cycle through all |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2596 names. But when you return to the item after some time and execute |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2597 @kbd{C-c C-t} again, it will switch from each name directly to DONE. |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2598 Use prefix arguments or completion to quickly select a specific name. |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2599 You can also review the items of a specific TODO type in a sparse tree |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2600 by using a numeric prefix to @kbd{C-c C-v}. For example, to see all |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2601 things Lucy has to do, you would use @kbd{C-3 C-c C-v}. To collect |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2602 Lucy's items from all agenda files into a single buffer, you |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2603 would use the prefix arg as well when creating the global todo list: |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2604 @kbd{C-3 C-c t}. |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2605 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2606 @node Per file keywords, , TODO types, TODO extensions |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2607 @subsection Setting up TODO keywords for individual files |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2608 @cindex keyword options |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2609 @cindex per file keywords |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2610 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2611 It can be very useful to use different aspects of the TODO mechanism |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2612 in different files, which is not possible with the global settings |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2613 described above. For file-local settings, you need to add special |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2614 lines to the file which set the keywords and interpretation for that |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2615 file only. For example, to set one of the two examples discussed |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2616 above, you need one of the following lines, starting in column zero |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2617 anywhere in the file: |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2618 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2619 @example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2620 #+SEQ_TODO: TODO FEEDBACK VERIFY DONE |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2621 #+TYP_TODO: Fred Sara Lucy Mike DONE |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2622 @end example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2623 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2624 @cindex completion, of option keywords |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2625 @kindex M-@key{TAB} |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2626 @noindent To make sure you are using the correct keyword, type |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2627 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2628 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2629 @cindex DONE, final TODO keyword |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2630 Remember that the last keyword must always mean that the item is DONE |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2631 (although you may use a different word). Also note that in each file, |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2632 only one of the two aspects of TODO keywords can be used. After |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2633 changing one of these lines, use @kbd{C-c C-c} with the cursor still |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2634 in the line to make the changes known to Org-mode@footnote{Org-mode |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2635 parses these lines only when Org-mode is activated after visiting a |
65656 | 2636 file. @kbd{C-c C-c} with the cursor in a line starting with @samp{#+} |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2637 is simply restarting Org-mode for the current buffer.}. |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2638 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2639 If you want to use very many keywords, for example when working with a |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2640 large group of people, you may split the names over several lines: |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2641 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2642 @example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2643 #+TYP_TODO: Fred Sara Lucy Mike |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2644 #+TYP_TODO: Luis George Jules Jessica |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2645 #+TYP_TODO: Kim Arnold Peter |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2646 #+TYP_TODO: DONE |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2647 @end example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2648 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2649 @node Priorities, Breaking down tasks, TODO extensions, TODO items |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2650 @section Priorities |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2651 @cindex priorities |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2652 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2653 If you use Org-mode extensively to organize your work, you may end up |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2654 with a number of TODO entries so large that you'd like to prioritize |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2655 them. This can be done by placing a @emph{priority cookie} into the |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2656 headline, like this |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2657 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2658 @example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2659 *** TODO [#A] Write letter to Sam Fortune |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2660 @end example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2661 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2662 @noindent |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2663 With its standard setup, Org-mode supports priorities @samp{A}, |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2664 @samp{B}, and @samp{C}. @samp{A} is the highest priority. An entry |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2665 without a cookie is treated as priority @samp{B}. Priorities make a |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2666 difference only in the agenda (@pxref{Weekly/Daily agenda}). |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2667 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2668 @table @kbd |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2669 @kindex @kbd{C-c ,} |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2670 @item @kbd{C-c ,} |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2671 Set the priority of the current headline. The command prompts for a |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2672 priority character @samp{A}, @samp{B} or @samp{C}. When you press |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2673 @key{SPC} instead, the priority cookie is removed from the headline. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2674 The priorities can also be changed ``remotely'' from the timeline and |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2675 agenda buffer with the @kbd{,} command (@pxref{Agenda commands}). |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2676 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2677 @kindex S-@key{up} |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2678 @kindex S-@key{down} |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2679 @item S-@key{up} |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2680 @itemx S-@key{down} |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2681 Increase/decrease priority of current headline. Note that these keys |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2682 are also used to modify time stamps (@pxref{Creating timestamps}). |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2683 Furthermore, these keys are also used by CUA-mode (@pxref{Conflicts}). |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2684 @end table |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2685 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2686 @node Breaking down tasks, Checkboxes, Priorities, TODO items |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2687 @section Breaking tasks down into subtasks |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2688 @cindex tasks, breaking down |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2689 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2690 It is often advisable to break down large tasks into smaller, managable |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2691 subtasks. You can do this by creating an outline tree below a TODO |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2692 item, with detailed subtasks on the tree@footnote{To keep subtasks out |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2693 of the global TODO list, see the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2694 @code{org-agenda-todo-list-sublevels}.}. Another possibility is the use |
74030 | 2695 of checkboxes to identify (a hierarchy of) a large number of subtasks |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2696 (@pxref{Checkboxes}). |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2697 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2698 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2699 @node Checkboxes, , Breaking down tasks, TODO items |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2700 @section Checkboxes |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2701 @cindex checkboxes |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2702 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2703 Every item in a plain list (@pxref{Plain lists}) can be made a checkbox |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2704 by starting it with the string @samp{[ ]}. This feature is similar to |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2705 TODO items (@pxref{TODO items}), but more lightweight. Checkboxes are |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2706 not included into the global TODO list, so they are often great to split |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2707 a task into a number of simple steps. Or you can use them in a shopping |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2708 list. To toggle a checkbox, use @kbd{C-c C-c}, or try Piotr Zielinski's |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2709 @file{org-mouse.el}. Here is an example of a checkbox list. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2710 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2711 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2712 * TODO Organize party [3/6] |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2713 - call people [1/3] |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2714 - [ ] Peter |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2715 - [X] Sarah |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2716 - [ ] Sam |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2717 - [X] order food |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2718 - [ ] think about what music to play |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2719 - [X] talk to the neighbors |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2720 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2721 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2722 @cindex statistics, for checkboxes |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2723 @cindex checkbox statistics |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2724 The @samp{[3/6]} and @samp{[1/3]} in the first and second line are |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2725 cookies indicating how many checkboxes are present in this entry, and |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2726 how many of them have been checked off. This can give you an idea on |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2727 how many checkboxes remain, even without opening a folded entry. The |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2728 cookies can be placed into a headline or into (the first line of) a |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2729 plain list item. Each cookie covers all checkboxes structurally below |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2730 that headline/item. You have to insert the cookie yourself by typing |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2731 either @samp{[/]} or @samp{[%]}. In the first case you get an @samp{n |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2732 out of m} result, in the second case you get information about the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2733 percentage of checkboxes checked (in the above example, this would be |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2734 @samp{[50%]} and @samp{[33%], respectively}). |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2735 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2736 @noindent The following commands work with checkboxes: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2737 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2738 @table @kbd |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2739 @kindex C-c C-c |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2740 @item C-c C-c |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2741 Toggle checkbox at point. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2742 @kindex C-c C-x C-b |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2743 @item C-c C-x C-b |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2744 Toggle checkbox at point. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2745 @itemize @minus |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2746 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2747 If there is an active region, toggle the first checkbox in the region |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2748 and set all remaining boxes to the same status as the first. If you |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2749 want to toggle all boxes in the region independently, use a prefix |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2750 argument. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2751 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2752 If the cursor is in a headline, toggle checkboxes in the region between |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2753 this headline and the next (so @emph{not} the entire subtree). |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2754 @item |
74030 | 2755 If there is no active region, just toggle the checkbox at point. |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2756 @end itemize |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2757 @kindex M-S-@key{RET} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2758 @item M-S-@key{RET} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2759 Insert a new item with a checkbox. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2760 This works only if the cursor is already in a plain list item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2761 (@pxref{Plain lists}). |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2762 @kindex C-c # |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2763 @item C-c # |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2764 Update the checkbox statistics in the current outline entry. When |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2765 called with a @kbd{C-u} prefix, update the entire file. Checkbox |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2766 statistic cookies are updated automatically if you toggle checkboxes |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2767 with @kbd{C-c C-c} and make new ones with @kbd{M-S-@key{RET}}. If you |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2768 delete boxes or add/change them by hand, use this command to get things |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2769 back into synch. Or simply toggle any checkbox twice with @kbd{C-c C-c}. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2770 @end table |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2771 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2772 @node Timestamps, Tags, TODO items, Top |
58792 | 2773 @chapter Timestamps |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2774 @cindex time stamps |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2775 @cindex date stamps |
58792 | 2776 |
2777 Items can be labeled with timestamps to make them useful for project | |
2778 planning. | |
2779 | |
2780 @menu | |
2781 * Time stamps:: Assigning a time to a tree entry | |
2782 * Creating timestamps:: Commands which insert timestamps | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2783 * Custom time format:: If you cannot work with the ISO format |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2784 * Repeating items:: Deadlines that come back again and again |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2785 * Progress logging:: Documenting when what work was done. |
58792 | 2786 @end menu |
2787 | |
2788 | |
2789 @node Time stamps, Creating timestamps, Timestamps, Timestamps | |
2790 @section Time stamps, deadlines and scheduling | |
2791 @cindex time stamps | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2792 @cindex ranges, time |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2793 @cindex date stamps |
58792 | 2794 @cindex deadlines |
2795 @cindex scheduling | |
2796 | |
2797 A time stamp is a specification of a date (possibly with time) in a | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2798 special format, either @samp{<2003-09-16 Tue>} or @samp{<2003-09-16 Tue |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2799 09:39>}@footnote{This is the standard ISO date/time format. If you |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2800 cannot get used to these, see @ref{Custom time format}}. A time stamp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2801 can appear anywhere in the headline or body of an org-tree entry. Its |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2802 presence allows entries to be shown on specific dates in the agenda |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2803 (@pxref{Weekly/Daily agenda}). We distinguish: |
58792 | 2804 |
2805 @table @var | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2806 @item Plain time stamp |
58792 | 2807 @cindex timestamp |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2808 A simple time stamp just assigns a date/time to an item. This is just |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2809 like writing down an appointment in a paper agenda, or like writing down |
71098
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
2810 an event in a diary, when you want to take note of when something |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2811 happened. In the timeline and agenda displays, the headline of an entry |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2812 associated with a plain time stamp will be shown exactly on that date. |
58792 | 2813 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2814 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2815 * Meet Peter at the movies <2006-11-01 Wed 19:15> |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2816 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2817 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2818 @item Inactive time stamp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2819 @cindex timestamp, inactive |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2820 @cindex inactive timestamp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2821 Just like a plain time stamp, but with square brackets instead of |
74030 | 2822 angular ones. These time stamps are inactive in the sense that they do |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2823 @emph{not} trigger an entry to show up in the agenda. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2824 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2825 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2826 * Gillian comes late for the fifth time [2006-11-01 Wed] |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2827 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2828 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2829 @item Time stamp range |
58792 | 2830 @cindex timerange |
2831 Two time stamps connected by @samp{--} denote a time range. The | |
2832 headline will be shown on the first and last day of the range, and on | |
2833 any dates that are displayed and fall in the range. Here is an | |
2834 example: | |
2835 | |
2836 @example | |
2837 ** Meeting in Amsterdam | |
2838 <2004-08-23 Mon>--<2004-08-26 Thu> | |
2839 @end example | |
2840 | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2841 @item Time stamp with SCHEDULED keyword |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2842 @cindex SCHEDULED keyword |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2843 If a time stamp is preceded by the word @samp{SCHEDULED:}, it means you |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2844 are planning to start working on that task on the given date. So this is |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2845 not about recording an event, but about planning your work. The |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2846 headline will be listed under the given date@footnote{It will still be |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2847 listed on that date after it has been marked DONE. If you don't like |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2848 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2849 addition, a reminder that the scheduled date has passed will be present |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2850 in the compilation for @emph{today}, until the entry is marked DONE. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2851 I.e., the task will automatically be forwarded until completed. |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2852 |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2853 @example |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
2854 *** TODO Call Trillian for a date on New Years Eve. |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2855 SCHEDULED: <2004-12-25 Sat> |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2856 @end example |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2857 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2858 @item Time stamp with DEADLINE keyword |
63833 | 2859 @cindex DEADLINE keyword |
58792 | 2860 If a time stamp is preceded by the word @samp{DEADLINE:}, the task |
2861 (most likely a TODO item) is supposed to be finished on that date, and | |
63833 | 2862 it will be listed then. In addition, the compilation for @emph{today} |
2863 will carry a warning about the approaching or missed deadline, | |
2864 starting @code{org-deadline-warning-days} before the due date, and | |
2865 continuing until the entry is marked DONE. An example: | |
58792 | 2866 |
2867 @example | |
2868 *** TODO write article about the Earth for the Guide | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2869 The editor in charge is [[bbdb:Ford Prefect]] |
58792 | 2870 DEADLINE: <2004-02-29 Sun> |
2871 @end example | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2872 @item Time stamp with CLOSED keyword |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2873 @cindex CLOSED keyword |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2874 When @code{org-log-done} is non-nil, Org-mode will automatically insert |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2875 a special time stamp each time a TODO entry is marked done |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2876 (@pxref{Progress logging}). This time stamp is enclosed in square |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2877 brackets instead of angular brackets. |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2878 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2879 @item Time range with CLOCK keyword |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2880 @cindex CLOCK keyword |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2881 When using the clock to time the work that is being done on specific |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
2882 items, time ranges preceded by the CLOCK keyword are inserted |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2883 automatically into the file. The time stamps are enclosed in square |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2884 brackets instead of angular brackets. @xref{Clocking work time}. |
58792 | 2885 @end table |
2886 | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2887 @node Creating timestamps, Custom time format, Time stamps, Timestamps |
58792 | 2888 @section Creating timestamps |
2889 @cindex creating timestamps | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2890 @cindex timestamps, creating |
58792 | 2891 |
2892 For Org-mode to recognize time stamps, they need to be in the specific | |
2893 format. All commands listed below produce time stamps in the correct | |
2894 format. | |
2895 | |
2896 @table @kbd | |
2897 @kindex C-c . | |
2898 @item C-c . | |
2899 Prompt for a date and insert a corresponding time stamp. When the | |
2900 cursor is at a previously used time stamp, it is updated to NOW. When | |
2901 this command is used twice in succession, a time range is inserted. | |
2902 | |
2903 @kindex C-u C-c . | |
2904 @item C-u C-c . | |
2905 Like @kbd{C-c .}, but use the alternative format which contains date | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2906 and time. The default time can be rounded to multiples of 5 minutes, |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2907 see the option @code{org-time-stamp-rounding-minutes}. |
58792 | 2908 |
65656 | 2909 @kindex C-c ! |
2910 @item C-c ! | |
2911 Like @kbd{C-c .}, but insert an inactive time stamp not triggering the | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2912 agenda. |
65656 | 2913 |
58792 | 2914 @kindex C-c < |
2915 @item C-c < | |
2916 Insert a time stamp corresponding to the cursor date in the Calendar. | |
2917 | |
2918 @kindex C-c > | |
2919 @item C-c > | |
2920 Access the Emacs calendar for the current date. If there is a | |
2921 timestamp in the current line, goto the corresponding date | |
2922 instead. | |
2923 | |
2924 @kindex C-c C-o | |
2925 @item C-c C-o | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2926 Access the agenda for the date given by the time stamp or -range at |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2927 point (@pxref{Weekly/Daily agenda}). |
58792 | 2928 |
2929 @kindex C-c C-d | |
2930 @item C-c C-d | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2931 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2932 happen in the line directly following the headline. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2933 @c FIXME Any CLOSED timestamp will be removed.???????? |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2934 |
58792 | 2935 @kindex C-c C-w |
2936 @cindex sparse tree, for deadlines | |
2937 @item C-c C-w | |
2938 Create a sparse tree with all deadlines that are either past-due, or | |
2939 which will become due within @code{org-deadline-warning-days}. | |
2940 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric | |
2941 prefix, check that many days. For example, @kbd{C-1 C-c C-w} shows | |
2942 all deadlines due tomorrow. | |
2943 | |
2944 @kindex C-c C-s | |
2945 @item C-c C-s | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2946 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2947 happen in the line directly following the headline. Any CLOSED |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2948 timestamp will be removed. |
58792 | 2949 |
2950 @kindex S-@key{left} | |
2951 @kindex S-@key{right} | |
2952 @item S-@key{left} | |
2953 @itemx S-@key{right} | |
63362 | 2954 Change date at cursor by one day. These key bindings conflict with |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2955 CUA-mode (@pxref{Conflicts}). |
58792 | 2956 |
2957 @kindex S-@key{up} | |
2958 @kindex S-@key{down} | |
2959 @item S-@key{up} | |
2960 @itemx S-@key{down} | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2961 Change the item under the cursor in a timestamp. The cursor can be on a |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2962 year, month, day, hour or minute. Note that if the cursor is in a |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2963 headline and not at a time stamp, these same keys modify the priority of |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2964 an item. (@pxref{Priorities}). The key bindings also conflict with |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2965 CUA-mode (@pxref{Conflicts}). |
63362 | 2966 |
58792 | 2967 |
2968 @kindex C-c C-y | |
2969 @cindex evaluate time range | |
2970 @item C-c C-y | |
2971 Evaluate a time range by computing the difference between start and | |
2972 end. With prefix arg, insert result after the time range (in a table: | |
2973 into the following column). | |
2974 @end table | |
2975 | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2976 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2977 @menu |
74030 | 2978 * The date/time prompt:: How org-mode helps you entering date and time |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2979 @end menu |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2980 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2981 @node The date/time prompt, , Creating timestamps, Creating timestamps |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2982 @subsection The date/time prompt |
58792 | 2983 @cindex date, reading in minibuffer |
2984 @cindex time, reading in minibuffer | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2985 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2986 When Org-mode prompts for a date/time, the prompt suggests to enter an |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2987 ISO date. But it will in fact accept any string containing some date |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2988 and/or time information. You can, for example, use @kbd{C-y} to paste a |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2989 (possibly multi-line) string copied from an email message. Org-mode |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2990 will find whatever information is in there and will replace anything not |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2991 specified with the current date and time. For example: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2992 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2993 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2994 3-2-5 --> 2003-02-05 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2995 feb 15 --> currentyear-02-15 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2996 sep 12 9 --> 2009-09-12 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2997 12:45 --> today 12:45 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2998 22 sept 0:34 --> currentyear-09-22 0:34 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2999 12 --> currentyear-currentmonth-12 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3000 Fri --> nearest Friday (today or later) |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3001 +4 --> 4 days from now (if +N is the only thing given) |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3002 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3003 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3004 The function understands English month and weekday abbreviations. If |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3005 you want to use unabbreviated names and/or other languages, configure |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3006 the variables @code{parse-time-months} and @code{parse-time-weekdays}. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3007 |
58792 | 3008 @cindex calendar, for selecting date |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3009 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3010 you don't need/want the calendar, configure the variable |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3011 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3012 prompt, either by clicking on a date in the calendar, or by pressing |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3013 @key{RET}, the date selected in the calendar will be combined with the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3014 information entered at the prompt. You can control the calendar fully |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3015 from the minibuffer: |
58792 | 3016 |
3017 @table @kbd | |
3018 @kindex < | |
3019 @item < | |
3020 Scroll calendar backwards by one month. | |
3021 @kindex > | |
3022 @item > | |
3023 Scroll calendar forwards by one month. | |
3024 @kindex mouse-1 | |
3025 @item mouse-1 | |
3026 Select date by clicking on it. | |
3027 @kindex S-@key{right} | |
3028 @item S-@key{right} | |
3029 One day forward. | |
3030 @kindex S-@key{left} | |
3031 @item S-@key{left} | |
3032 One day back. | |
3033 @kindex S-@key{down} | |
3034 @item S-@key{down} | |
3035 One week forward. | |
3036 @kindex S-@key{up} | |
3037 @item S-@key{up} | |
3038 One week back. | |
3039 @kindex M-S-@key{right} | |
3040 @item M-S-@key{right} | |
3041 One month forward. | |
3042 @kindex M-S-@key{left} | |
3043 @item M-S-@key{left} | |
3044 One month back. | |
3045 @kindex @key{RET} | |
3046 @item @key{RET} | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3047 Choose date in calendar (only if nothing was typed into minibuffer). |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3048 @end table |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3049 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3050 @node Custom time format, Repeating items, Creating timestamps, Timestamps |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3051 @section Custom time format |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3052 @cindex custom date/time format |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3053 @cindex time format, custom |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3054 @cindex date format, custom |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3055 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3056 Org-mode uses the standard ISO notation for dates and times as it is |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3057 defined in ISO 8601. If you cannot get used to this and require another |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3058 representation of date and time to keep you happy, you can get it by |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3059 customizing the variables @code{org-display-custom-times} and |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3060 @code{org-time-stamp-custom-formats}. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3061 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3062 @table @kbd |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3063 @kindex C-c C-x C-t |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3064 @item C-c C-x C-t |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3065 Toggle the display of custom formats for dates and times. |
58792 | 3066 @end table |
3067 | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3068 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3069 Org-mode needs the default format for scanning, so the custom date/time |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3070 format does not @emph{replace} the default format - instead it is put |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3071 @emph{over} the default format using text properties. This has the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3072 following consequences: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3073 @itemize @bullet |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3074 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3075 You cannot place the cursor onto a time stamp anymore, only before or |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3076 after. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3077 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3078 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3079 each component of a time stamp. If the cursor is at the beginning of |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3080 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day, |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3081 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3082 time will be changed by one minute. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3083 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3084 When you delete a time stamp character-by-character, it will only |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3085 disappear from the buffer after @emph{all} (invisible) characters |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3086 belonging to the ISO timestamp have been removed. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3087 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3088 If the custom time stamp format is longer than the default and you are |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3089 using dates in tables, table alignment will be messed up. If the custom |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3090 format is shorter, things do work as expected. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3091 @end itemize |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3092 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3093 @node Repeating items, Progress logging, Custom time format, Timestamps |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3094 @section Repeating items |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3095 @cindex TODO items, repeating |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3096 @cindex deadlines, repeating |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3097 @cindex scheduling, repeating |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3098 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3099 Org-mode integrates with the Emacs calendar and diary to display cyclic |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3100 appointments, anniversaries and other special entries in the agenda |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3101 (@pxref{Weekly/Daily agenda}). However, it can be useful to have |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3102 certain deadlines and scheduling items to auto-repeat. The advantage of |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3103 a deadline or scheduled item is that the they produce warnings ahead of |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3104 time and automatically forward themselves in the agenda until they are |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3105 done. The abstract difference is therefore between cyclic |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3106 @i{appointments} and cyclic @i{action items}. For appointments you |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3107 should use the diary, for actions you can uses an org-mode deadline or |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3108 scheduling time stamp together with a REPEAT cookie. For example: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3109 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3110 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3111 * TODO Replace batteries in smoke detector REPEAT(+18m) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3112 SCHEDULED: <2007-01-01 Mon> |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3113 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3114 * TODO Get dentist appointment REPEAT(+6m) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3115 SCHEDULED: <2006-12-19 Tue> |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3116 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3117 * TODO Tax report to IRS REPEAT(+1y) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3118 DEADLINE: <2007-04-01 Sun> |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3119 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3120 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3121 Each time you try to mark one of these entries DONE using @kbd{C-c C-t}, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3122 they will automatically switch back to the state TODO, and the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3123 deadline/scheduling will be shifted accordingly. The time units |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3124 recognized by org-mode are year (y), month (m), week (w), and day (d). |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3125 Org-mode will also prompt you for a note and record the fact that you |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3126 have closed this item in a note under the headline. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3127 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3128 One unusual property of these repeating items is that only one instance |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3129 of each exist at any given time. So if you look back or ahead in the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3130 agenda, you will not find past and future instances, only the current |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3131 one will show up. Use a cyclic diary entry if you need all past and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3132 future instances to be visible in the agenda. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3133 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3134 @node Progress logging, , Repeating items, Timestamps |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3135 @section Progress Logging |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3136 @cindex progress logging |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3137 @cindex logging, of progress |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3138 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3139 Org-mode can automatically record a time stamp when you mark a TODO item |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3140 as DONE, or even each time when you change the state of a TODO item. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3141 You can also measure precisely the time you spent on specific items in a |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3142 project by starting and stopping a clock when you start and stop working |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3143 on an aspect of a project. |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3144 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3145 @menu |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
3146 * Closing items:: When was this entry marked DONE? |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3147 * Tracking TODO state changes:: When did the status change? |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3148 * Clocking work time:: When exactly did you work on this item? |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3149 @end menu |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3150 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3151 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3152 @subsection Closing items |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3153 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3154 If you want to keep track of @emph{when} a certain TODO item was |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3155 finished, turn on logging with@footnote{The corresponding in-buffer |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3156 setting is: @code{#+STARTUP: logdone}} |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3157 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3158 @lisp |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3159 (setq org-log-done t) |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3160 @end lisp |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3161 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3162 @noindent |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3163 Then each time you turn a TODO entry into DONE using either @kbd{C-c |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3164 C-t} in the Org-mode buffer or @kbd{t} in the agenda buffer, a line |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3165 @samp{CLOSED: [timestamp]} will be inserted just after the headline. If |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3166 you turn the entry back into a TODO item through further state cycling, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3167 that line will be removed again. In the timeline (@pxref{Timeline}) and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3168 in the agenda (@pxref{Weekly/Daily agenda}), you can then use the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3169 @kbd{l} key to display the TODO items closed on each day, giving you an |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3170 overview of what has been done on a day. If you want to record a note |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3171 along with the timestamp, use@footnote{The corresponding in-buffer |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3172 setting is: @code{#+STARTUP: lognotedone}} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3173 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3174 @lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3175 (setq org-log-done '(done)) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3176 @end lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3177 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3178 @node Tracking TODO state changes, Clocking work time, Closing items, Progress logging |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3179 @subsection Tracking TODO state changes |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3180 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3181 When TODO keywords are used as workflow states (@pxref{Workflow |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3182 states}), you might want to keep track of when a state change occurred, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3183 and you may even want to attach notes to that state change. With the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3184 setting |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3185 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3186 @lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3187 (setq org-log-done '(state)) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3188 @end lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3189 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3190 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3191 each state change will prompt you for a note that will be attached to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3192 the current headline. Very likely you do not want this verbose tracking |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3193 all the time, so it is probably better to configure this behavior with |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3194 in-buffer options. For example, if you are tracking purchases, put |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3195 these into a separate file that starts with: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3196 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3197 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3198 #+SEQ_TODO: TODO ORDERED INVOICE PAYED RECEIVED SENT |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3199 #+STARTUP: lognotestate |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3200 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3201 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3202 @node Clocking work time, , Tracking TODO state changes, Progress logging |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3203 @subsection Clocking work time |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3204 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3205 Org-mode allows you to clock the time you spent on specific tasks in a |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3206 project. When you start working on an item, you can start the clock. |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
3207 When you stop working on that task, or when you mark the task done, the |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
3208 clock is stopped and the corresponding time interval is recorded. It |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3209 also computes the total time spent on each subtree of a project. |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3210 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3211 @table @kbd |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3212 @kindex C-c C-x C-i |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3213 @item C-c C-x C-i |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3214 Start the clock on the current item (clock-in). This inserts the CLOCK |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3215 keyword together with a timestamp. |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3216 @kindex C-c C-x C-o |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3217 @item C-c C-x C-o |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3218 Stop the clock (clock-out). The inserts another timestamp at the same |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3219 location where the clock was last started. It also directly computes |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3220 the resulting time in inserts it after the time range as @samp{=> |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3221 HH:MM}. See the variable @code{org-log-done} for the possibility to |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3222 record an additional note together with the clock-out time |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3223 stamp@footnote{The corresponding in-buffer setting is: @code{#+STARTUP: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3224 lognoteclock-out}}. |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3225 @kindex C-c C-y |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3226 @item C-c C-y |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3227 Recompute the time interval after changing one of the time stamps. This |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3228 is only necessary if you edit the time stamps directly. If you change |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3229 them with @kbd{S-@key{cursor}} keys, the update is automatic. |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3230 @kindex C-c C-t |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3231 @item C-c C-t |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3232 Changing the TODO state of an item to DONE automatically stops the clock |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3233 if it is running in this same item. |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3234 @kindex C-c C-x C-x |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3235 @item C-c C-x C-x |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3236 Cancel the current clock. This is useful if a clock was started by |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3237 mistake, or if you ended up working on something else. |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3238 @kindex C-c C-x C-d |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3239 @item C-c C-x C-d |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3240 Display time summaries for each subtree in the current buffer. This |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3241 puts overlays at the end of each headline, showing the total time |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3242 recorded under that heading, including the time of any subheadings. You |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3243 can use visibility cycling to study the tree, but the overlays disappear |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3244 when you change the buffer (see variable |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3245 @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}. |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
3246 @kindex C-c C-x C-r |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
3247 @item C-c C-x C-r |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3248 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3249 report as an org-mode table into the current file. |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
3250 @example |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
3251 #+BEGIN: clocktable :maxlevel 2 :emphasize nil |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
3252 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
3253 #+END: clocktable |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
3254 @end example |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
3255 @noindent |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
3256 If such a block already exists, its content is replaced by the new |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
3257 table. The @samp{BEGIN} line can specify options: |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
3258 @example |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
3259 :maxlevels @r{Maximum level depth to which times are listed in the table.} |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
3260 :emphasize @r{When @code{t}, emphasize level one and level two items} |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3261 :block @r{The time block to consider. This block is specified relative} |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3262 @r{to the current time and may be any of these keywords:} |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3263 @r{@code{today}, @code{yesterday}, @code{thisweek}, @code{lastweek},} |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3264 @r{@code{thismonth}, @code{lastmonth}, @code{thisyear}, or @code{lastyear}}. |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3265 :tstart @r{A time string specifying when to start considering times} |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3266 :tend @r{A time string specifying when to stop considering times} |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
3267 @end example |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3268 So to get a clock summary for the current day, you could write |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3269 @example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3270 #+BEGIN: clocktable :maxlevel 2 :block today |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3271 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3272 #+END: clocktable |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3273 @end example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3274 and to use a specific time range you could write@footnote{Note that all |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3275 parameters must be specified in a single line - the line is broken here |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3276 only to fit it onto the manual.} |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3277 @example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3278 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>" |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3279 :tend "<2006-08-10 Thu 12:00>" |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3280 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3281 #+END: clocktable |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3282 @end example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3283 @kindex C-u C-c C-x C-u |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3284 @item C-u C-c C-x C-u |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3285 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
3286 you have several clocktable blocks in a buffer. |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3287 @end table |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3288 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3289 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3290 the agenda (@pxref{Weekly/Daily agenda}) to show which tasks have been |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3291 worked on or closed during a day. |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3292 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
3293 @node Tags, Agenda views, Timestamps, Top |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3294 @chapter Tags |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3295 @cindex tags |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3296 @cindex headline tagging |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3297 @cindex matching, tags |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3298 @cindex sparse tree, tag based |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3299 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3300 If you wish to implement a system of labels and contexts for |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3301 cross-correlating information, an excellent way is to assign @i{tags} to |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3302 headlines. Org-mode has extensive support for using tags. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3303 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3304 Every headline can contain a list of tags, at the end of the headline. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3305 Tags are normal words containing letters, numbers, @samp{_}, and |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3306 @samp{@@}. Tags must be preceded and followed by a single colon; like |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3307 @samp{:WORK:}. Several tags can be specified like @samp{:WORK:URGENT:}. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3308 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3309 @menu |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3310 * Tag inheritance:: Tags use the tree structure of the outline |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3311 * Setting tags:: How to assign tags to a headline |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3312 * Tag searches:: Searching for combinations of tags |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3313 @end menu |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3314 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3315 @node Tag inheritance, Setting tags, Tags, Tags |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3316 @section Tag inheritance |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3317 @cindex inheritance, of tags |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3318 @cindex sublevels, inclusion into tags match |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3319 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3320 @i{Tags} make use of the hierarchical structure of outline trees. If a |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3321 heading has a certain tag, all subheadings will inherit the tag as |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3322 well. For example, in the list |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3323 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3324 @example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3325 * Meeting with the French group :WORK: |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3326 ** Summary by Frank :BOSS:NOTES: |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3327 *** TODO Prepare slides for him :ACTION: |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3328 @end example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3329 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3330 @noindent |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3331 the final heading will have the tags @samp{:WORK:}, @samp{:BOSS:}, |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3332 @samp{:NOTES:}, and @samp{:ACTION:}. When executing tag searches and |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3333 Org-mode finds that a certain headline matches the search criterion, it |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3334 will not check any sublevel headline, assuming that these likely also |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3335 match, and that the list of matches can become very long. This may |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3336 not be what you want, however, and you can influence inheritance and |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3337 searching using the variables @code{org-use-tag-inheritance} and |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3338 @code{org-tags-match-list-sublevels}. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3339 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3340 @node Setting tags, Tag searches, Tag inheritance, Tags |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3341 @section Setting tags |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3342 @cindex setting tags |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3343 @cindex tags, setting |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3344 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3345 @kindex M-@key{TAB} |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3346 Tags can simply be typed into the buffer at the end of a headline. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3347 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3348 also a special command for inserting tags: |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3349 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3350 @table @kbd |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3351 @kindex C-c C-c |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3352 @item C-c C-c |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3353 @cindex completion, of tags |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3354 Enter new tags for the current headline. Org-mode will either offer |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3355 completion or a special single-key interface for setting tags, see |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3356 below. After pressing @key{RET}, the tags will be inserted and aligned |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3357 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3358 tags in the current buffer will be aligned to that column, just to make |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3359 things look nice. TAGS are automatically realigned after promotion, |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3360 demotion, and TODO state changes (@pxref{TODO basics}). |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3361 @end table |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3362 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3363 Org will support tag insertion based on a @emph{list of tags}. By |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3364 default this list is constructed dynamically, containing all tags |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3365 currently used in the buffer. You may also globally specify a hard list |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3366 of tags with the variable @code{org-tag-alist}. Finally you can set |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3367 the default tags for a given file with lines like |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3368 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3369 @example |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3370 #+TAGS: @@WORK @@HOME @@TENNISCLUB |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3371 #+TAGS: Laptop Car PC Sailboat |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3372 @end example |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3373 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3374 If you have globally defined your preferred set of tags using the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3375 variable @code{org-tag-alist}, but would like to use a dynamic tag list |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3376 in a specific file: Just add an empty TAGS option line to that file: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3377 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3378 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3379 #+TAGS: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3380 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3381 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3382 The default support method for entering tags is minibuffer completion. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3383 However, Org-mode also implements a much better method: @emph{fast tag |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3384 selection}. This method allows to select and deselect tags with a |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3385 single key per tag. To function efficiently, you should assign unique |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3386 keys to most tags. This can be done globally with |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3387 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3388 @lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3389 (setq org-tag-alist '(("@@WORK" . ?w) ("@@HOME" . ?h) ("Laptop" . ?l))) |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3390 @end lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3391 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3392 @noindent or on a per-file basis with |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3393 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3394 @example |
71246
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3395 #+TAGS: @@WORK(w) @@HOME(h) @@TENNISCLUB(t) Laptop(l) PC(p) |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3396 @end example |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3397 |
71246
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3398 @noindent |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3399 You can also group together tags that are mutually exclusive. With |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3400 curly braces@footnote{In @code{org-mode-alist} use |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3401 @code{'(:startgroup)} and @code{'(:endgroup)}, respectively. Several |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3402 groups are allowed.} |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3403 |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3404 @example |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3405 #+TAGS: @{ @@WORK(w) @@HOME(h) @@TENNISCLUB(t) @} Laptop(l) PC(p) |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3406 @end example |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3407 |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3408 @noindent you indicate that at most one of @samp{@@WORK}, @samp{@@HOME}, |
72888
d688b3faf96b
(Setting tags): Typo fix.
Carsten Dominik <dominik@science.uva.nl>
parents:
72399
diff
changeset
|
3409 and @samp{@@TENNISCLUB} should be selected. |
71246
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3410 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3411 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3412 these lines to activate any changes. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3413 |
71246
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3414 If at least one tag has a selection key, pressing @kbd{C-c C-c} will |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3415 automatically present you with a special interface, listing inherited |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3416 tags, the tags of the current headline, and a list of all legal tags |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3417 with corresponding keys@footnote{Keys will automatically be assigned to |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3418 tags which have no configured keys.}. In this interface, you can use |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3419 the following keys: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3420 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3421 @table @kbd |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3422 @item a-z... |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3423 Pressing keys assigned to tags will add or remove them from the list of |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3424 tags in the current line. Selecting a tag in a group of mutually |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3425 exclusive tags will turn off any other tags from that group. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3426 @kindex @key{TAB} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3427 @item @key{TAB} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3428 Enter a tag in the minibuffer, even if the tag is not in the predefined |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3429 list. You will be able to complete on all tags present in the buffer. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3430 @kindex @key{SPC} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3431 @item @key{SPC} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3432 Clear all tags for this line. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3433 @kindex @key{RET} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3434 @item @key{RET} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3435 Accept the modified set. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3436 @item C-g |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3437 Abort without installing changes. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3438 @item q |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3439 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3440 @item ! |
74030 | 3441 Turn off groups of mutually exclusive tags. Use this to (as an |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3442 exception) assign several tags from such a group. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3443 @item C-c |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3444 Toggle auto-exit after the next change (see below). |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3445 If you are using expert mode, the first @kbd{C-c} will display the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3446 selection window. |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3447 @end table |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3448 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3449 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3450 This method lets you assign tags to a headline with very few keys. With |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3451 the above setup, you could clear the current tags and set @samp{@@HOME}, |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3452 @samp{Laptop} and @samp{PC} tags with just the following keys: @kbd{C-c |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3453 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@HOME} to |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3454 @samp{@@WORK} would be done with @kbd{C-c C-c w @key{RET}} or |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3455 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3456 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3457 @key{RET} @key{RET}}. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3458 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3459 If you find that most of the time, you need only a single keypress to |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3460 modify your list of tags, set the variable |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3461 @code{org-fast-tag-selection-single-key}. Then you no longer have to |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3462 press @key{RET} to exit fast tag selection - it will immediately exit |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3463 after the first change. If you then occasionally need more keys, press |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3464 @kbd{C-c} to turn off auto-exit for the current tag selection process |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3465 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3466 C-c}). If you set the variable to the value @code{expert}, the special |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3467 window is not even shown for single-key tag selection, it comes up only |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3468 when you press an extra @kbd{C-c}. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3469 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3470 @node Tag searches, , Setting tags, Tags |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3471 @section Tag searches |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3472 @cindex tag searches |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3473 @cindex searching for tags |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3474 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3475 Once a tags system has been set up, it can be used to collect related |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3476 information into special lists. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3477 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3478 @table @kbd |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3479 @kindex C-c \ |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3480 @item C-c \ |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3481 Create a sparse tree with all headlines matching a tags search. With a |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3482 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3483 @kindex C-c a m |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3484 @item C-c a m |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3485 Create a global list of tag matches from all agenda files. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3486 @xref{Matching headline tags}. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3487 @kindex C-c a M |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3488 @item C-c a M |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3489 Create a global list of tag matches from all agenda files, but check |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3490 only TODO items and force checking subitems (see variable |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3491 @code{org-tags-match-list-sublevels}). |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3492 @end table |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3493 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3494 @cindex Boolean logic, for tag searches |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3495 A @i{tags} search string can use Boolean operators @samp{&} for AND and |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3496 @samp{|} for OR. @samp{&} binds more strongly than @samp{|}. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3497 Parenthesis are currently not implemented. A tag may also be preceded |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3498 by @samp{-}, to select against it, and @samp{+} is syntactic sugar for |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3499 positive selection. The AND operator @samp{&} is optional when @samp{+} |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3500 or @samp{-} is present. Examples: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3501 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3502 @table @samp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3503 @item +WORK-BOSS |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3504 Select headlines tagged @samp{:WORK:}, but discard those also tagged |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3505 @samp{:BOSS:}. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3506 @item WORK|LAPTOP |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3507 Selects lines tagged @samp{:WORK:} or @samp{:LAPTOP:}. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3508 @item WORK|LAPTOP&NIGHT |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3509 Like before, but require the @samp{:LAPTOP:} lines to be tagged also |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3510 @samp{NIGHT}. |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3511 @end table |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3512 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3513 @cindex TODO keyword matching, with tags search |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3514 If you are using multi-state TODO keywords (@pxref{TODO extensions}), it |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3515 can be useful to also match on the TODO keyword. This can be done by |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3516 adding a condition after a slash to a tags match. The syntax is similar |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3517 to the tag matches, but should be applied with consideration: For |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3518 example, a positive selection on several TODO keywords can not |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3519 meaningfully be combined with boolean AND. However, @emph{negative |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3520 selection} combined with AND can be meaningful. To make sure that only |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3521 lines are checked that actually have any TODO keyword, use @kbd{C-c a |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3522 M}, or equivalently start the todo part after the slash with @samp{!}. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3523 Examples: |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3524 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3525 @table @samp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3526 @item WORK/WAITING |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3527 Select @samp{:WORK:}-tagged TODO lines with the specific TODO |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3528 keyword @samp{WAITING}. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3529 @item WORK/!-WAITING-NEXT |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3530 Select @samp{:WORK:}-tagged TODO lines that are neither @samp{WAITING} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3531 nor @samp{NEXT} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3532 @item WORK/+WAITING|+NEXT |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3533 Select @samp{:WORK:}-tagged TODO lines that are either @samp{WAITING} or |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3534 @samp{NEXT}. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3535 @end table |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3536 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3537 @cindex regular expressions, with tags search |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3538 Any element of the tag/todo match can be a regular expression - in this |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3539 case it must be enclosed in curly braces. For example, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3540 @samp{WORK+@{^BOSS.*@}} matches headlines that contain the tag |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3541 @samp{WORK} and any tag @i{starting} with @samp{BOSS}. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3542 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3543 @cindex level, require for tags match |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3544 You can also require a headline to be of a certain level, by writing |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3545 instead of any TAG an expression like @samp{LEVEL=3}. For example, a |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3546 search @samp{+LEVEL=3+BOSS/-DONE} lists all level three headlines that |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3547 have the tag BOSS and are @emph{not} marked with the todo keyword DONE. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3548 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
3549 @node Agenda views, Embedded LaTeX, Tags, Top |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3550 @chapter Agenda Views |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3551 @cindex agenda views |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3552 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3553 Due to the way Org-mode works, TODO items, time-stamped items, and |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3554 tagged headlines can be scattered throughout a file or even a number of |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3555 files. To get an overview over open action items, or over events that |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3556 are important for a particular date, this information must be collected, |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3557 sorted and displayed in an organized way. |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3558 |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3559 Org-mode can select items based on various criteria, and display them |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3560 in a separate buffer. Six different view types are provided: |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3561 |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3562 @itemize @bullet |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3563 @item |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3564 an @emph{agenda} that is like a calendar and shows information |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3565 for specific dates, |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3566 @item |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3567 a @emph{TODO list} that covers all unfinished |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3568 action items, |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3569 @item |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3570 a @emph{tags view}, showings headlines based on |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3571 the tags associated with them, |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3572 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3573 a @emph{timeline view} that shows all events in a single Org-mode file, |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3574 in time-sorted view, |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3575 @item |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3576 a @emph{stuck projects view} showing projects that currently don't move |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3577 along, and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3578 @item |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3579 @emph{custom views} that are special tag/keyword searches and |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3580 combinations of different views. |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3581 @end itemize |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3582 |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3583 @noindent |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3584 The extracted information is displayed in a special @emph{agenda |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3585 buffer}. This buffer is read-only, but provides commands to visit the |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3586 corresponding locations in the original Org-mode files, and even to |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3587 edit these files remotely. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3588 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3589 Two variables control how the agenda buffer is displayed and whether the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3590 window configuration is restored when the agenda exits: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3591 @code{org-agenda-window-setup} and |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3592 @code{org-agenda-restore-windows-after-quit}. |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3593 |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3594 @menu |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3595 * Agenda files:: Files being searched for agenda information |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3596 * Agenda dispatcher:: Keyboard access to agenda views |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3597 * Built-in agenda views:: What is available out of the box? |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3598 * Presentation and sorting:: How agenda items are prepared for display |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3599 * Agenda commands:: Remote editing of org trees |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3600 * Custom agenda views:: Defining special searches and views |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3601 @end menu |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3602 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
3603 @node Agenda files, Agenda dispatcher, Agenda views, Agenda views |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3604 @section Agenda files |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3605 @cindex agenda files |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3606 @cindex files for agenda |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3607 |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3608 The information to be shown is collected from all @emph{agenda files}, |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3609 the files listed in the variable @code{org-agenda-files}@footnote{If the |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3610 value of that variable is not a list, but a single file name, then the |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3611 list of agenda files will be maintained in that external file.}. Thus even |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3612 if you only work with a single Org-mode file, this file should be put |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3613 into that list@footnote{When using the dispatcher, pressing @kbd{1} |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3614 before selecting a command will actually limit the command to the |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3615 current file, and ignore @code{org-agenda-files} until the next |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3616 dispatcher command.}. You can customize @code{org-agenda-files}, but |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3617 the easiest way to maintain it is through the following commands |
58792 | 3618 |
3619 @cindex files, adding to agenda list | |
3620 @table @kbd | |
3621 @kindex C-c [ | |
3622 @item C-c [ | |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
3623 Add current file to the list of agenda files. The file is added to |
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
3624 the front of the list. If it was already in the list, it is moved to |
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
3625 the front. With prefix arg, file is added/moved to the end. |
58792 | 3626 @kindex C-c ] |
3627 @item C-c ] | |
3628 Remove current file from the list of agenda files. | |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
3629 @kindex C-, |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3630 @kindex C-' |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
3631 @item C-, |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3632 @itemx C-' |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3633 Cycle through agenda file list, visiting one file after the other. |
58792 | 3634 @end table |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3635 |
58792 | 3636 @noindent |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3637 The Org menu contains the current list of files and can be used |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3638 to visit any of them. |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3639 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3640 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda views |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3641 @section The agenda dispatcher |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3642 @cindex agenda dispatcher |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3643 @cindex dispatching agenda commands |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3644 The views are created through a dispatcher that should be bound to a |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
3645 global key, for example @kbd{C-c a} (@pxref{Installation}). In the |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
3646 following we will assume that @kbd{C-c a} is indeed how the dispatcher |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
3647 is accessed and list keyboard access to commands accordingly. After |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
3648 pressing @kbd{C-c a}, an additional letter is required to execute a |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
3649 command. The dispatcher offers the following default commands: |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3650 @table @kbd |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3651 @item a |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
3652 Create the calendar-like agenda (@pxref{Weekly/Daily agenda}). |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3653 @item t @r{/} T |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3654 Create a list of all TODO items (@pxref{Global TODO list}). |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3655 @item m @r{/} M |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3656 Create a list of headlines matching a TAGS expression (@pxref{Matching |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3657 headline tags}). |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3658 @item L |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3659 Create the timeline view for the current buffer (@pxref{Timeline}). |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3660 @item # @r{/} ! |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3661 Create a list of stuck projects (@pxref{Stuck projects}). |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3662 @item 1 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3663 Restrict an agenda command to the current buffer. After pressing |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3664 @kbd{1}, you still need to press the character selecting the command. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3665 @item 0 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3666 If there is an active region, restrict the following agenda command to |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3667 the region. Otherwise, restrict it to the current subtree. After |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3668 pressing @kbd{0}, you still need to press the character selecting the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3669 command. |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3670 @end table |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3671 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3672 You can also define custom commands that will be accessible through the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3673 dispatcher, just like the default commands. This includes the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3674 possibility to create extended agenda buffers that contain several |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3675 blocks together, for example the weekly agenda, the global TODO list and |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3676 a number of special tags matches. @xref{Custom agenda views}. |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3677 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3678 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda views |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3679 @section The built-in agenda views |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3680 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3681 In this section we describe the built-in views. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3682 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3683 @menu |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3684 * Weekly/Daily agenda:: The calendar page with current tasks |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3685 * Global TODO list:: All unfinished action items |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3686 * Matching headline tags:: Structured information with fine-tuned search |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3687 * Timeline:: Time-sorted view for single file |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3688 * Stuck projects:: Find projects you need to review |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3689 @end menu |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3690 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3691 @node Weekly/Daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3692 @subsection The weekly/daily agenda |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3693 @cindex agenda |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3694 @cindex weekly agenda |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3695 @cindex daily agenda |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3696 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3697 The purpose of the weekly/daily @emph{agenda} is to act like a page of a |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3698 paper agenda, showing all the tasks for the current week or day. |
58792 | 3699 |
3700 @table @kbd | |
3701 @cindex org-agenda, command | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3702 @kindex C-c a a |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3703 @item C-c a a |
58792 | 3704 Compile an agenda for the current week from a list of org files. The |
3705 agenda shows the entries for each day. With a @kbd{C-u} prefix (or | |
3706 when the variable @code{org-agenda-include-all-todo} is @code{t}), all | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3707 unfinished TODO items (including those without a date) are also listed at |
58792 | 3708 the beginning of the buffer, before the first date.@* |
3709 @end table | |
3710 | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3711 Remote editing from the agenda buffer means, for example, that you can |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3712 change the dates of deadlines and appointments from the agenda buffer. |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3713 The commands available in the Agenda buffer are listed in @ref{Agenda |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3714 commands}. |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3715 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3716 @subsubheading Calendar/Diary integration |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3717 @cindex calendar integration |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3718 @cindex diary integration |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3719 |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3720 Emacs contains the calendar and diary by Edward M. Reingold. The |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3721 calendar displays a three-month calendar with holidays from different |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3722 countries and cultures. The diary allows you to keep track of |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3723 anniversaries, lunar phases, sunrise/set, recurrent appointments |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3724 (weekly, monthly) and more. In this way, it is quite complementary to |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3725 Org-mode. It can be very useful to combine output from Org-mode with |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3726 the diary. |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3727 |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3728 In order to include entries from the Emacs diary into Org-mode's |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3729 agenda, you only need to customize the variable |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3730 |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3731 @lisp |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3732 (setq org-agenda-include-diary t) |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3733 @end lisp |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3734 |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3735 @noindent After that, everything will happen automatically. All diary |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3736 entries including holidays, anniversaries etc will be included in the |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3737 agenda buffer created by Org-mode. @key{SPC}, @key{TAB}, and |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3738 @key{RET} can be used from the agenda buffer to jump to the diary |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3739 file in order to edit existing diary entries. The @kbd{i} command to |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3740 insert new entries for the current date works in the agenda buffer, as |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3741 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3742 Sunrise/Sunset times, show lunar phases and to convert to other |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3743 calendars, respectively. @kbd{c} can be used to switch back and forth |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3744 between calendar and agenda. |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3745 |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3746 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3747 @node Global TODO list, Matching headline tags, Weekly/Daily agenda, Built-in agenda views |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3748 @subsection The global TODO list |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3749 @cindex global TODO list |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3750 @cindex TODO list, global |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3751 |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3752 The global TODO list contains all unfinished TODO items, formatted and |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3753 collected into a single place. |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3754 |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3755 @table @kbd |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3756 @kindex C-c a t |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3757 @item C-c a t |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3758 Show the global TODO list. This collects the TODO items from all |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
3759 agenda files (@pxref{Agenda views}) into a single buffer. The buffer is in |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3760 @code{agenda-mode}, so there are commands to examine and manipulate |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3761 the TODO entries directly from that buffer (@pxref{Agenda commands}). |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3762 @kindex C-c a T |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3763 @item C-c a T |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3764 @cindex TODO keyword matching |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3765 Like the above, but allows selection of a specific TODO keyword. You can |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3766 also do this by specifying a prefix argument to @kbd{C-c a t}. With a |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3767 @kbd{C-u} prefix you are prompted for a keyword. With a numeric |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3768 prefix, the Nth keyword in @code{org-todo-keywords} is selected. |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3769 @kindex r |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3770 The @kbd{r} key in the agenda buffer regenerates it, and you can give |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3771 a prefix argument to this command to change the selected TODO keyword, |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3772 for example @kbd{3 r}. If you often need a search for a specific |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3773 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@* |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3774 Matching specific TODO keywords can also be done as part of a tags |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3775 search (@pxref{Tag searches}). |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3776 @end table |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3777 |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
3778 Remote editing of TODO items means that you can change the state of a |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3779 TODO entry with a single key press. The commands available in the |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3780 TODO list are described in @ref{Agenda commands}. |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3781 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3782 @cindex sublevels, inclusion into todo list |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3783 Normally the global todo list simply shows all headlines with TODO |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
3784 keywords. This list can become very long. There are two ways to keep |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
3785 it more compact: |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
3786 @itemize @minus |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
3787 @item |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
3788 Some people view a TODO item that has been @emph{scheduled} for |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
3789 execution (@pxref{Time stamps}) as no longer @emph{open}. Configure the |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
3790 variable @code{org-agenda-todo-ignore-scheduled} to exclude scheduled |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
3791 items from the global TODO list. |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
3792 @item |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
3793 TODO items may have sublevels to break up the task into subtasks. In |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
3794 such cases it may be enough to list only the highest level TODO headline |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
3795 and omit the sublevels from the global list. Configure the variable |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
3796 @code{org-agenda-todo-list-sublevels} to get this behavior. |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
3797 @end itemize |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
3798 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3799 @node Matching headline tags, Timeline, Global TODO list, Built-in agenda views |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3800 @subsection Matching headline tags |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3801 @cindex matching, of tags |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3802 @cindex tags view |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3803 |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3804 If headlines in the agenda files are marked with @emph{tags} |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3805 (@pxref{Tags}), you can select headlines based on the tags that apply |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
3806 to them and collect them into an agenda buffer. |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3807 |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3808 @table @kbd |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3809 @kindex C-c a m |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3810 @item C-c a m |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3811 Produce a list of all headlines that match a given set of tags. The |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
3812 command prompts for a selection criterion, which is a boolean logic |
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
3813 expression with tags, like @samp{+WORK+URGENT-WITHBOSS} or |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3814 @samp{WORK|HOME} (@pxref{Tags}). If you often need a specific search, |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3815 define a custom command for it (@pxref{Agenda dispatcher}). |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3816 @kindex C-c a M |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3817 @item C-c a M |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3818 Like @kbd{C-c a m}, but only select headlines that are also TODO items |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3819 and force checking subitems (see variable |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3820 @code{org-tags-match-list-sublevels}). Matching specific todo keywords |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3821 together with a tags match is also possible, see @ref{Tag searches}. |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3822 @end table |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3823 |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3824 The commands available in the tags list are described in @ref{Agenda |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3825 commands}. |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3826 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3827 @node Timeline, Stuck projects, Matching headline tags, Built-in agenda views |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3828 @subsection Timeline for a single file |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3829 @cindex timeline, single file |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3830 @cindex time-sorted view |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3831 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3832 The timeline summarizes all time-stamped items from a single Org-mode |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3833 file in a @emph{time-sorted view}. The main purpose of this command is |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3834 to give an overview over events in a project. |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3835 |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3836 @table @kbd |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3837 @kindex C-a a L |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3838 @item C-c a L |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3839 Show a time-sorted view of the org file, with all time-stamped items. |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3840 When called with a @kbd{C-u} prefix, all unfinished TODO entries |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3841 (scheduled or not) are also listed under the current date. |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3842 @end table |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3843 |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3844 @noindent |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3845 The commands available in the timeline buffer are listed in |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3846 @ref{Agenda commands}. |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3847 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3848 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3849 @node Stuck projects, , Timeline, Built-in agenda views |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3850 @subsection Stuck projects |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3851 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3852 If you are following a system like David Allen's GTD to organize your |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3853 work, one of the ``duties'' you have is a regular review to make sure |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3854 that all projects move along. A @emph{stuck} project is a project that |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3855 has no defined next actions, so it will never show up in the TODO lists |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3856 Org-mode produces. During the review, you need to identify such |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3857 projects and define next actions for them. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3858 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3859 @table @kbd |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3860 @kindex C-c a # |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3861 @item C-c a # |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3862 List projects that are stuck. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3863 @kindex C-c a ! |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3864 @item C-c a ! |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3865 Customize the variable @code{org-stuck-projects} to define what a stuck |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3866 project is and how to find it. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3867 @end table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3868 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3869 You almost certainly will have to configure this view before it will |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3870 work for you. The built-in default assumes that all your projects are |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3871 level-2 headlines, and that a project is not stuck if it has at least |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3872 one entry marked with a todo keyword TODO or NEXT or NEXTACTION. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3873 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3874 Lets assume that you, in your own way of using Org-mode, identify |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3875 projects with a tag PROJECT, and that you use a todo keyword MAYBE to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3876 indicate a project that should not be considered yet. Lets further |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3877 assume that the todo keyword DONE marks finished projects, and that NEXT |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3878 and TODO indicate next actions. Finally, the tag @@SHOP indicates |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3879 shopping and is a next action even without the NEXT tag. In this case |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3880 you would start by identifying eligible projects with a tags/todo match |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3881 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT and @@SHOP in |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3882 the subtree to identify projects that are not stuck. The correct |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3883 customization for this is |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3884 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3885 @lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3886 (setq org-stuck-projects |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3887 ("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP"))) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3888 @end lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3889 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3890 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3891 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda views |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3892 @section Presentation and sorting |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3893 @cindex presentation, of agenda items |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3894 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3895 Before displaying items in an agenda view, Org-mode visually prepares |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3896 the items and sorts them. Each item occupies a single line. The line |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3897 starts with a @emph{prefix} that contains the @emph{category} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3898 (@pxref{Categories}) of the item and other important information. You can |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3899 customize the prefix using the option @code{org-agenda-prefix-format}. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3900 The prefix is followed by a cleaned-up version of the outline headline |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3901 associated with the item. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3902 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3903 @menu |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3904 * Categories:: Not all tasks are equal |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3905 * Time-of-day specifications:: How the agenda knows the time |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3906 * Sorting of agenda items:: The order of things |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3907 @end menu |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3908 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3909 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3910 @subsection Categories |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3911 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3912 @cindex category |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3913 The category is a broad label assigned to each agenda item. By default, |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3914 the category is simply derived from the file name, but you can also |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3915 specify it with a special line in the buffer, like this: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3916 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3917 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3918 #+CATEGORY: Thesis |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3919 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3920 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3921 If there are several such lines in a file, each specifies the category |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3922 for the text below it (but the first category also applies to any text |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3923 before the first CATEGORY line). The display in the agenda buffer looks |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3924 best if the category is not longer than 10 characters. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3925 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3926 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3927 @subsection Time-of-Day Specifications |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3928 @cindex time-of-day specification |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3929 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3930 Org-mode checks each agenda item for a time-of-day specification. The |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3931 time can be part of the time stamp that triggered inclusion into the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3932 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3933 ranges can be specified with two time stamps, like |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3934 @c |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3935 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3936 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3937 In the headline of the entry itself, a time(range) may also appear as |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3938 plain text (like @samp{12:45} or a @samp{8:30-1pm}. If the agenda |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3939 integrates the Emacs diary (@pxref{Weekly/Daily agenda}), time |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3940 specifications in diary entries are recognized as well. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3941 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3942 For agenda display, Org-mode extracts the time and displays it in a |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3943 standard 24 hour format as part of the prefix. The example times in |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3944 the previous paragraphs would end up in the agenda like this: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3945 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3946 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3947 8:30-13:00 Arthur Dent lies in front of the bulldozer |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3948 12:45...... Ford Prefect arrives and takes Arthur to the pub |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3949 19:00...... The Vogon reads his poem |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3950 20:30-22:15 Marwin escorts the Hitchhikers to the bridge |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3951 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3952 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3953 @cindex time grid |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3954 If the agenda is in single-day mode, or for the display of today, the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3955 timed entries are embedded in a time grid, like |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3956 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3957 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3958 8:00...... ------------------ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3959 8:30-13:00 Arthur Dent lies in front of the bulldozer |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3960 10:00...... ------------------ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3961 12:00...... ------------------ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3962 12:45...... Ford Prefect arrives and takes Arthur to the pub |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3963 14:00...... ------------------ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3964 16:00...... ------------------ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3965 18:00...... ------------------ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3966 19:00...... The Vogon reads his poem |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3967 20:00...... ------------------ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3968 20:30-22:15 Marwin escorts the Hitchhikers to the bridge |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3969 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3970 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3971 The time grid can be turned on and off with the variable |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3972 @code{org-agenda-use-time-grid}, and can be configured with |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3973 @code{org-agenda-time-grid}. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3974 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3975 @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3976 @subsection Sorting of agenda items |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3977 @cindex sorting, of agenda items |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3978 @cindex priorities, of agenda items |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3979 Before being inserted into a view, the items are sorted. How this is |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3980 done depends on the type of view. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3981 @itemize @bullet |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3982 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3983 For the daily/weekly agenda, the items for each day are sorted. The |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3984 default order is to first collect all items containing an explicit |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3985 time-of-day specification. These entries will be shown at the beginning |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3986 of the list, as a @emph{schedule} for the day. After that, items remain |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3987 grouped in categories, in the sequence given by @code{org-agenda-files}. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3988 Within each category, items are sorted by priority (@pxref{Priorities}), |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3989 which is composed of the base priority (2000 for priority @samp{A}, 1000 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3990 for @samp{B}, and 0 for @samp{C}), plus additional increments for |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3991 overdue scheduled or deadline items. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3992 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3993 For the TODO list, items remain in the order of categories, but within |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3994 each category, sorting takes place according to priority |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3995 (@pxref{Priorities}). |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3996 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3997 For tags matches, items are not sorted at all, but just appear in the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3998 sequence in which they are found in the agenda files. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3999 @end itemize |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4000 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4001 Sorting can be customized using the variable |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4002 @code{org-agenda-sorting-strategy}. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4003 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4004 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4005 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda views |
58792 | 4006 @section Commands in the agenda buffer |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4007 @cindex commands, in agenda buffer |
58792 | 4008 |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4009 Entries in the agenda buffer are linked back to the org file or diary |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4010 file where they originate. You are not allowed to edit the agenda |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4011 buffer itself, but commands are provided to show and jump to the |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4012 original entry location, and to edit the org-files ``remotely'' from |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4013 the agenda buffer. In this way, all information is stored only once, |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4014 removing the risk that your agenda and note files may diverge. |
58792 | 4015 |
4016 Some commands can be executed with mouse clicks on agenda lines. For | |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4017 the other commands, the cursor needs to be in the desired line. |
58792 | 4018 |
4019 @table @kbd | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4020 @tsubheading{Motion} |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4021 @cindex motion commands in agenda |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4022 @kindex n |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4023 @item n |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4024 Next line (same as @key{up}). |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4025 @kindex p |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4026 @item p |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4027 Previous line (same as @key{down}). |
58792 | 4028 @tsubheading{View/GoTo org file} |
4029 @kindex mouse-3 | |
4030 @kindex @key{SPC} | |
4031 @item mouse-3 | |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
4032 @itemx @key{SPC} |
58792 | 4033 Display the original location of the item in another window. |
4034 | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4035 @kindex L |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4036 @item L |
58792 | 4037 Display original location and recenter that window. |
4038 | |
4039 @kindex mouse-2 | |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
4040 @kindex mouse-1 |
58792 | 4041 @kindex @key{TAB} |
4042 @item mouse-2 | |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
4043 @itemx mouse-1 |
58792 | 4044 @itemx @key{TAB} |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
4045 Go to the original location of the item in another window. Under Emacs |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4046 22, @kbd{mouse-1} will also works for this. |
58792 | 4047 |
4048 @kindex @key{RET} | |
4049 @itemx @key{RET} | |
4050 Go to the original location of the item and delete other windows. | |
4051 | |
4052 @kindex f | |
4053 @item f | |
67537
f0c77dab544c
(Progress Logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
67382
diff
changeset
|
4054 Toggle Follow mode. In Follow mode, as you move the cursor through |
58792 | 4055 the agenda buffer, the other window always shows the corresponding |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4056 location in the org file. The initial setting for this mode in new |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4057 agenda buffers can be set with the variable |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4058 @code{org-agenda-start-with-follow-mode}. |
58792 | 4059 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4060 @kindex b |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4061 @item b |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4062 Display the entire subtree of the current item in an indirect buffer. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4063 With numerical prefix ARG, go up to this level and then take that tree. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4064 If ARG is negative, go up that many levels. With @kbd{C-u} prefix, do |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4065 not remove the previously used indirect buffer. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4066 |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4067 @kindex l |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4068 @item l |
67537
f0c77dab544c
(Progress Logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
67382
diff
changeset
|
4069 Toggle Logbook mode. In Logbook mode, entries that where marked DONE while |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4070 logging was on (variable @code{org-log-done}) are shown in the agenda, |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4071 as are entries that have been clocked on that day. |
67537
f0c77dab544c
(Progress Logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
67382
diff
changeset
|
4072 |
58792 | 4073 @tsubheading{Change display} |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4074 @cindex display changing, in agenda |
58792 | 4075 @kindex o |
4076 @item o | |
4077 Delete other windows. | |
4078 | |
4079 @kindex w | |
4080 @item w | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4081 Switch to weekly view (7 days displayed together). |
58792 | 4082 |
4083 @kindex d | |
4084 @item d | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4085 Switch to daily view (just one day displayed). |
63833 | 4086 |
4087 @kindex D | |
4088 @item D | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4089 Toggle the inclusion of diary entries. See @ref{Weekly/Daily agenda}. |
58792 | 4090 |
62548 | 4091 @kindex g |
4092 @item g | |
4093 Toggle the time grid on and off. See also the variables | |
4094 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}. | |
4095 | |
58792 | 4096 @kindex r |
4097 @item r | |
4098 Recreate the agenda buffer, for example to reflect the changes | |
4099 after modification of the time stamps of items with S-@key{left} and | |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
4100 S-@key{right}. When the buffer is the global todo list, a prefix |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
4101 argument is interpreted to create a selective list for a specific TODO |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
4102 keyword. |
58792 | 4103 |
71564
947e64a6bc0e
(Agenda commands): Document `s' key to save all
Carsten Dominik <dominik@science.uva.nl>
parents:
71525
diff
changeset
|
4104 @kindex s |
947e64a6bc0e
(Agenda commands): Document `s' key to save all
Carsten Dominik <dominik@science.uva.nl>
parents:
71525
diff
changeset
|
4105 @item s |
947e64a6bc0e
(Agenda commands): Document `s' key to save all
Carsten Dominik <dominik@science.uva.nl>
parents:
71525
diff
changeset
|
4106 Save all Org-mode buffers in the current Emacs session. |
947e64a6bc0e
(Agenda commands): Document `s' key to save all
Carsten Dominik <dominik@science.uva.nl>
parents:
71525
diff
changeset
|
4107 |
58792 | 4108 @kindex @key{right} |
4109 @item @key{right} | |
4110 Display the following @code{org-agenda-ndays} days. For example, if | |
4111 the display covers a week, switch to the following week. With prefix | |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4112 arg, go forward that many times @code{org-agenda-ndays} days. |
58792 | 4113 |
4114 @kindex @key{left} | |
4115 @item @key{left} | |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4116 Display the previous dates. |
58792 | 4117 |
4118 @kindex . | |
4119 @item . | |
4120 Goto today. | |
4121 | |
4122 @tsubheading{Remote editing} | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4123 @cindex remote editing, from agenda |
58792 | 4124 |
4125 @item 0-9 | |
4126 Digit argument. | |
4127 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4128 @cindex undoing remote-editing events |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4129 @cindex remote editing, undo |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4130 @kindex C-_ |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4131 @item C-_ |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4132 Undo a change due to a remote editing command. The change is undone |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4133 both in the agenda buffer and in the remote buffer. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4134 |
58792 | 4135 @kindex t |
4136 @item t | |
4137 Change the TODO state of the item, both in the agenda and in the | |
4138 original org file. | |
4139 | |
74030 | 4140 @kindex C-k |
4141 @item C-k | |
4142 Delete the current agenda item along with the entire subtree belonging | |
4143 to it in the original Org-mode file. If the text to be deleted remotely | |
4144 is longer than one line, the kill needs to be confirmed by the user. See | |
4145 variable @code{org-agenda-confirm-kill}. | |
4146 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4147 @kindex $ |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4148 @item $ |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4149 Archive the subtree corresponding to the current headline. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4150 |
68173
73b14864a9b7
(Agenda commands): Document tags command.
Carsten Dominik <dominik@science.uva.nl>
parents:
68060
diff
changeset
|
4151 @kindex T |
73b14864a9b7
(Agenda commands): Document tags command.
Carsten Dominik <dominik@science.uva.nl>
parents:
68060
diff
changeset
|
4152 @item T |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4153 Show all tags associated with the current item. Because of |
68173
73b14864a9b7
(Agenda commands): Document tags command.
Carsten Dominik <dominik@science.uva.nl>
parents:
68060
diff
changeset
|
4154 inheritance, this may be more than the tags listed in the line itself. |
73b14864a9b7
(Agenda commands): Document tags command.
Carsten Dominik <dominik@science.uva.nl>
parents:
68060
diff
changeset
|
4155 |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
4156 @kindex : |
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
4157 @item : |
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
4158 Set tags for the current headline. |
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
4159 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4160 @kindex a |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4161 @item a |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4162 Toggle the ARCHIVE tag for the current headline. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4163 |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4164 @kindex , |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4165 @item , |
58792 | 4166 Set the priority for the current item. Org-mode prompts for the |
4167 priority character. If you reply with @key{SPC}, the priority cookie | |
4168 is removed from the entry. | |
4169 | |
4170 @kindex P | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4171 @item P |
58792 | 4172 Display weighted priority of current item. |
4173 | |
4174 @kindex + | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4175 @kindex S-@key{up} |
58792 | 4176 @item + |
63833 | 4177 @itemx S-@key{up} |
58792 | 4178 Increase the priority of the current item. The priority is changed in |
4179 the original buffer, but the agenda is not resorted. Use the @kbd{r} | |
4180 key for this. | |
4181 | |
4182 @kindex - | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4183 @kindex S-@key{down} |
58792 | 4184 @item - |
63833 | 4185 @itemx S-@key{down} |
58792 | 4186 Decrease the priority of the current item. |
4187 | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4188 @kindex C-c C-s |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4189 @item C-c C-s |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4190 Schedule this item |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4191 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4192 @kindex C-c C-d |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4193 @item C-c C-d |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4194 Set a deadline for this item. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4195 |
58792 | 4196 @kindex S-@key{right} |
4197 @item S-@key{right} | |
4198 Change the time stamp associated with the current line by one day into | |
4199 the future. With prefix argument, change it by that many days. For | |
4200 example, @kbd{3 6 5 S-@key{right}} will change it by a year. The | |
4201 stamp is changed in the original org file, but the change is not | |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
4202 directly reflected in the agenda buffer. Use the |
58792 | 4203 @kbd{r} key to update the buffer. |
4204 | |
4205 @kindex S-@key{left} | |
4206 @item S-@key{left} | |
4207 Change the time stamp associated with the current line by one day | |
4208 into the past. | |
4209 | |
4210 @kindex > | |
4211 @item > | |
4212 Change the time stamp associated with the current line to today. | |
4213 The key @kbd{>} has been chosen, because it is the same as @kbd{S-.} | |
4214 on my keyboard. | |
4215 | |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4216 @kindex I |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4217 @item I |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4218 Start the clock on the current item. If a clock is running already, it |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4219 is stopped first. |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4220 @kindex O |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4221 @item O |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4222 Stop the previously started clock. |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4223 @kindex X |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4224 @item X |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4225 Cancel the currently running clock. |
58792 | 4226 |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4227 @tsubheading{Calendar commands} |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4228 @cindex calendar commands, from agenda |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4229 @kindex c |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4230 @item c |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4231 Open the Emacs calendar and move to the date at the agenda cursor. |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4232 |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4233 @item c |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4234 When in the calendar, compute and show the Org-mode agenda for the |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4235 date at the cursor. |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4236 |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4237 @cindex diary entries, creating from agenda |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4238 @kindex i |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4239 @item i |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4240 Insert a new entry into the diary. Prompts for the type of entry |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4241 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4242 entry in the diary, just as @kbd{i d} etc. would do in the calendar. |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4243 The date is taken from the cursor position. |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4244 |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4245 @kindex M |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4246 @item M |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4247 Show the phases of the moon for the three months around current date. |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4248 |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4249 @kindex S |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4250 @item S |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4251 Show sunrise and sunset times. The geographical location must be set |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4252 with calendar variables, see documentation of the Emacs calendar. |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4253 |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4254 @kindex C |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4255 @item C |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4256 Convert the date at cursor into many other cultural and historic |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4257 calendars. |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4258 |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4259 @kindex H |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4260 @item H |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4261 Show holidays for three month around the cursor date. |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4262 |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4263 @c FIXME: This should be a different key. |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4264 @kindex C-c C-x C-c |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4265 @item C-c C-x C-c |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4266 Export a single iCalendar file containing entries from all agenda files. |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4267 |
58792 | 4268 @tsubheading{Quit and Exit} |
4269 @kindex q | |
4270 @item q | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4271 Quit agenda, remove the agenda buffer. |
58792 | 4272 |
4273 @kindex x | |
4274 @cindex agenda files, removing buffers | |
4275 @item x | |
4276 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs | |
4277 for the compilation of the agenda. Buffers created by the user to | |
4278 visit org files will not be removed. | |
4279 | |
4280 @end table | |
4281 | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4282 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4283 @node Custom agenda views, , Agenda commands, Agenda views |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4284 @section Custom agenda views |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4285 @cindex custom agenda views |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4286 @cindex agenda views, custom |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4287 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4288 Custom agenda commands serve two purposes: to store and quickly access |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4289 frequently used TODO and tags searches, and to create special composite |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4290 agenda buffers. Custom agenda commands will be accessible through the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4291 dispatcher (@pxref{Agenda dispatcher}), just like the default commands. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4292 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4293 @menu |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4294 * Storing searches:: Type once, use often |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4295 * Block agenda:: All the stuff you need in a single buffer |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4296 * Setting Options:: Changing the rules |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4297 * Batch processing:: Agenda views from the command line |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4298 @end menu |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4299 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4300 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4301 @subsection Storing searches |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4302 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4303 The first application of custom searches is the definition of keyboard |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4304 shortcuts for frequently used searches, either creating an agenda |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4305 buffer, or a sparse tree (the latter covering of course only the current |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4306 buffer). |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4307 @kindex C-c a C |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4308 Custom commands are configured in the variable |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4309 @code{org-agenda-custom-commands}. You can customize this variable, for |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4310 example by pressing @kbd{C-c a C}. You can also directly set it with |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4311 Emacs Lisp in @file{.emacs}. The following example contains all valid |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4312 search types: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4313 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4314 @lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4315 @group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4316 (setq org-agenda-custom-commands |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4317 '(("w" todo "WAITING") |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4318 ("W" todo-tree "WAITING") |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4319 ("u" tags "+BOSS-URGENT") |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4320 ("v" tags-todo "+BOSS-URGENT") |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4321 ("U" tags-tree "+BOSS-URGENT") |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4322 ("f" occur-tree "\\<FIXME\\>"))) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4323 @end group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4324 @end lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4325 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4326 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4327 The initial single-character string in each entry defines the character |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4328 you have to press after the dispatcher command @kbd{C-c a} in order to |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4329 access the command. The second parameter is the search type, followed |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4330 by the string or regular expression to be used for the matching. The |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4331 example above will therefore define: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4332 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4333 @table @kbd |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4334 @item C-c a w |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4335 as a global search for TODO entries with @samp{WAITING} as the TODO |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4336 keyword |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4337 @item C-c a W |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4338 as the same search, but only in the current buffer and displaying the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4339 results as a sparse tree |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4340 @item C-c a u |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4341 as a global tags search for headlines marked @samp{:BOSS:} but not |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4342 @samp{:URGENT:} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4343 @item C-c a v |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4344 as the same search as @kbd{C-c a u}, but limiting the search to |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4345 headlines that are also TODO items |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4346 @item C-c a U |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4347 as the same search as @kbd{C-c a u}, but only in the current buffer and |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4348 displaying the result as a sparse tree |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4349 @item C-c a f |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4350 to create a sparse tree (again: current buffer only) with all entries |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4351 containing the word @samp{FIXME}. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4352 @end table |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4353 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4354 @node Block agenda, Setting Options, Storing searches, Custom agenda views |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4355 @subsection Block agenda |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4356 @cindex block agenda |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4357 @cindex agenda, with block views |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4358 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4359 Another possibility is the construction of agenda views that comprise |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4360 the results of @emph{several} commands, each of which creates a block in |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4361 the agenda buffer. The available commands include @code{agenda} for the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4362 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4363 for the global todo list (as constructed with @kbd{C-c a t}), and the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4364 matching commands discussed above: @code{todo}, @code{tags}, and |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4365 @code{tags-todo}. Here are two examples: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4366 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4367 @lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4368 @group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4369 (setq org-agenda-custom-commands |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4370 '(("h" "Agenda and Home-related tasks" |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4371 ((agenda) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4372 (tags-todo "HOME") |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4373 (tags "GARDEN"))) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4374 ("o" "Agenda and Office-related tasks" |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4375 ((agenda) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4376 (tags-todo "WORK") |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4377 (tags "OFFICE"))))) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4378 @end group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4379 @end lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4380 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4381 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4382 This will define @kbd{C-c a h} to create a multi-block view for stuff |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4383 you need to attend to at home. The resulting agenda buffer will contain |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4384 your agenda for the current week, all TODO items that carry the tag |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4385 @samp{HOME}, and also all lines tagged with @samp{GARDEN}. Finally the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4386 command @kbd{C-c a o} provides a similar view for office tasks. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4387 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4388 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4389 @node Setting Options, Batch processing, Block agenda, Custom agenda views |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4390 @subsection Setting Options for custom commands |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4391 @cindex options, for custom agenda views |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4392 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4393 Org-mode contains a number of variables regulating agenda construction |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4394 and display. The global variables define the behavior for all agenda |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4395 commands, including the custom commands. However, if you want to change |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4396 some settings just for a single custom view, you can do so. Setting |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4397 options requires inserting a list of variable names and values at the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4398 right spot in @code{org-agenda-custom-commands}. For example: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4399 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4400 @lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4401 @group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4402 (setq org-agenda-custom-commands |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4403 '(("w" todo "WAITING" |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4404 ((org-agenda-sorting-strategy '(priority-down)) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4405 (org-agenda-prefix-format " Mixed: "))) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4406 ("U" tags-tree "+BOSS-URGENT" |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4407 ((org-show-following-heading nil) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4408 (org-show-hierarchy-above nil))))) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4409 @end group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4410 @end lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4411 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4412 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4413 Now the @kbd{C-c a w} command will sort the collected entries only by |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4414 priority, and the prefix format is modified to just say @samp{ Mixed:} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4415 instead of giving the category of the entry. The sparse tags tree of |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4416 @kbd{C-c a U} will now turn out ultra-compact, because neither the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4417 headline hierarchy above the match, nor the headline following the match |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4418 will be shown. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4419 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4420 For command sets creating a block agenda, |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4421 @code{org-agenda-custom-commands} has two separate spots for setting |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4422 options. You can add options that should be valid for just a single |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4423 command in the set, and options that should be valid for all commands in |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4424 the set. The former are just added to the command entry, the latter |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4425 must come after the list of command entries. Going back to the block |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4426 agenda example (@pxref{Block agenda}), let's change the sorting strategy |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4427 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4428 the results for GARDEN tags query in the opposite order, |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4429 @code{priority-up}. This would look like this: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4430 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4431 @lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4432 @group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4433 (setq org-agenda-custom-commands |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4434 '(("h" "Agenda and Home-related tasks" |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4435 ((agenda) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4436 (tags-todo "HOME") |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4437 (tags "GARDEN" ((org-agenda-sorting-strategy '(priority-up))))) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4438 ((org-agenda-sorting-strategy '(priority-down)))) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4439 ("o" "Agenda and Office-related tasks" |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4440 ((agenda) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4441 (tags-todo "WORK") |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4442 (tags "OFFICE"))))) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4443 @end group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4444 @end lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4445 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4446 As you see, the values and parenthesis setting is a little complex. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4447 When in doubt, use the customize interface to set this variable - it |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4448 fully supports its structure. Just one caveat: When setting options in |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4449 this interface, the @emph{values} are just lisp expressions. So if the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4450 value is a string, you need to add the double quotes around the value |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4451 yourself. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4452 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4453 @node Batch processing, , Setting Options, Custom agenda views |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4454 @subsection Creating agenda views in batch processing |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4455 @cindex agenda, batch production |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4456 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4457 If you want to print or otherwise reprocess agenda views, it can be |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4458 useful to create an agenda from the command line. This is the purpose |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4459 of the function @code{org-batch-agenda}. It takes as a parameter one of |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4460 the strings that are the keys in @code{org-agenda-custom-commands}. For |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4461 example, to directly print the current TODO list, you could use |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4462 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4463 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4464 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4465 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4466 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4467 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4468 You may also modify parameters on the fly like this: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4469 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4470 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4471 emacs -batch -l ~/.emacs \ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4472 -eval '(org-batch-agenda "a" \ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4473 org-agenda-ndays 300 \ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4474 org-agenda-include-diary nil \ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4475 org-agenda-files (quote ("~/org/project.org")))' \ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4476 | lpr |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4477 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4478 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4479 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4480 which will produce a 300 day agenda, fully restricted to the Org file |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4481 @file{~/org/projects.org}, not even including the diary. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4482 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4483 @node Embedded LaTeX, Exporting, Agenda views, Top |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4484 @chapter Embedded LaTeX |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4485 @cindex @TeX{} interpretation |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4486 @cindex La@TeX{} interpretation |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4487 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4488 Plain ASCII is normally sufficient for almost all note taking. One |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4489 exception, however, are scientific notes which need to be able to |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4490 contain mathematical symbols and the occasional formula. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4491 La@TeX{}@footnote{La@TeX{} is a macro system based on Donald E. Knuth's |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4492 @TeX{} system. Many of the features described here as ``La@TeX{}'' are |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4493 really from @TeX{}, but for simplicity I am blurring this distinction.} |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4494 is widely used to typeset scientific documents. Org-mode supports |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4495 embedding La@TeX{} code into its files, because many academics are used |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4496 to read La@TeX{} source code, and because it can be readily processed |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4497 into images for HTML production. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4498 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4499 It is not necessary to mark La@TeX{} macros and code in any special way. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4500 If you observe a few conventions, Org-mode knows how to find it and what |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4501 to do with it. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4502 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4503 @menu |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4504 * Math symbols:: TeX macros for symbols and Greek letters |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4505 * Subscripts and Superscripts:: Simple syntax for raising/lowering text |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4506 * LaTeX fragments:: Complex formulas made easy |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4507 * Processing LaTeX fragments:: Previewing LaTeX processing |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4508 * CDLaTeX mode:: Speed up entering of formulas |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4509 @end menu |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4510 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4511 @node Math symbols, Subscripts and Superscripts, Embedded LaTeX, Embedded LaTeX |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4512 @section Math symbols |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4513 @cindex math symbols |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4514 @cindex TeX macros |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4515 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4516 You can use La@TeX{} macros to insert special symbols like @samp{\alpha} |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4517 to indicate the Greek letter, or @samp{\to} to indicate an arrow. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4518 Completion for these macros is available, just type @samp{\} and maybe a |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4519 few letters, and press @kbd{M-@key{TAB}} to see possible completions. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4520 Unlike La@TeX{} code, Org-mode allows these macros to be present |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4521 without surrounding math delimiters, for example: |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4522 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4523 @example |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4524 Angles are written as Greek letters \alpha, \beta and \gamma. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4525 @end example |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4526 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4527 During HTML export (@pxref{HTML export}), these symbols are translated |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4528 into the proper syntax for HTML, for the above examples this is |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4529 @samp{α} and @samp{→}, respectively. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4530 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4531 @node Subscripts and Superscripts, LaTeX fragments, Math symbols, Embedded LaTeX |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4532 @section Subscripts and Superscripts |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4533 @cindex subscript |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4534 @cindex superscript |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4535 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4536 Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super- |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4537 and subscripts. Again, these can be used without embedding them in |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4538 math-mode delimiters. To increase the readability of ASCII text, it is |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4539 not necessary (but OK) to surround multi-character sub- and superscripts |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4540 with curly braces. For example |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4541 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4542 @example |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
4543 The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4544 the sun is R_@{sun@} = 6.96 x 10^8 m. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4545 @end example |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4546 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4547 To avoid interpretation as raised or lowered text, you can quote |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4548 @samp{^} and @samp{_} with a backslash: @samp{\_} and @samp{\^}. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4549 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4550 During HTML export (@pxref{HTML export}), subscript and superscripts |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4551 are surrounded with @code{<sub>} and @code{<sup>} tags, respectively. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4552 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4553 @node LaTeX fragments, Processing LaTeX fragments, Subscripts and Superscripts, Embedded LaTeX |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4554 @section LaTeX fragments |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4555 @cindex LaTeX fragments |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4556 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4557 With symbols, sub- and superscripts, HTML is pretty much at its end when |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4558 it comes to representing mathematical formulas@footnote{Yes, there is |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4559 MathML, but that is not yet fully supported by many browsers, and there |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4560 is no decent converter for turning LaTeX of ASCII representations of |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4561 formulas into MathML. So for the time being, converting formulas into |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4562 images seems the way to go.}. More complex |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4563 expressions need a dedicated formula processor. To this end, Org-mode |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4564 can contain arbitrary La@TeX{} fragments. It provides commands to |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4565 preview the typeset result of these fragments, and upon export to HTML, |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4566 all fragments will be converted to images and inlined into the HTML |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4567 document. For this to work you need to be on a system with a working |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4568 La@TeX{} installation. You also need the @file{dvipng} program, |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4569 available at @url{http://sourceforge.net/projects/dvipng/}. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4570 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4571 La@TeX{} fragments don't need any special marking at all. The following |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4572 snippets will be identified as LaTeX source code: |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4573 @itemize @bullet |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4574 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4575 Environments of any kind. The only requirement is that the |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
4576 @code{\begin} statement appears on a new line, preceded by only |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4577 whitespace. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4578 @item |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
4579 Text within the usual La@TeX{} math delimiters. To avoid conflicts with |
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
4580 currency specifications, single @samp{$} characters are only recognized |
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
4581 as math delimiters if the enclosed text contains at most two line breaks, |
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
4582 is directly attached to the @samp{$} characters with no whitespace in |
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
4583 between, and if the closing @samp{$} is followed by whitespace or |
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
4584 punctuation. For the other delimiters, there is no such restriction, so |
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
4585 when in doubt, use @samp{\(...\)} as inline math delimiters. |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4586 @end itemize |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4587 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4588 @noindent For example: |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4589 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4590 @example |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4591 \begin@{equation@} % arbitrary environments, |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4592 x=\sqrt@{b@} % even tables, figures |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4593 \end@{equation@} % etc |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4594 |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
4595 If $a^2=b$ and \( b=2 \), then the solution must be |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4596 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \]. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4597 @end example |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4598 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4599 @noindent |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4600 If you need any of the delimiter ASCII sequences for other purposes, you |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4601 can configure the option @code{org-format-latex-options} to deselect the |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4602 ones you do not wish to have interpreted by the La@TeX{} converter. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4603 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4604 @node Processing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4605 @section Processing LaTeX fragments |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4606 @cindex LaTeX fragments, preview |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4607 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4608 La@TeX{} fragments can be processed to produce a preview images of the |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4609 typeset expressions: |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4610 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4611 @table @kbd |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4612 @kindex C-c C-x C-l |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4613 @item C-c C-x C-l |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4614 Produce a preview image of the La@TeX{} fragment at point and overlay it |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4615 over the source code. If there is no fragment at point, process all |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4616 fragments in the current entry (between two headlines). When called |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4617 with a prefix argument, process the entire subtree. When called with |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4618 two prefix arguments, or when the cursor is before the first headline, |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4619 process the entire buffer. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4620 @kindex C-c C-c |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4621 @item C-c C-c |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4622 Remove the overlay preview images. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4623 @end table |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4624 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4625 During HTML export (@pxref{HTML export}), all La@TeX{} fragments are |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4626 converted into images and inlined into the document if the following |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4627 setting is active: |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4628 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4629 @lisp |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4630 (setq org-export-with-LaTeX-fragments t) |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4631 @end lisp |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4632 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4633 @node CDLaTeX mode, , Processing LaTeX fragments, Embedded LaTeX |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4634 @section Using CDLaTeX to enter math |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4635 @cindex CDLaTeX |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4636 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4637 CDLaTeX-mode is a minor mode that is normally used in combination with a |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4638 major LaTeX mode like AUCTeX in order to speed-up insertion of |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4639 environments and math templates. Inside Org-mode, you can make use of |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
4640 some of the features of cdlatex-mode. You need to install |
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
4641 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with |
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
4642 AUCTeX) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}. |
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
4643 Don't turn cdlatex-mode itself under Org-mode, but use the light |
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
4644 version @code{org-cdlatex-mode} that comes as part of Org-mode. Turn it |
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
4645 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4646 Org-mode files with |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4647 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4648 @lisp |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4649 (add-hook 'org-mode-hook 'turn-on-org-cdlatex) |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4650 @end lisp |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4651 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4652 When this mode is enabled, the following features are present (for more |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4653 details see the documentation of cdlatex-mode): |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4654 @itemize @bullet |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4655 @kindex C-c @{ |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4656 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4657 Environment templates can be inserted with @kbd{C-c @{}. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4658 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4659 @kindex @key{TAB} |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4660 The @key{TAB} key will do template expansion if the cursor is inside a |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
4661 LaTeX fragment@footnote{Org-mode has a method to test if the cursor is |
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
4662 inside such a fragment, see the documentation of the function |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4663 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4664 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4665 correctly inside the first brace. Another @key{TAB} will get you into |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4666 the second brace. Even outside fragments, @key{TAB} will expand |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4667 environment abbreviations at the beginning of a line. For example, if |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4668 you write @samp{equ} at the beginning of a line and press @key{TAB}, |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4669 this abbreviation will be expanded to an @code{equation} environment. |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
4670 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}. |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4671 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4672 @kindex _ |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4673 @kindex ^ |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4674 Pressing @kbd{_} and @kbd{^} inside a LaTeX fragment will insert these |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4675 characters together with a pair of braces. If you use @key{TAB} to move |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4676 out of the braces, and if the braces surround only a single character or |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4677 macro, they are removed again (depending on the variable |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4678 @code{cdlatex-simplify-sub-super-scripts}). |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4679 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4680 @kindex ` |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4681 Pressing the backquote @kbd{`} followed by a character inserts math |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4682 macros, also outside LaTeX fragments. If you wait more than 1.5 seconds |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4683 after the backquote, a help window will pop up. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4684 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4685 @kindex ' |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4686 Pressing the normal quote @kbd{'} followed by another character modifies |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4687 the symbol before point with an accent or a font. If you wait more than |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4688 1.5 seconds after the backquote, a help window will pop up. Character |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4689 modification will work only inside La@TeX{} fragments, outside the quote |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4690 is normal. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4691 @end itemize |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4692 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4693 @node Exporting, Publishing, Embedded LaTeX, Top |
58792 | 4694 @chapter Exporting |
4695 @cindex exporting | |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4696 |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4697 Org-mode documents can be exported into a variety of other formats. For |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4698 printing and sharing of notes, ASCII export produces a readable and |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4699 simple version of an Org-mode file. HTML export allows you to publish a |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4700 notes file on the web, while the XOXO format provides a solid base for |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4701 exchange with a broad range of other applications. To incorporate |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4702 entries with associated times like deadlines or appointments into a |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4703 desktop calendar program like iCal, Org-mode can also produce extracts |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4704 in the iCalendar format. Currently Org-mode only supports export, not |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4705 import of these different formats. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4706 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4707 When exporting, Org-mode uses special conventions to enrich the output |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4708 produced. @xref{Text interpretation}, for more details. |
58792 | 4709 |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4710 @table @kbd |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4711 @kindex C-c C-e |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4712 @item C-c C-e |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4713 Dispatcher for export and publishing commands. Displays a help-window |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4714 listing the additional key(s) needed to launch an export or publishing |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4715 command. |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4716 @end table |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4717 |
58792 | 4718 @menu |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4719 * ASCII export:: Exporting to plain ASCII |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4720 * HTML export:: Exporting to HTML |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4721 * XOXO export:: Exporting to XOXO |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4722 * iCalendar export:: Exporting in iCalendar format |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4723 * Text interpretation:: How the exporter looks at the file |
58792 | 4724 @end menu |
4725 | |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4726 @node ASCII export, HTML export, Exporting, Exporting |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4727 @section ASCII export |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4728 @cindex ASCII export |
58792 | 4729 |
71098
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
4730 ASCII export produces a simple and very readable version of an Org-mode |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4731 file. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4732 |
58792 | 4733 @cindex region, active |
4734 @cindex active region | |
4735 @cindex transient-mark-mode | |
4736 @table @kbd | |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4737 @kindex C-c C-e a |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4738 @item C-c C-e a |
58792 | 4739 Export as ASCII file. If there is an active region, only the region |
4740 will be exported. For an org file @file{myfile.org}, the ASCII file | |
4741 will be @file{myfile.txt}. The file will be overwritten without | |
4742 warning. | |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4743 @kindex C-c C-e v a |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4744 @item C-c C-e v a |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4745 Export only the visible part of the document. |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4746 @end table |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4747 |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4748 @cindex headline levels, for exporting |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4749 In the exported version, the first 3 outline levels will become |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4750 headlines, defining a general document structure. Additional levels |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4751 will be exported as itemized lists. If you want that transition to occur |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4752 at a different level, specify it with a prefix argument. For example, |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4753 |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4754 @example |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4755 @kbd{C-1 C-c C-e a} |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4756 @end example |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4757 |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4758 @noindent |
71246
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
4759 creates only top level headlines and does the rest as items. When |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
4760 headlines are converted to items, the indentation of the text following |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
4761 the headline is changed to fit nicely under the item. This is done with |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
4762 the assumption that the first bodyline indicates the base indentation of |
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
4763 the body text. Any indentation larger than this is adjusted to preserve |
71246
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
4764 the layout relative to the first line. Should there be lines with less |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
4765 indentation than the first, these are left alone. |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4766 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4767 @node HTML export, XOXO export, ASCII export, Exporting |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4768 @section HTML export |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4769 @cindex HTML export |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4770 |
71098
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
4771 Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive |
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
4772 HTML formatting, in ways similar to John Grubers @emph{markdown} |
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
4773 language, but with additional support for tables. |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4774 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4775 @menu |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4776 * Export commands:: How to invode HTML export |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4777 * Quoting HTML tags:: Using direct HTML in Org-mode |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4778 * Links:: How hyperlinks get transferred to HTML |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4779 * Images:: To inline or not to inline? |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4780 * CSS support:: Style specifications |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4781 @end menu |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4782 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4783 @node Export commands, Quoting HTML tags, HTML export, HTML export |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4784 @subsection HTML export commands |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4785 |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4786 @cindex region, active |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4787 @cindex active region |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4788 @cindex transient-mark-mode |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4789 @table @kbd |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4790 @kindex C-c C-e h |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4791 @item C-c C-e h |
58792 | 4792 Export as HTML file @file{myfile.html}. |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4793 @kindex C-c C-e b |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4794 @item C-c C-e b |
58792 | 4795 Export as HTML file and open it with a browser. |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4796 @kindex C-c C-e v h |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4797 @kindex C-c C-e v b |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4798 @item C-c C-e v h |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4799 @item C-c C-e v b |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4800 Export only the visible part of the document. |
58792 | 4801 @end table |
4802 | |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4803 @cindex headline levels, for exporting |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4804 In the exported version, the first 3 outline levels will become |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4805 headlines, defining a general document structure. Additional levels |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4806 will be exported as itemized lists. If you want that transition to occur |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4807 at a different level, specify it with a prefix argument. For example, |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4808 |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4809 @example |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4810 @kbd{C-2 C-c C-e b} |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4811 @end example |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4812 |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4813 @noindent |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4814 creates two levels of headings and does the rest as items. |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4815 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4816 @node Quoting HTML tags, Links, Export commands, HTML export |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4817 @subsection Quoting HTML tags |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4818 |
58792 | 4819 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4820 @samp{>} in HTML export. If you want to include simple HTML tags |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4821 which should be interpreted as such, mark them with @samp{@@} as in |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4822 @samp{@@<b>bold text@@</b>}. Note that this really works only for |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4823 simple tags. For more extensive HTML that should be copied verbatim to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4824 the exported file use either |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4825 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4826 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4827 #+HTML: Literal HTML code for export |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4828 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4829 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4830 @noindent or |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4831 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4832 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4833 #+BEGIN_HTML |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4834 All lines between these markers are exported literally |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4835 #+END_HTML |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4836 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4837 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4838 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4839 @node Links, Images, Quoting HTML tags, HTML export |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4840 @subsection Links |
58792 | 4841 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4842 @cindex links, in HTML export |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4843 @cindex internal links, in HTML export |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4844 @cindex external links, in HTML export |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4845 Internal links (@pxref{Internal links}) will continue to work in HTML |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4846 files only if they match a dedicated @samp{<<target>>}. Automatic links |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4847 created by radio targets (@pxref{Radio targets}) will also work in the |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4848 HTML file. Links to external files will still work if the HTML file is |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4849 in the same directory as the Org-mode file. Links to other @file{.org} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4850 files will be translated into HTML links under the assumption that an |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4851 HTML version also exists of the linked file. For information related to |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4852 linking files while publishing them to a publishing directory see |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4853 @ref{Publishing links}. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4854 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4855 @node Images, CSS support, Links, HTML export |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4856 @subsection Images |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4857 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4858 @cindex images, inline in HTML |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4859 @cindex inlining images in HTML |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4860 HTML export can inline images given as links in the Org-mode file, and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4861 it can make an image the clickable part of a link. By |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4862 default@footnote{but see the variable |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4863 @code{org-export-html-inline-images}}, images are inlined if a link does |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4864 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4865 while @samp{[[file:myimg.jpg][the image]]} will just produce a link |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4866 @samp{the image} that points to the image. If the description part |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4867 itself is a @code{file:} link or a @code{http:} URL pointing to an |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4868 image, this image will be inlined and activated so that clicking on the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4869 image will activate the link. For example, to include a thumbnail that |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4870 will link to a high resolution version of the image, you could use: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4871 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4872 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4873 [[file:highres.jpg][file:thumb.jpg]] |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4874 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4875 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4876 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4877 and you could use @code{http} addresses just as well. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4878 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4879 @node CSS support, , Images, HTML export |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4880 @subsection CSS support |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4881 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4882 You can also give style information for the exported file. The HTML |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4883 exporter assigns the following CSS classes to appropriate parts of the |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4884 document - your style specifications may change these: |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4885 @example |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4886 .todo @r{TODO keywords} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4887 .done @r{the DONE keyword} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4888 .timestamp @r{time stamp} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4889 .timestamp-kwd @r{keyword associated with a time stamp, like SCHEDULED} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4890 .tag @r{tag in a headline} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4891 .target @r{target for links} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4892 @end example |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4893 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4894 The default style specification can be configured through the option |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
4895 @code{org-export-html-style}. If you want to use a file-local style, |
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
4896 you may use file variables, best wrapped into a COMMENT section at the |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4897 end of the outline tree. For example@footnote{Under Emacs 21, the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4898 continuation lines for a variable value should have no @samp{#} at the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4899 start of the line.}: |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
4900 |
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
4901 @example |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4902 * COMMENT html style specifications |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
4903 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4904 # Local Variables: |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
4905 # org-export-html-style: " <style type=\"text/css\"> |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
4906 # p @{font-weight: normal; color: gray; @} |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
4907 # h1 @{color: black; @} |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
4908 # </style>" |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
4909 # End: |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
4910 @end example |
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
4911 |
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
4912 Remember to execute @kbd{M-x normal-mode} after changing this to make |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4913 the new style visible to Emacs. This command restarts org-mode for the |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4914 current buffer and forces Emacs to re-evaluate the local variables |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4915 section in the buffer. |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
4916 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
4917 @c FIXME: More about header and footer styles |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
4918 @c FIXME: Talk about links and targets. |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
4919 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4920 @node XOXO export, iCalendar export, HTML export, Exporting |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4921 @section XOXO export |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4922 @cindex XOXO export |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4923 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4924 Org-mode contains an exporter that produces XOXO-style output. |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4925 Currently, this exporter only handles the general outline structure and |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4926 does not interpret any additional Org-mode features. |
58792 | 4927 |
4928 @table @kbd | |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4929 @kindex C-c C-e x |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4930 @item C-c C-e x |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4931 Export as XOXO file @file{myfile.html}. |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4932 @kindex C-c C-e v |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4933 @item C-c C-e v x |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4934 Export only the visible part of the document. |
58792 | 4935 @end table |
4936 | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4937 @node iCalendar export, Text interpretation, XOXO export, Exporting |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4938 @section iCalendar export |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4939 @cindex iCalendar export |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4940 |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4941 Some people like to use Org-mode for keeping track of projects, but |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4942 still prefer a standard calendar application for anniversaries and |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4943 appointments. In this case it can be useful to have deadlines and |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4944 other time-stamped items in Org-mode files show up in the calendar |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4945 application. Org-mode can export calendar information in the standard |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4946 iCalendar format. If you also want to have TODO entries included in the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4947 export, configure the variable @code{org-icalendar-include-todo}. |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4948 |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4949 @table @kbd |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4950 @kindex C-c C-e i |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4951 @item C-c C-e i |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4952 Create iCalendar entries for the current file and store them in the same |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4953 directory, using a file extension @file{.ics}. |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4954 @kindex C-c C-e I |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4955 @item C-c C-e I |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4956 Like @kbd{C-c C-e i}, but do this for all files in |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4957 @code{org-agenda-files}. For each of these files, a separate iCalendar |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4958 file will be written. |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4959 @kindex C-c C-e c |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4960 @item C-c C-e c |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4961 Create a single large iCalendar file from all files in |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4962 @code{org-agenda-files} and write it to the file given by |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4963 @code{org-combined-agenda-icalendar-file}. |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4964 @end table |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4965 |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
4966 How this calendar is best read and updated, depends on the application |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4967 you are using. The FAQ covers this issue. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4968 |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4969 |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4970 @node Text interpretation, , iCalendar export, Exporting |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4971 @section Text interpretation by the exporter |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4972 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4973 The exporter backends interpret additional structure in the Org-mode file |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4974 in order to produce better output. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4975 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4976 @menu |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4977 * Comment lines:: Some lines will not be exported |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4978 * Enhancing text:: Subscripts, symbols and more |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4979 * Export options:: How to influence the export settings |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4980 @end menu |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4981 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4982 @node Comment lines, Enhancing text, Text interpretation, Text interpretation |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4983 @subsection Comment lines |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4984 @cindex comment lines |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4985 @cindex exporting, not |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4986 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4987 Lines starting with @samp{#} in column zero are treated as comments |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4988 and will never be exported. Also entire subtrees starting with the |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4989 word @samp{COMMENT} will never be exported. Finally, any text before |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4990 the first headline will not be exported either. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4991 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4992 @table @kbd |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4993 @kindex C-c ; |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4994 @item C-c ; |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4995 Toggle the COMMENT keyword at the beginning of an entry. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4996 @end table |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4997 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4998 @node Enhancing text, Export options, Comment lines, Text interpretation |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4999 @subsection Enhancing text for export |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5000 @cindex enhancing text |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5001 @cindex richer text |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5002 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5003 Some of the export backends of Org-mode allow for sophisticated text |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5004 formatting, this is true in particular for the HTML backend. Org-mode |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5005 has a number of typing conventions that allow to produce a richly |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5006 formatted output. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5007 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5008 @itemize @bullet |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5009 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5010 @cindex hand-formatted lists |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5011 @cindex lists, hand-formatted |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5012 @item |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5013 Plain lists @samp{-}, @samp{*} or @samp{+} as bullet, or with @samp{1.} |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5014 or @samp{2)} as enumerator will be recognized and transformed if the |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
5015 backend supports lists. See @xref{Plain lists}. |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5016 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5017 @cindex underlined text |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5018 @cindex bold text |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5019 @cindex italic text |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5020 @item |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5021 You can make words @b{*bold*}, @i{/italic/}, _underlined_, |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5022 @code{=code=}, and @samp{+strikethrough+}. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5023 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5024 @cindex horizontal rules, in exported files |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5025 @item |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5026 A line consisting of only dashes, and at least 5 of them, will be |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5027 exported as a horizontal line (@samp{<hr/>} in HTML). |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5028 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5029 @cindex LaTeX fragments, export |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5030 @cindex TeX macros, export |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5031 @item |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5032 Many @TeX{} macros and entire La@TeX{} fragments are converted into HTML |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5033 entities or images (@pxref{Embedded LaTeX}). |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5034 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5035 @cindex tables, export |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5036 @item |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5037 Tables are transformed into native tables under the exporter, if the |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5038 export backend supports this. Data fields before the first horizontal |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5039 separator line will be formatted as table header fields. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5040 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5041 @cindex fixed width |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5042 @item |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5043 If a headline starts with the word @samp{QUOTE}, the text below the |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5044 headline will be typeset as fixed-width, to allow quoting of computer |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5045 codes etc. Lines starting with @samp{:} are also typeset in |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5046 fixed-width font. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5047 @table @kbd |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5048 @kindex C-c : |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5049 @item C-c : |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5050 Toggle fixed-width for entry (QUOTE) or region, see below. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5051 @end table |
71246
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
5052 |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
5053 @cindex linebreak, forced |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
5054 @item |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
5055 A double backslash @emph{at the end of a line} enforces a line break at |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
5056 this position. |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5057 @end itemize |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5058 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5059 If these conversions conflict with your habits of typing ASCII text, |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5060 they can all be turned off with corresponding variables (see the |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5061 customization group @code{org-export-general}, and the following section |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5062 which explains how to set export options with special lines in a |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5063 buffer. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5064 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5065 |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5066 @node Export options, , Enhancing text, Text interpretation |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5067 @subsection Export options |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5068 @cindex options, for export |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5069 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5070 @cindex completion, of option keywords |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5071 The exporter recognizes special lines in the buffer which provide |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5072 additional information. These lines may be put anywhere in the file. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5073 The whole set of lines can be inserted into the buffer with @kbd{C-c |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
5074 C-e t}. For individual lines, a good way to make sure the keyword is |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5075 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5076 (@pxref{Completion}). |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5077 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5078 @table @kbd |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
5079 @kindex C-c C-e t |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
5080 @item C-c C-e t |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5081 Insert template with export options, see example below. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5082 @end table |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5083 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5084 @example |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5085 #+TITLE: the title to be shown (default is the buffer name) |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5086 #+AUTHOR: the author (default taken from @code{user-full-name}) |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5087 #+EMAIL: his/her email address (default from @code{user-mail-address}) |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5088 #+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language}) |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5089 #+TEXT: Some descriptive text to be inserted at the beginning. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5090 #+TEXT: Several lines may be given. |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5091 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t *:nil TeX:t LaTeX:t |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5092 @end example |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5093 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5094 @noindent |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5095 The OPTIONS line is a compact form to specify export settings. Here |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5096 you can: |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5097 @cindex headline levels |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5098 @cindex section-numbers |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5099 @cindex table of contents |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5100 @cindex linebreak preservation |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5101 @cindex quoted HTML tags |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5102 @cindex fixed-width sections |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5103 @cindex tables |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5104 @cindex @TeX{}-like syntax for sub- and superscripts |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5105 @cindex emphasized text |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5106 @cindex @TeX{} macros |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5107 @cindex La@TeX{} fragments |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5108 @example |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5109 H: @r{set the number of headline levels for export} |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5110 num: @r{turn on/off section-numbers} |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5111 toc: @r{turn on/off table of contents, or set level limit (integer)} |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5112 \n: @r{turn on/off linebreak-preservation} |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5113 @@: @r{turn on/off quoted HTML tags} |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5114 :: @r{turn on/off fixed-width sections} |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5115 |: @r{turn on/off tables} |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5116 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts.} |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5117 *: @r{turn on/off emphasized text (bold, italic, underlined)} |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5118 TeX: @r{turn on/off simple @TeX{} macros in plain text} |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5119 LaTeX: @r{turn on/off La@TeX{} fragments} |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5120 @end example |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5121 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5122 @node Publishing, Miscellaneous, Exporting, Top |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5123 @chapter Publishing |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5124 @cindex publishing |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5125 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5126 Org-mode includes@footnote{@file{org-publish.el} is not yet part of |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5127 Emacs, so if you are using @file{org.el} as it comes with Emacs, you |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5128 need to download this file separately. Also make sure org.el is at |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5129 least version 4.27.} a publishing management system |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5130 that allows you to configure automatic HTML conversion of |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5131 @emph{projects} composed of interlinked org files. This system is |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5132 called @emph{org-publish}. You can also configure org-publish to |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5133 automatically upload your exported HTML pages and related attachments, |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5134 such as images and source code files, to a web server. Org-publish turns |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5135 org-mode into a web-site authoring tool. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5136 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5137 Org-publish has been contributed to Org-mode by David O'Toole. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5138 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5139 @menu |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5140 * Configuration:: Defining projects |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5141 * Sample configuration:: Example projects |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5142 * Triggering publication:: Publication commands |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5143 @end menu |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5144 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5145 @node Configuration, Sample configuration, Publishing, Publishing |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5146 @section Configuration |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5147 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5148 Publishing needs significant configuration to specify files, destination |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5149 and many other properties of a project. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5150 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5151 @menu |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5152 * Project alist:: The central configuration variable |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5153 * Sources and destinations:: From here to there |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5154 * Selecting files:: What files are part of the project? |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5155 * Publishing action:: Setting the function doing the publishing |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5156 * Publishing options:: Tweaking HTML export |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5157 * Publishing links:: Which links keep working after publishing? |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5158 * Project page index:: Publishing a list of project files |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5159 @end menu |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5160 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5161 @node Project alist, Sources and destinations, Configuration, Configuration |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5162 @subsection The variable @code{org-publish-project-alist} |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5163 @cindex org-publish-project-alist |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5164 @cindex projects, for publishing |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5165 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5166 Org-publish is configured almost entirely through setting the value of |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5167 one variable, called @code{org-publish-project-alist}. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5168 Each element of the list configures one project, and may be in one of |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5169 the two following forms: |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5170 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5171 @lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5172 ("project-name" :property value :property value ...) |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5173 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5174 @r{or} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5175 |
71098
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
5176 ("project-name" :components ("project-name" "project-name" ...)) |
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
5177 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5178 @end lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5179 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5180 In both cases, projects are configured by specifying property values. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5181 A project defines the set of files that will be published, as well as |
71098
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
5182 the publishing configuration to use when publishing those files. When |
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
5183 a project takes the second form listed above, the individual members |
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
5184 of the ``components'' property are taken to be components of the |
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
5185 project, which group together files requiring different publishing |
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
5186 options. When you publish such a ``meta-project'' all the components |
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
5187 will also publish. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5188 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5189 @node Sources and destinations, Selecting files, Project alist, Configuration |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5190 @subsection Sources and destinations for files |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5191 @cindex directories, for publishing |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5192 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5193 Most properties are optional, but some should always be set. In |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5194 particular, org-publish needs to know where to look for source files, |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5195 and where to put published files. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5196 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5197 @multitable @columnfractions 0.3 0.7 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5198 @item @code{:base-directory} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5199 @tab Directory containing publishing source files |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5200 @item @code{:publishing-directory} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5201 @tab Directory (possibly remote) where output files will be published. |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5202 @item @code{:preparation-function} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5203 @tab Function called before starting publishing process, for example to |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5204 run @code{make} for updating files to be published. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5205 @end multitable |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5206 @noindent |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5207 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5208 @node Selecting files, Publishing action, Sources and destinations, Configuration |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5209 @subsection Selecting files |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5210 @cindex files, selecting for publishing |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5211 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5212 By default, all files with extension @file{.org} in the base directory |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5213 are considered part of the project. This can be modified by setting the |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5214 properties |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5215 @multitable @columnfractions 0.25 0.75 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5216 @item @code{:base-extension} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5217 @tab Extension (without the dot!) of source files. This actually is a |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5218 regular expression. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5219 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5220 @item @code{:exclude} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5221 @tab Regular expression to match file names that should not be |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5222 published, even though they have been selected on the basis of their |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5223 extension. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5224 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5225 @item @code{:include} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5226 @tab List of files to be included regardless of @code{:base-extension} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5227 and @code{:exclude}. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5228 @end multitable |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5229 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5230 @node Publishing action, Publishing options, Selecting files, Configuration |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5231 @subsection Publishing Action |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5232 @cindex action, for publishing |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5233 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5234 Publishing means that a file is copied to the destination directory and |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5235 possibly transformed in the process. The default transformation is to |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5236 export Org-mode files as HTML files, and this is done by the function |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5237 @code{org-publish-org-to-html} which calls the HTML exporter |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5238 (@pxref{HTML export}). Other files like images only need to be copied |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5239 to the publishing destination. For non-Org-mode files, you need to |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5240 specify the publishing function. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5241 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5242 @multitable @columnfractions 0.3 0.7 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5243 @item @code{:publishing-function} |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5244 @tab Function executing the publication of a file. This may also be a |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5245 list of functions, which will all be called in turn. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5246 @end multitable |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5247 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5248 The function must accept two arguments: a property list containing at |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5249 least a @code{:publishing-directory} property, and the name of the file |
71246
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
5250 to be published. It should take the specified file, make the necessary |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5251 transformation (if any) and place the result into the destination folder. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5252 You can write your own publishing function, but @code{org-publish} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5253 provides one for attachments (files that only need to be copied): |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5254 @code{org-publish-attachment}. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5255 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5256 @node Publishing options, Publishing links, Publishing action, Configuration |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5257 @subsection Options for the HTML exporter |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5258 @cindex options, for publishing |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5259 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5260 The property list can be used to set many export options for the HTML |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5261 exporter. In most cases, these properties correspond to user variables |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5262 in Org-mode. The table below lists these properties along with the |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5263 variable they belong to. See the documentation string for the |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5264 respective variable for details. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5265 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5266 @multitable @columnfractions 0.3 0.7 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5267 @item @code{:language} @tab @code{org-export-default-language} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5268 @item @code{:headline-levels} @tab @code{org-export-headline-levels} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5269 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5270 @item @code{:table-of-contents} @tab @code{org-export-with-toc} |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5271 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees} |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5272 @item @code{:emphasize} @tab @code{org-export-with-emphasize} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5273 @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5274 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros} |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5275 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments} |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5276 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5277 @item @code{:timestamps} .@tab @code{org-export-with-timestamps} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5278 @item @code{:tags} .@tab @code{org-export-with-tags} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5279 @item @code{:tables} @tab @code{org-export-with-tables} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5280 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5281 @item @code{:style} @tab @code{org-export-html-style} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5282 @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5283 @item @code{:inline-images} @tab @code{org-export-html-inline-images} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5284 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5285 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5286 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5287 @item @code{:preamble} @tab @code{org-export-html-preamble} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5288 @item @code{:postamble} @tab @code{org-export-html-postamble} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5289 @item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5290 @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5291 @item @code{:author} @tab @code{user-full-name} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5292 @item @code{:email} @tab @code{user-mail-address} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5293 @end multitable |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5294 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5295 When a property is given a value in org-publish-project-alist, its |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5296 setting overrides the value of the corresponding user variable (if any) |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5297 during publishing. options set within a file (@pxref{Export |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5298 options}), however, override everything. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5299 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5300 @node Publishing links, Project page index, Publishing options, Configuration |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5301 @subsection Links between published files |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5302 @cindex links, publishing |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5303 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5304 To create a link from one Org-mode file to another, you would use |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5305 something like @samp{[[file:foo.org][The foo]]} or simply |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5306 @samp{file:foo.org.} (@pxref{Hyperlinks}). Upon publishing this link |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5307 becomes a link to @file{foo.html}. In this way, you can interlink the |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5308 pages of your "org web" project and the links will work as expected when |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5309 you publish them to HTML. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5310 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5311 You may also link to related files, such as images. Provided you are |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5312 careful with relative pathnames, and provided you have also configured |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5313 org-publish to upload the related files, these links will work |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5314 too. @ref{Complex example} for an example of this usage. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5315 |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5316 Sometime an Org-mode file to be published may contain links that are |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5317 only valid in your production environment, but not in the publishing |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5318 location. In this case, use the property |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5319 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5320 @multitable @columnfractions 0.4 0.6 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5321 @item @code{:link-validation-function} |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5322 @tab Function to validate links |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5323 @end multitable |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5324 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5325 @noindent |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5326 to define a function for checking link validity. This function must |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5327 accept two arguments, the file name and a directory relative to which |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5328 the file name is interpreted in the production environment. If this |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5329 function returns @code{nil}, then the HTML generator will only insert a |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5330 description into the HTML file, but no link. One option for this |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5331 function is @code{org-publish-validate-link} which checks if the given |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5332 file is part of any project in @code{org-publish-project-alist}. |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5333 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5334 @node Project page index, , Publishing links, Configuration |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5335 @subsection Project page index |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5336 @cindex index, of published pages |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5337 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5338 The following properties may be used to control publishing of an |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5339 index of files or summary page for a given project. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5340 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5341 @multitable @columnfractions 0.25 0.75 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5342 @item @code{:auto-index} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5343 @tab When non-nil, publish an index during org-publish-current-project or |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5344 org-publish-all. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5345 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5346 @item @code{:index-filename} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5347 @tab Filename for output of index. Defaults to @file{index.org} (which |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5348 becomes @file{index.html}). |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5349 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5350 @item @code{:index-title} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5351 @tab Title of index page. Defaults to name of file. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5352 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5353 @item @code{:index-function} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5354 @tab Plugin function to use for generation of index. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5355 Defaults to @code{org-publish-org-index}, which generates a plain list |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5356 of links to all files in the project. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5357 @end multitable |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5358 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5359 @node Sample configuration, Triggering publication, Configuration, Publishing |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5360 @section Sample configuration |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5361 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5362 Below we provide two example configurations. The first one is a simple |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5363 project publishing only a set of Org-mode files. The second example is |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5364 more complex, with a multi-component project. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5365 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5366 @menu |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5367 * Simple example:: One-component publishing |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5368 * Complex example:: A multi-component publishing example |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5369 @end menu |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5370 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5371 @node Simple example, Complex example, Sample configuration, Sample configuration |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5372 @subsection Example: simple publishing configuration |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5373 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5374 This example publishes a set of Org-mode files to the @file{public_html} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5375 directory on the local machine. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5376 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5377 @lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5378 (setq org-publish-project-alist |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5379 '(("org" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5380 :base-directory "~/org/" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5381 :publishing-directory "~/public_html" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5382 :section-numbers nil |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5383 :table-of-contents nil |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5384 :style "<link rel=stylesheet |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5385 href=\"../other/mystyle.css\" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5386 type=\"text/css\">"))) |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5387 @end lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5388 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5389 @node Complex example, , Simple example, Sample configuration |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5390 @subsection Example: complex publishing configuration |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5391 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5392 This more complicated example publishes an entire website, including |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5393 org files converted to HTML, image files, emacs lisp source code, and |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5394 stylesheets. The publishing-directory is remote and private files are |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5395 excluded. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5396 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5397 To ensure that links are preserved, care should be taken to replicate |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5398 your directory structure on the web server, and to use relative file |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5399 paths. For example, if your org files are kept in @file{~/org} and your |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5400 publishable images in @file{~/images}, you'd link to an image with |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5401 @c |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5402 @example |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5403 file:../images/myimage.png |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5404 @end example |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5405 @c |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5406 On the web server, the relative path to the image should be the |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5407 same. You can accomplish this by setting up an "images" folder in the |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5408 right place on the webserver, and publishing images to it. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5409 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5410 @lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5411 (setq org-publish-project-alist |
71098
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
5412 '(("orgfiles" |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5413 :base-directory "~/org/" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5414 :base-extension "org" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5415 :publishing-directory "/ssh:user@@host:~/html/notebook/" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5416 :publishing-function org-publish-org-to-html |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5417 :exclude "PrivatePage.org" ;; regexp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5418 :headline-levels 3 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5419 :section-numbers nil |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5420 :table-of-contents nil |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5421 :style "<link rel=stylesheet |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5422 href=\"../other/mystyle.css\" type=\"text/css\">" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5423 :auto-preamble t |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5424 :auto-postamble nil) |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5425 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5426 ("images" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5427 :base-directory "~/images/" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5428 :base-extension "jpg\\|gif\\|png" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5429 :publishing-directory "/ssh:user@@host:~/html/images/" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5430 :publishing-function org-publish-attachment) |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5431 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5432 ("other" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5433 :base-directory "~/other/" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5434 :base-extension "css\\|el" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5435 :publishing-directory "/ssh:user@@host:~/html/other/" |
71098
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
5436 :publishing-function org-publish-attachment) |
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
5437 ("website" :components ("orgfiles" "images" "other")))) |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5438 @end lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5439 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5440 @node Triggering publication, , Sample configuration, Publishing |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5441 @section Triggering publication |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5442 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5443 Once org-publish is properly configured, you can publish with the |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5444 following functions: |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5445 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5446 @table @kbd |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5447 @item C-c C-e c |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
5448 Prompt for a specific project and publish all files that belong to it. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5449 @item C-c C-e p |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5450 Publish the project containing the current file. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5451 @item C-c C-e f |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
5452 Publish only the current file. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5453 @item C-c C-e a |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5454 Publish all projects. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5455 @end table |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5456 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5457 Org uses timestamps to track when a file has changed. The above |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5458 functions normally only publish changed files. You can override this and |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
5459 force publishing of all files by giving a prefix argument. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5460 |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5461 @node Miscellaneous, Extensions and Hacking, Publishing, Top |
58792 | 5462 @chapter Miscellaneous |
5463 | |
5464 @menu | |
5465 * Completion:: M-TAB knows what you need | |
5466 * Customization:: Adapting Org-mode to your taste | |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5467 * In-buffer settings:: Overview of the #+KEYWORDS |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5468 * The very busy C-c C-c key:: When in doubt, press C-c C-c |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5469 * Clean view:: Getting rid of leading stars in the outline |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5470 * TTY keys:: Using Org-mode on a tty |
58792 | 5471 * Interaction:: Other Emacs packages |
63362 | 5472 * Bugs:: Things which do not work perfectly |
58792 | 5473 @end menu |
5474 | |
5475 @node Completion, Customization, Miscellaneous, Miscellaneous | |
5476 @section Completion | |
63833 | 5477 @cindex completion, of @TeX{} symbols |
5478 @cindex completion, of TODO keywords | |
5479 @cindex completion, of dictionary words | |
5480 @cindex completion, of option keywords | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
5481 @cindex completion, of tags |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5482 @cindex completion, of link abbreviations |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
5483 @cindex @TeX{} symbol completion |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
5484 @cindex TODO keywords completion |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
5485 @cindex dictionary word completion |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
5486 @cindex option keyword completion |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
5487 @cindex tag completion |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5488 @cindex link abbreviations, completion of |
58792 | 5489 |
5490 Org-mode supports in-buffer completion. This type of completion does | |
5491 not make use of the minibuffer. You simply type a few letters into | |
5492 the buffer and use the key to complete text right there. | |
5493 | |
5494 @table @kbd | |
5495 @kindex M-@key{TAB} | |
5496 @item M-@key{TAB} | |
5497 Complete word at point | |
5498 @itemize @bullet | |
5499 @item | |
5500 At the beginning of a headline, complete TODO keywords. | |
5501 @item | |
5502 After @samp{\}, complete @TeX{} symbols supported by the exporter. | |
5503 @item | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5504 After @samp{*}, complete headlines in the current buffer so that they |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5505 can be used in search links like @samp{[[*find this headline]]}. |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
5506 @item |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5507 After @samp{:}, complete tags. The list of tags is taken from the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5508 variable @code{org-tag-alist} (possibly set through the @samp{#+TAGS} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5509 in-buffer option, @pxref{Setting tags}), or it is created dynamically |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5510 from all tags used in the current buffer. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5511 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5512 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}). |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
5513 @item |
58792 | 5514 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or |
5515 @samp{OPTIONS} which set file-specific options for Org-mode. When the | |
5516 option keyword is already complete, pressing @kbd{M-@key{TAB}} again | |
5517 will insert example settings for this keyword. | |
5518 @item | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5519 In the line after @samp{#+STARTUP: }, complete startup keywords, |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5520 i.e. valid keys for this line. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5521 @item |
58792 | 5522 Elsewhere, complete dictionary words using ispell. |
5523 @end itemize | |
5524 @end table | |
5525 | |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5526 @node Customization, In-buffer settings, Completion, Miscellaneous |
58792 | 5527 @section Customization |
5528 @cindex customization | |
5529 @cindex options, for customization | |
5530 @cindex variables, for customization | |
5531 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5532 There are more than 180 variables that can be used to customize |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5533 Org-mode. For the sake of compactness of the manual, I am not |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
5534 describing the variables here. A structured overview of customization |
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
5535 variables is available with @kbd{M-x org-customize}. Or select |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5536 @code{Browse Org Group} from the @code{Org->Customization} menu. Many |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5537 settings can also be activated on a per-file basis, by putting special |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5538 lines into the buffer (@pxref{In-buffer settings}). |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5539 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5540 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5541 @section Summary of in-buffer settings |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5542 @cindex in-buffer settings |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5543 @cindex special keywords |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5544 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5545 Org-mode uses special lines in the buffer to define settings on a |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5546 per-file basis. These lines start with a @samp{#+} followed by a |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5547 keyword, a colon, and then individual words defining a setting. Several |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5548 setting words can be in the same line, but you can also have multiple |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5549 lines for the keyword. While these settings are described throughout |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5550 the manual, here is a summary. After changing any of those lines in the |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5551 buffer, press @kbd{C-c C-c} with the cursor still in the line to |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5552 activate the changes immediately. Otherwise they become effective only |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5553 when the file is visited again in a new Emacs session. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5554 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5555 @table @kbd |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5556 @item #+STARTUP: |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5557 This line sets options to be used at startup of org-mode, when an |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5558 Org-mode file is being visited. The first set of options deals with the |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5559 initial visibility of the outline tree. The corresponding variable for |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5560 global default settings is @code{org-startup-folded}, with a default |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5561 value @code{t}, which means @code{overview}. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5562 @cindex @code{overview}, STARTUP keyword |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5563 @cindex @code{content}, STARTUP keyword |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5564 @cindex @code{showall}, STARTUP keyword |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5565 @example |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5566 overview @r{top-level headlines only} |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5567 content @r{all headlines} |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5568 showall @r{no folding at all, show everything} |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5569 @end example |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5570 Then there are options for aligning tables upon visiting a file. This |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5571 is useful in files containing narrowed table columns. The corresponding |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5572 variable is @code{org-startup-align-all-tables}, with a default value |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5573 @code{nil}. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5574 @cindex @code{align}, STARTUP keyword |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5575 @cindex @code{noalign}, STARTUP keyword |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5576 @example |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5577 align @r{align all tables} |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
5578 noalign @r{don't align tables on startup} |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5579 @end example |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5580 Logging TODO state changes and clock intervals (variable |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5581 @code{org-log-done}) can be configured using these options. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5582 @cindex @code{logdone}, STARTUP keyword |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5583 @cindex @code{nologging}, STARTUP keyword |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5584 @cindex @code{lognotedone}, STARTUP keyword |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5585 @cindex @code{lognoteclock-out}, STARTUP keyword |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5586 @cindex @code{lognotestate}, STARTUP keyword |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5587 @example |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5588 logging @r{record a timestamp when an item is marked DONE} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5589 nologging @r{don't record when items are marked DONE} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5590 lognotedone @r{record timestamp and a note when DONE} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5591 lognotestate @r{record timestamp, note when TODO state changes} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5592 lognoteclock-out @r{record timestamp and a note when clocking out} |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5593 @end example |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5594 Here are the options for hiding leading stars in outline headings. The |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5595 corresponding variables are @code{org-hide-leading-stars} and |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5596 @code{org-odd-levels-only}, both with a default setting @code{nil} |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5597 (meaning @code{showstars} and @code{oddeven}). |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5598 @cindex @code{hidestars}, STARTUP keyword |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5599 @cindex @code{showstars}, STARTUP keyword |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5600 @cindex @code{odd}, STARTUP keyword |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5601 @cindex @code{even}, STARTUP keyword |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5602 @example |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5603 hidestars @r{make all but one of the stars starting a headline invisible.} |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5604 showstars @r{show all stars starting a headline} |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5605 odd @r{allow only odd outline levels (1,3,...)} |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5606 oddeven @r{allow all outline levels} |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5607 @end example |
74030 | 5608 To turn on custom format overlays over time stamps (variables |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5609 @code{org-put-time-stamp-overlays} and |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5610 @code{org-time-stamp-overlay-formats}), use |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5611 @cindex @code{customtime}, STARTUP keyword |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5612 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5613 customtime @r{overlay custom time format} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5614 @end example |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5615 @item #+SEQ_TODO: #+TYP_TODO: |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5616 These lines set the TODO keywords and their interpretation in the |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5617 current file. The corresponding variables are @code{org-todo-keywords} |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5618 and @code{org-todo-interpretation}. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5619 @item #+TAGS: TAG1(c1) TAG2(c2) |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5620 These lines (several such lines are allowed) specify the legal tags in |
71098
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
5621 this file, and (potentially) the corresponding @emph{fast tag selection} |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5622 keys. The corresponding variable is @code{org-tag-alist}. |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5623 @item #+LINK: linkword replace |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5624 These lines (several are allowed) specify link abbreviations. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5625 @xref{Link abbreviations}. The corresponding variable is |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5626 @code{org-link-abbrev-alist}. |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5627 @item #+CATEGORY: |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5628 This line sets the category for the agenda file. The category applies |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5629 for all subsequent lines until the next @samp{#+CATEGORY} line, or the |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5630 end of the file. The first such line also applies to any entries before it. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5631 @item #+ARCHIVE: %s_done:: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5632 This line sets the archive location for the agenda file. It applies for |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5633 all subsequent lines until the next @samp{#+CATEGORY} line, or the end |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5634 of the file. The first such line also applies to any entries before it. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5635 The corresponding variable is @code{org-archive-location}. |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5636 @item #+TBLFM: |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5637 This line contains the formulas for the table directly above the line. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5638 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS: |
71098
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
5639 These lines provide settings for exporting files. For more details see |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5640 @ref{Export options}. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5641 @end table |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5642 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5643 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5644 @section The very busy C-c C-c key |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5645 @kindex C-c C-c |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5646 @cindex C-c C-c, overview |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5647 |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5648 The key @kbd{C-c C-c} has many purposes in org-mode, which are all |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5649 mentioned scattered throughout this manual. One specific function of |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5650 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5651 other circumstances it means something like @emph{Hey Org-mode, look |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5652 here and update according to what you see here}. Here is a summary of |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5653 what this means in different contexts. |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5654 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5655 @itemize @minus |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5656 @item |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
5657 If there are highlights in the buffer from the creation of a sparse |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5658 tree, or from clock display, remove these highlights. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5659 @item |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5660 If the cursor is in one of the special @code{#+KEYWORD} lines, this |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5661 triggers scanning the buffer for these lines and updating the |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5662 information. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5663 @item |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5664 If the cursor is inside a table, realign the table. This command |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5665 works even if the automatic table editor has been turned off. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5666 @item |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5667 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5668 the entire table. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5669 @item |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5670 If the cursor is inside a table created by the @file{table.el} package, |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5671 activate that table. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5672 @item |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5673 If the current buffer is a remember buffer, close the note and file it. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5674 With a prefix argument, file it, without further interaction, to the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5675 default location. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5676 @item |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5677 If the cursor is on a @code{<<<target>>>}, update radio targets and |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5678 corresponding links in this buffer. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5679 @item |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5680 If the cursor is in a plain list item with a checkbox, toggle the status |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5681 of the checkbox. |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5682 @item |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5683 If the cursor is on a numbered item in a plain list, renumber the |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5684 ordered list. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5685 @end itemize |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5686 |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5687 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5688 @section A cleaner outline view |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5689 @cindex hiding leading stars |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5690 @cindex clean outline view |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5691 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5692 Some people find it noisy and distracting that the Org-mode headlines |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5693 are starting with a potentially large number of stars. For example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5694 the tree from @ref{Headlines}: |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5695 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5696 @example |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5697 * Top level headline |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5698 ** Second level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5699 *** 3rd level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5700 some text |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5701 *** 3rd level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5702 more text |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5703 * Another top level headline |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5704 @end example |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5705 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5706 @noindent |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5707 Unfortunately this is deeply ingrained into the code of Org-mode and |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5708 cannot be easily changed. You can, however, modify the display in such |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5709 a way that all leading stars become invisible and the outline more easy |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5710 to read. To do this, customize the variable |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5711 @code{org-hide-leading-stars} like this: |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5712 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5713 @lisp |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5714 (setq org-hide-leading-stars t) |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5715 @end lisp |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5716 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5717 @noindent |
69456
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5718 or change this on a per-file basis with one of the lines (anywhere in |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5719 the buffer) |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5720 |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5721 @example |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5722 #+STARTUP: showstars |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5723 #+STARTUP: hidestars |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5724 @end example |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5725 |
69456
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5726 @noindent |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5727 Press @kbd{C-c C-c} with the cursor in a @samp{STARTUP} line to activate |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5728 the modifications. |
69456
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5729 |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5730 With stars hidden, the tree becomes: |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5731 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5732 @example |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5733 * Top level headline |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5734 * Second level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5735 * 3rd level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5736 some text |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5737 * 3rd level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5738 more text |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5739 * Another top level headline |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5740 @end example |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5741 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5742 @noindent |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5743 Note that the leading stars are not truly replaced by whitespace, they |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5744 are only fontified with the face @code{org-hide} that uses the |
73967
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
5745 background color as font color. If you are not using either white or |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5746 black background, you may have to customize this face to get the wanted |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5747 effect. Another possibility is to set this font such that the extra |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5748 stars are @i{almost} invisible, for example using the color |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5749 @code{grey90} on a white background. |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5750 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5751 Things become cleaner still if you skip all the even levels and use only |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5752 odd levels 1, 3, 5..., effectively adding two stars to go from one |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5753 outline level to the next: |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5754 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5755 @example |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5756 * Top level headline |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5757 * Second level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5758 * 3rd level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5759 some text |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5760 * 3rd level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5761 more text |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5762 * Another top level headline |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5763 @end example |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5764 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5765 @noindent |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5766 In order to make the structure editing and export commands handle this |
69456
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5767 convention correctly, use |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5768 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5769 @lisp |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5770 (setq org-odd-levels-only t) |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5771 @end lisp |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5772 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5773 @noindent |
69456
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5774 or set this on a per-file basis with one of the following lines (don't |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5775 forget to press @kbd{C-c C-c} with the cursor in the startup line to |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5776 activate changes immediately). |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5777 |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5778 @example |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5779 #+STARTUP: odd |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5780 #+STARTUP: oddeven |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5781 @end example |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5782 |
69999
bd591cbbcdec
(Updating settings): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
69929
diff
changeset
|
5783 You can convert an Org-mode file from single-star-per-level to the |
bd591cbbcdec
(Updating settings): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
69929
diff
changeset
|
5784 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels |
bd591cbbcdec
(Updating settings): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
69929
diff
changeset
|
5785 RET} in that file. The reverse operation is @kbd{M-x |
bd591cbbcdec
(Updating settings): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
69929
diff
changeset
|
5786 org-convert-to-oddeven-levels}. |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5787 |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5788 @node TTY keys, Interaction, Clean view, Miscellaneous |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5789 @section Using org-mode on a tty |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5790 @cindex tty keybindings |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5791 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5792 Org-mode uses a number of keys that are not accessible on a tty. This |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5793 applies to most special keys like cursor keys, @key{TAB} and |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5794 @key{RET}, when these are combined with modifier keys like @key{Meta} |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5795 and/or @key{Shift}. Org-mode uses these bindings because it needs to |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5796 provide keys for a large number of commands, and because these keys |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5797 appeared particularly easy to remember. In order to still be able to |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5798 access the core functionality of Org-mode on a tty, alternative |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5799 bindings are provided. Here is a complete list of these bindings, |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5800 which are obviously more cumbersome to use. Note that sometimes a |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5801 work-around can be better. For example changing a time stamp is |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5802 really only fun with @kbd{S-@key{cursor}} keys. On a tty you would |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5803 rather use @kbd{C-c .} to re-insert the timestamp. |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5804 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5805 @multitable @columnfractions 0.15 0.2 0.2 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5806 @item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2} |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5807 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5808 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{@key{Esc} @key{left}} |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5809 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5810 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{@key{Esc} @key{right}} |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5811 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5812 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{@key{Esc} @key{up}} |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5813 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5814 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{@key{Esc} @key{down}} |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5815 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5816 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5817 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{@key{Esc} @key{RET}} |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5818 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5819 @item @kbd{S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5820 @item @kbd{S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5821 @item @kbd{S-@key{up}} @tab @kbd{C-c C-x @key{up}} @tab |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5822 @item @kbd{S-@key{down}} @tab @kbd{C-c C-x @key{down}} @tab |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5823 @end multitable |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5824 |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5825 @node Interaction, Bugs, TTY keys, Miscellaneous |
58792 | 5826 @section Interaction with other packages |
5827 @cindex packages, interaction with other | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5828 Org-mode lives in the world of GNU Emacs and interacts in various ways |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5829 with other code out there. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5830 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5831 @menu |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5832 * Cooperation:: Packages Org-mode cooperates with |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5833 * Conflicts:: Packages that lead to conflicts |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5834 @end menu |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5835 |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5836 @node Cooperation, Conflicts, Interaction, Interaction |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5837 @subsection Packages that Org-mode cooperates with |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5838 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5839 @table @asis |
63833 | 5840 @cindex @file{calc.el} |
5841 @item @file{calc.el} by Dave Gillespie | |
5842 Org-mode uses the calc package for implementing spreadsheet | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5843 functionality in its tables (@pxref{The spreadsheet}). Org-mode |
63833 | 5844 checks for the availability of calc by looking for the function |
5845 @code{calc-eval} which should be autoloaded in your setup if calc has | |
5846 been installed properly. As of Emacs 22, calc is part of the Emacs | |
5847 distribution. Another possibility for interaction between the two | |
5848 packages is using calc for embedded calculations. @xref{Embedded Mode, | |
64517 | 5849 , Embedded Mode, calc, GNU Emacs Calc Manual}. |
63833 | 5850 @cindex @file{constants.el} |
5851 @item @file{constants.el} by Carsten Dominik | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5852 In a table formula (@pxref{The spreadsheet}), it is possible to use |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5853 names for natural constants or units. Instead of defining your own |
63833 | 5854 constants in the variable @code{org-table-formula-constants}, install |
5855 the @file{constants} package which defines a large number of constants | |
5856 and units, and lets you use unit prefixes like @samp{M} for | |
5857 @samp{Mega} etc. You will need version 2.0 of this package, available | |
5858 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org-mode checks for | |
5859 the function @code{constants-get}, which has to be autoloaded in your | |
5860 setup. See the installation instructions in the file | |
5861 @file{constants.el}. | |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5862 @item @file{cdlatex.el} by Carsten Dominik |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5863 @cindex @file{cdlatex.el} |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5864 Org-mode can make use of the cdlatex package to efficiently enter |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
5865 La@TeX{} fragments into Org-mode files. See @ref{CDLaTeX mode}. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5866 @item @file{remember.el} by John Wiegley |
63833 | 5867 @cindex @file{remember.el} |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5868 Org mode cooperates with remember, see @ref{Remember}. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5869 @file{Remember.el} is not part of Emacs, find it on the web. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5870 @cindex @file{table.el} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5871 @item @file{table.el} by Takaaki Ota |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5872 @kindex C-c C-c |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5873 @cindex table editor, @file{table.el} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5874 @cindex @file{table.el} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5875 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5876 Complex ASCII tables with automatic line wrapping, column- and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5877 row-spanning, and alignment can be created using the Emacs table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5878 package by Takaaki Ota (@uref{http://sourceforge.net/projects/table}, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5879 and also part of Emacs 22). |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5880 When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org-mode |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5881 will call @command{table-recognize-table} and move the cursor into the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5882 table. Inside a table, the keymap of Org-mode is inactive. In order |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5883 to execute Org-mode-related commands, leave the table. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5884 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5885 @table @kbd |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5886 @kindex C-c C-c |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5887 @item C-c C-c |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5888 Recognize @file{table.el} table. Works when the cursor is in a |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5889 table.el table. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5890 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5891 @kindex C-c ~ |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5892 @item C-c ~ |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5893 Insert a table.el table. If there is already a table at point, this |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5894 command converts it between the table.el format and the Org-mode |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5895 format. See the documentation string of the command |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5896 @code{org-convert-table} for the restrictions under which this is |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5897 possible. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5898 @end table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5899 @file{table.el} is part of Emacs 22. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5900 @end table |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5901 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5902 @node Conflicts, , Cooperation, Interaction |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5903 @subsection Packages that lead to conflicts with Org-mode |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5904 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5905 @table @asis |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5906 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5907 @cindex @file{allout.el} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5908 @item @file{allout.el} by Ken Manheimer |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5909 Startup of Org-mode may fail with the error message |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5910 @code{(wrong-type-argument keymapp nil)} when there is an outdated |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5911 version @file{allout.el} on the load path, for example the version |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5912 distributed with Emacs 21.x. Upgrade to Emacs 22 and this problem will |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5913 disappear. If for some reason you cannot do this, make sure that org.el |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5914 is loaded @emph{before} @file{allout.el}, for example by putting |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5915 @code{(require 'org)} early enough into your @file{.emacs} file. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5916 |
63362 | 5917 @cindex @file{CUA.el} |
5918 @item @file{CUA.el} by Kim. F. Storm | |
5919 Keybindings in Org-mode conflict with the @kbd{S-<cursor>} keys | |
5920 used by CUA-mode (as well as pc-select-mode and s-region-mode) to | |
5921 select and extend the region. If you want to use one of these | |
5922 packages along with Org-mode, configure the variable | |
63833 | 5923 @code{org-CUA-compatible}. When set, Org-mode will move the following |
63362 | 5924 keybindings in org-mode files, and in the agenda buffer (but not |
5925 during date selection). | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5926 |
63362 | 5927 @example |
5928 S-UP -> M-p S-DOWN -> M-n | |
5929 S-LEFT -> M-- S-RIGHT -> M-+ | |
5930 S-RET -> C-S-RET | |
5931 @end example | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5932 |
63362 | 5933 Yes, these are unfortunately more difficult to remember. If you want |
5934 to have other replacement keys, look at the variable | |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
5935 @code{org-disputed-keys}. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5936 @item @file{windmove.el} by Hovav Shacham |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5937 @cindex @file{windmove.el} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5938 Also this package uses the @kbd{S-<cursor>} keys, so everything written |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5939 in the paragraph above about CUA mode also applies here. |
58792 | 5940 @end table |
5941 | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5942 |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5943 @node Bugs, , Interaction, Miscellaneous |
63362 | 5944 @section Bugs |
5945 @cindex bugs | |
5946 | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5947 Here is a list of things that should work differently, but which I |
63362 | 5948 have found too hard to fix. |
58792 | 5949 |
63362 | 5950 @itemize @bullet |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
5951 @item |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5952 If a table field starts with a link, and if the corresponding table |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5953 column is narrowed (@pxref{Narrow columns}) to a width too small to |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5954 display the link, the field would look entirely empty even though it is |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5955 not. To prevent this, Org-mode throws an error. The work-around is to |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5956 make the column wide enough to fit the link, or to add some text (at |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5957 least 2 characters) before the link in the same field. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5958 @item |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5959 Narrowing table columns does not work on XEmacs, because the |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5960 @code{format} function does not transport text properties. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5961 @item |
65656 | 5962 Text in an entry protected with the @samp{QUOTE} keyword should not |
5963 autowrap. | |
5964 @item | |
63362 | 5965 When the application called by @kbd{C-c C-o} to open a file link fails |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5966 (for example because the application does not exist or refuses to open |
63362 | 5967 the file), it does so silently. No error message is displayed. |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
5968 @item |
63833 | 5969 Recalculating a table line applies the formulas from left to right. |
65656 | 5970 If a formula uses @emph{calculated} fields further down the row, |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5971 multiple recalculation may be needed to get all fields consistent. You |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5972 may use the command @code{org-table-iterate} (@kbd{C-u C-c *}) to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5973 recalculate until convergence. |
63833 | 5974 @item |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5975 A single letter cannot be made bold, for example @samp{*a*}. |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
5976 @item |
63362 | 5977 The exporters work well, but could be made more efficient. |
5978 @end itemize | |
5979 | |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5980 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5981 @node Extensions and Hacking, History and Acknowledgments, Miscellaneous, Top |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5982 @appendix Extensions, Hooks and Hacking |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5983 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5984 This appendix lists extensions for Org-mode written by other authors. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5985 It also covers some aspects where users can extend the functionality of |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5986 Org-mode. |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5987 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5988 @menu |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5989 * Extensions:: Existing 3rd-part extensions |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5990 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5991 * Dynamic blocks:: Automatically filled blocks |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5992 * Special agenda views:: Customized views |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5993 @end menu |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5994 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5995 @node Extensions, Tables in arbitrary syntax, Extensions and Hacking, Extensions and Hacking |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5996 @section Third-party extensions for Org-mode |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5997 @cindex extension, third-party |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5998 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5999 The following extensions for Org-mode have been written by other people: |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6000 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6001 @table @asis |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6002 @cindex @file{org-publish.el} |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6003 @item @file{org-publish.el} by David O'Toole |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6004 This package provides facilities for publishing related sets of Org-mode |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6005 files together with linked files like images as webpages. It is |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6006 highly configurable and can be used for other publishing purposes as |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6007 well. As of Org-mode version 4.30, @file{org-publish.el} is part of the |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6008 Org-mode distribution. It is not yet part of Emacs, however, a delay |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6009 caused by the preparations for the 22.1 release. In the mean time, |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6010 @file{org-publish.el} can be downloaded from David's site: |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6011 @url{http://dto.freeshell.org/e/org-publish.el}. |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6012 @cindex @file{org-mouse.el} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6013 @item @file{org-mouse.el} by Piotr Zielinski |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6014 This package implements extended mouse functionality for Org-mode. It |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6015 allows you to cycle visibility and to edit the document structure with |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6016 the mouse. Best of all, it provides a context-sensitive menu on |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6017 @key{mouse-3} that changes depending on the context of a mouse-click. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6018 As of Org-mode version 4.53, @file{org-mouse.el} is part of the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6019 Org-mode distribution. It is not yet part of Emacs, however, a delay |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6020 caused by the preparations for the 22.1 release. In the mean time, |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6021 @file{org-mouse.el} can be downloaded from Piotr's site: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6022 @url{http://www.cl.cam.ac.uk/~pz215/files/org-mouse.el}. |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6023 @cindex @file{org-blog.el} |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6024 @item @file{org-blog.el} by David O'Toole |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
6025 A blogging plug-in for @file{org-publish.el}.@* |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6026 @url{http://dto.freeshell.org/notebook/OrgMode.html}. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6027 @cindex @file{blorg.el} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6028 @item @file{blorg.el} by Bastien Guerry |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6029 Publish Org-mode files as |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6030 blogs. @url{http://www.cognition.ens.fr/~guerry/blorg.html}. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6031 @cindex @file{org2rem.el} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6032 @item @file{org2rem.el} by Bastien Guerry |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6033 Translates Org-mode files into something readable by |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6034 Remind. @url{http://www.cognition.ens.fr/~guerry/u/org2rem.el}. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6035 @end table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6036 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6037 @page |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6038 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6039 @node Tables in arbitrary syntax, Dynamic blocks, Extensions, Extensions and Hacking |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6040 @section Tables in arbitrary syntax |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6041 @cindex tables, in other modes |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6042 @cindex orgtbl-mode |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6043 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6044 Since Orgtbl-mode can be used as a minor mode in arbitrary buffers, a |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6045 frequent feature request has been to make it work with native tables in |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6046 specific languages, for example LaTeX. However, this is extremely hard |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6047 to do in a general way, would lead to a customization nightmare, and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6048 would take away much of the simplicity of the Orgtbl-mode table editor. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6049 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6050 This appendix describes a different approach. We keep the Orgtbl-mode |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6051 table in its native format (the @i{source table}), and use a custom |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6052 function to @i{translate} the table to the correct syntax, and to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6053 @i{install} it in the right location (the @i{target table}). This puts |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6054 the burden of writing conversion functions on the user, but it allows |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6055 for a very flexible system. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6056 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6057 @menu |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6058 * Radio tables:: Sending and receiving |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6059 * A LaTeX example:: Step by step, almost a tutorial |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6060 * Translator functions:: Copy and modify |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6061 @end menu |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6062 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6063 @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6064 @subsection Radio tables |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6065 @cindex radio tables |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6066 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6067 To define the location of the target table, you first need to create two |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6068 lines that are comments in the current mode, but contain magic words for |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6069 Orgtbl-mode to find. Orgtbl-mode will insert the translated table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6070 between these lines, replacing whatever was there before. For example: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6071 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6072 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6073 /* BEGIN RECEIVE ORGTBL table_name */ |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6074 /* END RECEIVE ORGTBL table_name */ |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6075 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6076 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6077 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6078 Just above the source table, we put a special line that tells |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6079 Orgtbl-mode how to translate this table and where to install it. For |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6080 example: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6081 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6082 #+ORGTBL: SEND table_name translation_function arguments.... |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6083 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6084 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6085 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6086 @code{table_name} is the reference name for the table that is also used |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6087 in the receiver lines. @code{translation_function} is the Lisp function |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6088 that does the translation. Furthermore, the line can contain a list of |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6089 arguments (alternating key and value) at the end. The arguments will be |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6090 passed as a property list to the translation function for |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6091 interpretation. A few standard parameters are already recognized and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6092 acted upon before the translation function is called: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6093 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6094 @table @code |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6095 @item :skip N |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6096 Skip the first N lines of the table. Hlines do count! |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6097 @item :skipcols (n1 n2 ...) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6098 List of columns that should be skipped. If the table has a column with |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6099 calculation marks, that column is automatically discarded as well. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6100 Please note that the translator function sees the table @emph{after} the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6101 removal of these columns, the function never knows that there have been |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6102 additional columns. |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6103 @end table |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6104 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6105 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6106 The one problem remaining is how to keep the source table in the buffer |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6107 without disturbing the normal workings of the file, for example during |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6108 compilation of a C file or processing of a LaTeX file. There are a |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6109 number of different solutions: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6110 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6111 @itemize @bullet |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6112 @item |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6113 The table could be placed in a block comment if that is supported by the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6114 language. For example, in C-mode you could wrap the table between |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6115 @samp{/*} and @samp{*/} lines. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6116 @item |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6117 Sometimes it is possible to put the table after some kind of @i{END} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6118 statement, for example @samp{\bye} in TeX and @samp{\end@{document@}} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6119 in LaTeX. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6120 @item |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6121 You can just comment the table line by line whenever you want to process |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6122 the file, and uncomment it whenever you need to edit the table. This |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6123 only sounds tedious - the command @kbd{M-x orgtbl-toggle-comment} does |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6124 make this comment-toggling very easy, in particular if you bind it to a |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6125 key. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6126 @end itemize |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6127 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6128 @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6129 @subsection A LaTeX example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6130 @cindex LaTeX, and orgtbl-mode |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6131 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6132 The best way to wrap the source table in LaTeX is to use the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6133 @code{comment} environment provided by @file{comment.sty}. It has to be |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6134 activated by placing @code{\usepackage@{comment@}} into the document |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6135 header. Orgtbl-mode can insert a radio table skeleton@footnote{By |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6136 default this works only for LaTeX, HTML, and TeXInfo. Configure the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6137 variable @code{orgtbl-radio-tables} to install templates for other |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6138 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6139 be prompted for a table name, lets say we use @samp{salesfigures}. You |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6140 will then get the following template: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6141 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6142 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6143 % BEGIN RECEIVE ORGTBL salesfigures |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6144 % END RECEIVE ORGTBL salesfigures |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6145 \begin@{comment@} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6146 #+ORGTBL: SEND salesfigures orgtbl-to-latex |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6147 | | | |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6148 \end@{comment@} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6149 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6150 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6151 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6152 The @code{#+ORGTBL: SEND} line tells orgtbl-mode to use the function |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6153 @code{orgtbl-to-latex} to convert the table into LaTeX and to put it |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6154 into the receiver location with name @code{salesfigures}. You may now |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6155 fill in the table, feel free to use the spreadsheet features@footnote{If |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6156 the @samp{#+TBLFM} line contains an odd number of dollar characters, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6157 this may cause problems with font-lock in latex-mode. As shown in the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6158 example you can fix this by adding an extra line inside the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6159 @code{comment} environment that is used to balance the dollar |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6160 expressions. If you are using AUCTeX with the font-latex library, a |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6161 much better solution is to add the @code{comment} environment to the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6162 variable @code{LaTeX-verbatim-environments}.}: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6163 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6164 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6165 % BEGIN RECEIVE ORGTBL salesfigures |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6166 % END RECEIVE ORGTBL salesfigures |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6167 \begin@{comment@} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6168 #+ORGTBL: SEND salesfigures orgtbl-to-latex |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6169 | Month | Days | Nr sold | per day | |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6170 |-------+------+---------+---------| |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6171 | Jan | 23 | 55 | 2.4 | |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6172 | Feb | 21 | 16 | 0.8 | |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6173 | March | 22 | 278 | 12.6 | |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6174 #+TBLFM: $4=$3/$2;%.1f |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6175 % $ (optional extra dollar to keep font-lock happy, see footnote) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6176 \end@{comment@} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6177 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6178 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6179 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6180 When you are done, press @kbd{C-c C-c} in the table to get the converted |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6181 table inserted between the two marker lines. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6182 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6183 Now lets assume you want to make the table header by hand, because you |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6184 want to control how columns are aligned etc. In this case we make sure |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6185 that the table translator does skip the first 2 lines of the source |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6186 table, and tell the command to work as a @i{splice}, i.e. to not produce |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6187 header and footer commands of the target table: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6188 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6189 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6190 \begin@{tabular@}@{lrrr@} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6191 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\ |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6192 % BEGIN RECEIVE ORGTBL salesfigures |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6193 % END RECEIVE ORGTBL salesfigures |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6194 \end@{tabular@} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6195 % |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6196 \begin@{comment@} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6197 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6198 | Month | Days | Nr sold | per day | |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6199 |-------+------+---------+---------| |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6200 | Jan | 23 | 55 | 2.4 | |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6201 | Feb | 21 | 16 | 0.8 | |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6202 | March | 22 | 278 | 12.6 | |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6203 #+TBLFM: $4=$3/$2;%.1f |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6204 \end@{comment@} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6205 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6206 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6207 The LaTeX translator function @code{orgtbl-to-latex} is already part of |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6208 Orgtbl-mode. It uses a @code{tabular} environment to typeset the table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6209 and marks horizontal lines with @code{\hline}. Furthermore, it |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6210 interprets the following parameters: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6211 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6212 @table @code |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6213 @item :splice nil/t |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6214 When set to t, return only table body lines, don't wrap them into a |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6215 tabular environment. Default is nil. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6216 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6217 @item :fmt fmt |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6218 A format to be used to wrap each field, should contain @code{%s} for the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6219 original field value. For example, to wrap each field value in dollars, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6220 you could use @code{:fmt "$%s$"}. This may also be a property list with |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6221 column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6222 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6223 @item :efmt efmt |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6224 Use this format to print numbers with exponentials. The format should |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6225 have @code{%s} twice for inserting mantissa and exponent, for example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6226 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6227 may also be a property list with column numbers and formats, for example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6228 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6229 @code{efmt} has been applied to a value, @code{fmt} will also be |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6230 applied. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6231 @end table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6232 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6233 @node Translator functions, , A LaTeX example, Tables in arbitrary syntax |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6234 @subsection Translator functions |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6235 @cindex HTML, and orgtbl-mode |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6236 @cindex translator function |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6237 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6238 Orgtbl-mode has several translator functions built-in: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6239 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6240 @code{orgtbl-to-texinfo}. Except for @code{orgtbl-to-html}@footnote{The |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6241 HTML translator uses the same code that produces tables during HTML |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6242 export.}, these all use a generic translator, @code{orgtbl-to-generic}. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6243 For example, @code{orgtbl-to-latex} itself is a very short function that |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6244 computes the column definitions for the @code{tabular} environment, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6245 defines a few field and line separators and then hands over to the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6246 generic translator. Here is the entire code: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6247 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6248 @lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6249 @group |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6250 (defun orgtbl-to-latex (table params) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6251 "Convert the orgtbl-mode TABLE to LaTeX." |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6252 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l")) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6253 org-table-last-alignment "")) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6254 (params2 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6255 (list |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6256 :tstart (concat "\\begin@{tabular@}@{" alignment "@}") |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6257 :tend "\\end@{tabular@}" |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6258 :lstart "" :lend " \\\\" :sep " & " |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6259 :efmt "%s\\,(%s)" :hline "\\hline"))) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6260 (orgtbl-to-generic table (org-combine-plists params2 params)))) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6261 @end group |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6262 @end lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6263 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6264 As you can see, the properties passed into the function (variable |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6265 @var{PARAMS}) are combined with the ones newly defined in the function |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6266 (variable @var{PARAMS2}). The ones passed into the function (i.e. the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6267 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6268 would like to use the LaTeX translator, but wanted the line endings to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6269 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6270 overrule the default with |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6271 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6272 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6273 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]" |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6274 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6275 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6276 For a new language, you can either write your own converter function in |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6277 analogy with the LaTeX translator, or you can use the generic function |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6278 directly. For example, if you have a language where a table is started |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6279 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6280 started with @samp{!BL!}, ended with @samp{!EL!} and where the field |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6281 separator is a TAB, you could call the generic translator like this (on |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6282 a single line!): |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6283 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6284 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6285 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!" |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6286 :lstart "!BL! " :lend " !EL!" :sep "\t" |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6287 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6288 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6289 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6290 Please check the documentation string of the function |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6291 @code{orgtbl-to-generic} for a full list of parameters understood by |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6292 that function and remember that you can pass each of them into |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6293 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6294 using the generic function. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6295 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6296 Of course you can also write a completely new function doing complicated |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6297 things the generic translator cannot do. A translator function takes |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6298 two arguments. The first argument is the table, a list of lines, each |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6299 line either the symbol @code{hline} or a list of fields. The second |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6300 argument is the property list containing all parameters specified in the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6301 @samp{#+ORGTBL: SEND} line. The function must return a single string |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6302 containing the formatted table. If you write a generally useful |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6303 translator, please post it on @code{emacs-orgmode@@gnu.org} so that |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6304 others can benefit from your work. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6305 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6306 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Extensions and Hacking |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6307 @section Dynamic blocks |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6308 @cindex dynamic blocks |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6309 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6310 Org-mode documents can contain @emph{dynamic blocks}. These are |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6311 specially marked regions that are updated by some user-written function. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6312 A good example for such a block is the clock table inserted by the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6313 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}). |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6314 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6315 Dynamic block are enclosed by a BEGIN-END structure that assigns a name |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6316 to the block and can also specify parameters for the function producing |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6317 the content of the block. |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6318 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6319 @example |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
6320 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ... |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6321 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6322 #+END: |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6323 @end example |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6324 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6325 Dynamic blocks are updated with the following commands |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6326 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6327 @table @kbd |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6328 @kindex C-c C-x C-u |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6329 @item C-c C-x C-u |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6330 Update dynamic block at point. |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6331 @kindex C-u C-c C-x C-u |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6332 @item C-u C-c C-x C-u |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6333 Update all dynamic blocks in the current file. |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6334 @end table |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6335 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6336 Updating a dynamic block means to remove all the text between BEGIN and |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6337 END, parse the BEGIN line for parameters and then call the specific |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6338 writer function for this block to insert the new content. For a block |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6339 with name @code{myblock}, the writer function is |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6340 @code{org-dblock-write:myblock} with as only parameter a property list |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6341 with the parameters given in the begin line. Here is a trivial example |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6342 of a block that keeps track of when the block update function was last |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6343 run: |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6344 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6345 @example |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6346 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M" |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6347 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6348 #+END: |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6349 @end example |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6350 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6351 @noindent |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6352 The corresponding block writer function could look like this: |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6353 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6354 @lisp |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
6355 (defun org-dblock-write:block-update-time (params) |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6356 (let ((fmt (or (plist-get params :format) "%d. %m. %Y"))) |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6357 (insert "Last block update at: " |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6358 (format-time-string fmt (current-time))))) |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6359 @end lisp |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6360 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6361 If you want to make sure that all dynamic blocks are always up-to-date, |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6362 you could add the function @code{org-update-all-dblocks} to a hook, for |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6363 example @code{before-save-hook}. @code{org-update-all-dblocks} is |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6364 written in a way that is does nothing in buffers that are not in Org-mode. |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6365 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6366 @node Special agenda views, , Dynamic blocks, Extensions and Hacking |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6367 @section Special Agenda Views |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6368 @cindex agenda views, user-defined |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6369 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6370 Org-mode provides a special hook that can be used to narrow down the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6371 selection made by any of the agenda views. You may specify a function |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6372 that is used at each match to verify if the match should indeed be part |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6373 of the agenda view, and if not, how much should be skipped. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6374 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6375 Let's say you want to produce a list of projects that contain a WAITING |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6376 tag anywhere in the project tree. Let's further assume that you have |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6377 marked all tree headings that define a project with the todo keyword |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6378 PROJECT. In this case you would run a todo search for the keyword |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6379 PROJECT, but skip the match unless there is a WAITING tag anywhere in |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6380 the subtree belonging to the project line. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6381 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6382 To achieve this, you must write a function that searches the subtree for |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6383 the tag. If the tag is found, the function must return @code{nil} to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6384 indicate that this match should not be skipped. If there is no such |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6385 tag, return the location of the end of the subtree, to indicate that |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6386 search should continue from there. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6387 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6388 @lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6389 (defun my-skip-unless-waiting () |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6390 "Skip trees that are not waiting" |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6391 (let ((subtree-end (save-excursion (org-end-of-subtree t)))) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6392 (if (re-search-forward ":WAITING:" subtree-end t) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6393 nil ; tag found, do not skip |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6394 subtree-end))) ; tag not found, continue after end of subtree |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6395 @end lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6396 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6397 Furthermore you must write a command that uses @code{let} to temporarily |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6398 put this function into the variable @code{org-agenda-skip-function}, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6399 sets the header string for the agenda buffer, and calls the todo-list |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6400 generator while asking for the specific TODO keyword PROJECT. The |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6401 function must also accept one argument MATCH, but it can choose to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6402 ignore it@footnote{MATCH must be present in case you want to define a |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6403 custom command for producing this special list. Custom commands always |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6404 supply the MATCH argument, but it can be empty if you do not specify it |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6405 while defining the command(@pxref{Custom agenda |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6406 views}).} (as we do in the example below). Here is the example: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6407 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6408 @lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6409 (defun my-org-waiting-projects (&optional match) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6410 "Produce a list of projects that contain a WAITING tag. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6411 MATCH is being ignored." |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6412 (interactive) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6413 (let ((org-agenda-skip-function 'my-skip-unless-waiting) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6414 (org-agenda-overriding-header "Projects waiting for something: ")) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6415 ;; make the list |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6416 (org-todo-list "PROJECT"))) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6417 @end lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6418 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6419 |
77235 | 6420 @node History and Acknowledgments, GNU Free Documentation License, Extensions and Hacking, Top |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6421 @appendix History and Acknowledgments |
58792 | 6422 @cindex acknowledgments |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6423 @cindex history |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
6424 @cindex thanks |
58792 | 6425 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6426 Org-mode was borne in 2003, out of frustration over the user interface |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6427 of the Emacs outline-mode. I was trying to organize my notes and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6428 projects, and using Emacs seemed to be the natural way to go. However, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6429 having to remember eleven different commands with two or three keys per |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6430 command, only to hide and unhide parts of the outline tree, that seemed |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6431 entirely unacceptable to me. Also, when using outlines to take notes, I |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6432 constantly want to restructure the tree, organizing it parallel to my |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6433 thoughts and plans. @emph{Visibility cycling} and @emph{structure |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6434 editing} were originally implemented in the package |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6435 @file{outline-magic.el}, but quickly moved to the more general |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6436 @file{org.el}. As this environment became comfortable for project |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6437 planning, the next step was adding @emph{TODO entries}, basic @emph{time |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6438 stamps}, and @emph{table support}. These areas highlight the two main |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6439 goals that Org-mode still has today: To create a new, outline-based, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6440 plain text mode with innovative and intuitive editing features, and to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6441 incorporate project planning functionality directly into a notes file. |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6442 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6443 Since the first release, hundreds of emails to me or on |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6444 @code{emacs-orgmode@@gnu.org} have provided a constant stream of bug |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6445 reports, feedback, new ideas, and sometimes patches and add-on code. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6446 Many thanks to everyone who has helped to improve this package. I am |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6447 trying to keep here a list of the people who had significant influence |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6448 in shaping one or more aspects of Org-mode. The list may not be |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6449 complete, if I have forgotten someone, please accept my apologies and |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6450 let me know. |
58792 | 6451 |
6452 @itemize @bullet | |
73967
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
6453 |
58792 | 6454 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6455 @i{Thomas Baumann} contributed the code for links to the MH-E email |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6456 system. |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
6457 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6458 @i{Alex Bochannek} provided a patch for rounding time stamps. |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
6459 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6460 @i{Charles Cave}'s suggestion sparked the implementation of templates |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6461 for Remember. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
6462 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6463 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
6464 specified time. |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
6465 @item |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6466 @i{Gregory Chernov} patched support for lisp forms into table |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6467 calculations and improved XEmacs compatibility, in particular by porting |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6468 @file{nouline.el} to XEmacs. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6469 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6470 @i{Sacha Chua} suggested to copy some linking code from Planner. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
6471 @item |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6472 @i{Eddward DeVilla} proposed and tested checkbox statistics. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6473 @item |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6474 @i{Kees Dullemond} used to edit projects lists directly in HTML and so |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6475 inspired some of the early development, including HTML export. He also |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6476 asked for a way to narrow wide table columns. |
70065
4804517d7073
(Formula syntax): Fixed link to Calc Manual.
Carsten Dominik <dominik@science.uva.nl>
parents:
70011
diff
changeset
|
6477 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6478 @i{Christian Egli} converted the documentation into TeXInfo format, |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6479 patched CSS formatting into the HTML exporter, and inspired the agenda. |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
6480 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6481 @i{Nic Ferrier} contributed mailcap and XOXO support. |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
6482 @item |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6483 @i{John Foerch} figured out how to make incremental search show context |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6484 around a match in a hidden outline tree. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6485 @item |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6486 @i{Niels Giessen} had the idea to automatically archive DONE trees. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6487 @item |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6488 @i{Bastien Guerry} provided extensive feedback and some patches, and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6489 translated David O'Toole's tutorial into French. |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6490 @item |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6491 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages. |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
6492 @item |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6493 @i{Shidai Liu} (``Leo'') provided extensive feedback and some patches. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6494 @item |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
6495 @i{Leon Liu} asked for embedded LaTeX and tested it. |
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
6496 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6497 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6498 happy. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6499 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6500 @i{Todd Neal} provided patches for links to Info files and elisp forms. |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
6501 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6502 @i{Tim O'Callaghan} suggested in-file links, search options for general |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6503 file links, and TAGS. |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
6504 @item |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6505 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6506 into Japanese. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6507 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6508 @i{Oliver Oppitz} suggested multi-state TODO items. |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6509 @item |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6510 @i{Scott Otterson} sparked the introduction of descriptive text for |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6511 links, among other things. |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
6512 @item |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6513 @i{Pete Phillips} helped during the development of the TAGS feature, and |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6514 provided frequent feedback. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
6515 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6516 @i{T.V. Raman} reported bugs and suggested improvements. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6517 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6518 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
6519 control. |
58792 | 6520 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6521 @i{Kevin Rogers} contributed code to access VM files on remote hosts. |
58792 | 6522 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6523 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6524 conflict with @file{allout.el}. |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
6525 @item |
74030 | 6526 @i{Jason Riedy} sent a patch to fix a bug with export of TODO keywords. |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6527 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6528 @i{Philip Rooke} created the Org-mode reference card and provided lots |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6529 of feedback. |
58792 | 6530 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6531 @i{Christian Schlauer} proposed angular brackets around links, among |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6532 other things. |
63362 | 6533 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6534 Linking to VM/BBDB/GNUS was inspired by @i{Tom Shannon}'s |
58792 | 6535 @file{organizer-mode.el}. |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6536 @item |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
6537 @i{Daniel Sinder} came up with the idea of internal archiving by locking |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6538 subtrees. |
58792 | 6539 @item |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6540 @i{Dale Smith} proposed link abbreviations. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6541 @item |
71246
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
6542 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
6543 chapter about publishing. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6544 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6545 @i{J@"urgen Vollmer} contributed code generating the table of contents |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
6546 in HTML output. |
58792 | 6547 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6548 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE} |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6549 keyword. |
69456
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
6550 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6551 @i{David Wainberg} suggested archiving, and improvements to the linking |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
6552 system. |
58792 | 6553 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6554 @i{John Wiegley} wrote @file{emacs-wiki.el} and @file{planner.el}. The |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
6555 development of Org-mode was fully independent, and both systems are |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
6556 really different beasts in their basic ideas and implementation details. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6557 I later looked at John's code, however, and learned from his |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
6558 implementation of (i) links where the link itself is hidden and only a |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
6559 description is shown, and (ii) popping up a calendar to select a date. |
58792 | 6560 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6561 @i{Carsten Wimmer} suggested some changes and helped fix a bug in |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6562 linking to GNUS. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
6563 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
6564 @i{Roland Winkler} requested additional keybindings to make Org-mode |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
6565 work on a tty. |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6566 @item |
74030 | 6567 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6568 and contributed various ideas and code snippets. |
58792 | 6569 @end itemize |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6570 |
77235 | 6571 @node GNU Free Documentation License, Index, History and Acknowledgments, Top |
6572 @appendix GNU Free Documentation License | |
6573 @include doclicense.texi | |
6574 | |
6575 | |
6576 @node Index, Key Index, GNU Free Documentation License, Top | |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6577 @unnumbered Index |
58792 | 6578 |
6579 @printindex cp | |
6580 | |
6581 @node Key Index, , Index, Top | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6582 @unnumbered Key Index |
58792 | 6583 |
6584 @printindex ky | |
6585 | |
6586 @bye | |
64070 | 6587 |
6588 @ignore | |
6589 arch-tag: 7893d1fe-cc57-4d13-b5e5-f494a1bcc7ac | |
6590 @end ignore |