Mercurial > emacs
annotate man/org.texi @ 74307:f367608cd9d6
*** empty log message ***
author | Nick Roberts <nickrob@snap.net.nz> |
---|---|
date | Tue, 28 Nov 2006 20:14:52 +0000 |
parents | 7c426fa1fdff |
children | 3d45362f1d38 |
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 |
74030 | 6 @set VERSION 4.56 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
7 @set DATE November 2006 |
58792 | 8 |
9 @dircategory Emacs | |
10 @direntry | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
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 | |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
38 Copyright @copyright{} 2004, 2005, 2006 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 |
58792 | 92 * Index:: The fast road to specific information |
93 * Key Index:: Key bindings and where they are described | |
94 | |
95 @detailmenu | |
96 --- The Detailed Node Listing --- | |
97 | |
98 Introduction | |
99 | |
100 * 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
|
101 * 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
|
102 * Activation:: How to activate Org-mode for certain buffers. |
64517 | 103 * Feedback:: Bug reports, ideas, patches etc. |
58792 | 104 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
105 Document Structure |
58792 | 106 |
107 * Outlines:: Org-mode is based on outline-mode | |
108 * Headlines:: How to typeset org-tree headlines | |
65656 | 109 * Visibility cycling:: Show and hide, much simplified |
58792 | 110 * Motion:: Jumping to other headlines |
111 * Structure editing:: Changing sequence and level of headlines | |
63362 | 112 * Archiving:: Move done task trees to a different place |
58792 | 113 * 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
|
114 * Plain lists:: Additional structure within an entry |
58792 | 115 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
116 Archiving |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
117 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
118 * ARCHIVE tag:: Marking a tree as inactive |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
119 * Moving subtrees:: Moving a tree to an archive file |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
120 |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
121 Tables |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
122 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
123 * 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
|
124 * Narrow columns:: Stop wasting space in tables |
63833 | 125 * Table calculations:: Compute a field from other fields |
126 * orgtbl-mode:: The table editor as minor mode | |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
127 * table.el:: Complex tables |
63833 | 128 |
129 Calculations in tables | |
130 | |
131 * Formula syntax:: How to write a formula | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
132 * Lisp formulas:: An alternative way to write formulas |
64517 | 133 * Column formulas:: Formulas valid for all fields in a column |
134 * Advanced features:: Field names, parameters and automatic recalc | |
135 * Named-field formulas:: Formulas valid in single fields | |
136 * Editing/debugging formulas:: Changing a stored formula | |
65656 | 137 * Appetizer:: Taste the power of calc |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
138 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
139 Hyperlinks |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
140 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
141 * 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
|
142 * 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
|
143 * External links:: URL-like links to the world |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
144 * 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
|
145 * 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
|
146 * 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
|
147 * Custom searches:: When the default search is not enough |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
148 * Remember:: Org-trees store quick notes |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
149 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
150 Internal links |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
151 |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
152 * 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
|
153 * CamelCase links:: Activating CamelCase words as links |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
154 |
58792 | 155 TODO items |
156 | |
157 * TODO basics:: Marking and displaying TODO entries | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
158 * TODO extensions:: Workflow and assignments |
58792 | 159 * 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
|
160 * 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
|
161 * Checkboxes:: Tick-off lists |
58792 | 162 |
163 Extended use of TODO keywords | |
164 | |
165 * Workflow states:: From TODO to DONE in steps | |
166 * TODO types:: I do this, Fred the rest | |
167 * Per file keywords:: Different files, different requirements | |
168 | |
169 Timestamps | |
170 | |
171 * Time stamps:: Assigning a time to a tree entry | |
172 * 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
|
173 * Custom time format:: If you cannot work with the ISO format |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
174 * Progress logging:: Documenting when what work was done. |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
175 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
176 Creating timestamps |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
177 |
74030 | 178 * 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
|
179 |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
180 Progress Logging |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
181 |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
182 * Closing items:: When was this entry marked DONE? |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
183 * Clocking work time:: When exactly did you work on this item? |
58792 | 184 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
185 Tags |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
186 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
187 * 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
|
188 * 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
|
189 * 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
|
190 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
191 Agenda Views |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
192 |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
193 * Agenda files:: Files being searched for agenda information |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
194 * Agenda dispatcher:: Keyboard access to agenda views |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
195 * 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
|
196 * Global TODO list:: All unfinished action items |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
197 * 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
|
198 * Timeline:: Time-sorted view for single file |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
199 * Presentation and sorting:: How agenda items are prepared for display |
58792 | 200 * 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
|
201 * Custom agenda views:: Defining special searches and views |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
202 |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
203 The weekly/daily agenda |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
204 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
205 * Calendar/Diary integration:: Integrating Anniversaries and more |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
206 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
207 Presentation and sorting |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
208 |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
209 * Categories:: Not all tasks are equal |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
210 * 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
|
211 * Sorting of agenda items:: The order of things |
58792 | 212 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
213 Custom agenda views |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
214 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
215 * 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
|
216 * 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
|
217 * 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
|
218 * 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
|
219 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
220 Embedded LaTeX |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
221 |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
222 * 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
|
223 * Subscripts and Superscripts:: Simple syntax for raising/lowering text |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
224 * LaTeX fragments:: Complex formulas made easy |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
225 * Processing LaTeX fragments:: Previewing LaTeX processing |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
226 * CDLaTeX mode:: Speed up entering of formulas |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
227 |
58792 | 228 Exporting |
229 | |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
230 * ASCII export:: Exporting to plain ASCII |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
231 * HTML export:: Exporting to HTML |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
232 * XOXO export:: Exporting to XOXO |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
233 * iCalendar export:: Exporting in iCalendar format |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
234 * 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
|
235 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
236 Text interpretation by the exporter |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
237 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
238 * 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
|
239 * Enhancing text:: Subscripts, symbols and more |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
240 * Export options:: How to influence the export settings |
58792 | 241 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
242 Publishing |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
243 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
244 * Configuration:: Defining projects |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
245 * Sample configuration:: Example projects |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
246 * Triggering publication:: Publication commands |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
247 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
248 Configuration |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
249 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
250 * Project alist:: The central configuration variable |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
251 * 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
|
252 * 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
|
253 * 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
|
254 * Publishing options:: Tweaking HTML export |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
255 * 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
|
256 * 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
|
257 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
258 Sample configuration |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
259 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
260 * Simple example:: One-component publishing |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
261 * 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
|
262 |
58792 | 263 Miscellaneous |
264 | |
265 * Completion:: M-TAB knows what you need | |
266 * Customization:: Adapting Org-mode to your taste | |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
267 * 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
|
268 * 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
|
269 * 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
|
270 * TTY keys:: Using Org-mode on a tty |
58792 | 271 * Interaction:: Other Emacs packages |
63362 | 272 * Bugs:: Things which do not work perfectly |
58792 | 273 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
274 Interaction with other packages |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
275 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
276 * Cooperation:: Packages Org-mode cooperates with |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
277 * Conflicts:: Packages that lead to conflicts |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
278 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
279 Extensions, Hooks and Hacking |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
280 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
281 * Extensions:: Existing 3rd-part extensions |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
282 * Dynamic blocks:: Automatically filled blocks |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
283 |
58792 | 284 @end detailmenu |
285 @end menu | |
286 | |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
287 @node Introduction, Document structure, Top, Top |
58792 | 288 @chapter Introduction |
289 @cindex introduction | |
290 | |
291 @menu | |
292 * 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
|
293 * 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
|
294 * Activation:: How to activate Org-mode for certain buffers. |
64517 | 295 * Feedback:: Bug reports, ideas, patches etc. |
58792 | 296 @end menu |
297 | |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
298 @node Summary, Installation, Introduction, Introduction |
58792 | 299 @section Summary |
300 @cindex summary | |
301 | |
302 Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing | |
303 project planning with a fast and effective plain-text system. | |
304 | |
305 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
|
306 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
|
307 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
|
308 content of large files well structured. Visibility cycling and |
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
309 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
|
310 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
|
311 time stamps, and scheduling. It dynamically compiles entries into an |
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
312 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
|
313 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
|
314 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
|
315 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
|
316 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
|
317 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
|
318 linked webpages. |
58792 | 319 |
73967
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
320 An important design aspect that distinguishes Org-mode from for example |
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
321 Planner/Muse is that it encougages to store every piece of information |
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
322 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
|
323 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
|
324 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
|
325 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
|
326 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
|
327 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
|
328 |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
329 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
|
330 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
|
331 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
|
332 it. Org-mode can be used on different levels and in different ways, for |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
333 example: |
58792 | 334 |
335 @example | |
336 @r{@bullet{} as an outline extension with visibility cycling and structure editing} | |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
337 @r{@bullet{} as an ASCII system and table editor for taking structured notes} |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
338 @r{@bullet{} as an ASCII table editor with spreadsheet-like capabilities} |
58792 | 339 @r{@bullet{} as a TODO list editor} |
340 @r{@bullet{} as a full agenda and planner with deadlines and work scheduling} | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
341 @r{@bullet{} as an environment to implement David Allen's GTD system} |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
342 @r{@bullet{} as a simple hypertext system, with HTML export} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
343 @r{@bullet{} as a publishing tool to create a set of interlinked webpages} |
58792 | 344 @end example |
345 | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
346 Org-mode's automatic, context sensitive table editor can be integrated |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
347 into any major mode by activating the minor Orgtbl-mode. |
59541 | 348 |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
349 @cindex FAQ |
59541 | 350 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
|
351 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
|
352 questions (FAQ), links to tutorials etc. This page is located at |
59541 | 353 @uref{http://www.astro.uva.nl/~dominik/Tools/org/}. |
354 | |
355 @page | |
356 | |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
357 @node Installation, Activation, Summary, Introduction |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
358 @section Installation |
58792 | 359 @cindex installation |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
360 @cindex XEmacs |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
361 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
362 @b{Important:} If Org-mode is part of the Emacs distribution or an |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
363 XEmacs package, please skip this section and go directly to |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
364 @ref{Activation}. |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
365 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
366 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
|
367 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
|
368 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
|
369 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
|
370 @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
|
371 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
|
372 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
|
373 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
|
374 the following line to @file{.emacs}: |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
375 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
376 @example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
377 (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
|
378 @end example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
379 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
380 @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
|
381 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
|
382 command:} |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
383 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
384 @example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
385 @b{make install-noutline} |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
386 @end example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
387 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
388 @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
|
389 commands: |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
390 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
391 @example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
392 make |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
393 make install |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
394 @end example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
395 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
396 @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
|
397 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
398 @example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
399 make install-info |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
400 @end example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
401 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
402 @noindent Then add 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 @lisp |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
405 ;; 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
|
406 (require 'org-install) |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
407 @end lisp |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
408 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
409 @node Activation, Feedback, Installation, Introduction |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
410 @section Activation |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
411 @cindex activation |
58792 | 412 @cindex autoload |
413 @cindex global keybindings | |
414 @cindex keybindings, global | |
415 | |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
416 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
|
417 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
|
418 @command{org-agenda} - please choose suitable keys yourself. |
58792 | 419 |
62548 | 420 @lisp |
421 ;; The following lines are always needed. Choose your own keys. | |
422 (add-to-list 'auto-mode-alist '("\\.org$" . org-mode)) | |
423 (define-key global-map "\C-cl" 'org-store-link) | |
424 (define-key global-map "\C-ca" 'org-agenda) | |
425 @end lisp | |
58792 | 426 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
427 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
|
428 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
|
429 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
|
430 (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
|
431 @lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
432 (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
|
433 (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
|
434 @end lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
435 |
58792 | 436 @cindex org-mode, turning on |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
437 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
|
438 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
|
439 like this: |
58792 | 440 |
441 @example | |
442 MY PROJECTS -*- mode: org; -*- | |
443 @end example | |
444 | |
445 @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
|
446 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
|
447 @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
|
448 |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
449 @node Feedback, , Activation, Introduction |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
450 @section Feedback |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
451 @cindex feedback |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
452 @cindex bug reports |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
453 @cindex maintainer |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
454 @cindex author |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
455 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
456 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
|
457 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
|
458 @value{MAINTAINEREMAIL}. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
459 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
460 For bug reports, please provide as much information as possible, |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
461 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
|
462 @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
|
463 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
|
464 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
|
465 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
|
466 |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
467 @enumerate |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
468 @item What exactly did you do? |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
469 @item What did you expect to happen? |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
470 @item What happened instead? |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
471 @end enumerate |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
472 @noindent Thank you for helping to improve this mode. |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
473 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
474 @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
|
475 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
476 @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
|
477 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
|
478 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
|
479 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
|
480 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
|
481 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
|
482 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
483 @enumerate |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
484 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
485 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
|
486 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
|
487 @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
|
488 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
|
489 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
|
490 @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
|
491 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
492 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
|
493 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
494 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
495 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
|
496 (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
|
497 @item |
73967
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
498 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
|
499 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
|
500 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
501 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
|
502 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
|
503 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
|
504 @end enumerate |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
505 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
506 @node Document structure, Tables, Introduction, Top |
58792 | 507 @chapter Document Structure |
508 @cindex document structure | |
509 @cindex structure of document | |
510 | |
511 Org-mode is based on outline mode and provides flexible commands to | |
512 edit the structure of the document. | |
513 | |
514 @menu | |
515 * Outlines:: Org-mode is based on outline-mode | |
516 * Headlines:: How to typeset org-tree headlines | |
65656 | 517 * Visibility cycling:: Show and hide, much simplified |
58792 | 518 * Motion:: Jumping to other headlines |
519 * Structure editing:: Changing sequence and level of headlines | |
63362 | 520 * Archiving:: Move done task trees to a different place |
58792 | 521 * 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
|
522 * Plain lists:: Additional structure within an entry |
58792 | 523 @end menu |
524 | |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
525 @node Outlines, Headlines, Document structure, Document structure |
58792 | 526 @section Outlines |
527 @cindex outlines | |
528 @cindex outline-mode | |
529 | |
530 Org-mode is implemented on top of outline-mode. Outlines allow to | |
531 organize a document in a hierarchical structure, which (at least for | |
532 me) is the best representation of notes and thoughts. Overview over | |
533 this structure is achieved by folding (hiding) large parts of the | |
534 document to show only the general document structure and the parts | |
535 currently being worked on. Org-mode greatly simplifies the use of | |
536 outlines by compressing the entire show/hide functionality into a | |
537 single command @command{org-cycle}, which is bound to the @key{TAB} | |
538 key. | |
539 | |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
540 @node Headlines, Visibility cycling, Outlines, Document structure |
58792 | 541 @section Headlines |
542 @cindex headlines | |
543 @cindex outline tree | |
544 | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
545 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
|
546 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
|
547 example: |
58792 | 548 |
549 @example | |
550 * Top level headline | |
551 ** Second level | |
552 *** 3rd level | |
553 some text | |
554 *** 3rd level | |
555 more text | |
556 * Another top level headline | |
557 @end example | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
558 |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
559 @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
|
560 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
|
561 starters. @ref{Clean view} describes a setup to realize this. |
58792 | 562 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
563 @node Visibility cycling, Motion, Headlines, Document structure |
58792 | 564 @section Visibility cycling |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
565 @cindex cycling, visibility |
58792 | 566 @cindex visibility cycling |
567 @cindex trees, visibility | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
568 @cindex show hidden text |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
569 @cindex hide text |
58792 | 570 |
571 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
|
572 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
|
573 @kbd{S-@key{TAB}} to change the visibility in the buffer. |
58792 | 574 |
575 @cindex subtree visibility states | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
576 @cindex subtree cycling |
58792 | 577 @cindex folded, subtree visibility state |
578 @cindex children, subtree visibility state | |
579 @cindex subtree, subtree visibility state | |
580 @table @kbd | |
581 @kindex @key{TAB} | |
582 @item @key{TAB} | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
583 @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
|
584 |
58792 | 585 @example |
586 ,-> FOLDED -> CHILDREN -> SUBTREE --. | |
587 '-----------------------------------' | |
588 @end example | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
589 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
590 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
|
591 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
|
592 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
|
593 @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
|
594 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
|
595 argument (@kbd{C-u @key{TAB}}), global cycling is invoked. |
58792 | 596 |
597 @cindex global visibility states | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
598 @cindex global cycling |
58792 | 599 @cindex overview, global visibility state |
600 @cindex contents, global visibility state | |
601 @cindex show all, global visibility state | |
602 @kindex S-@key{TAB} | |
603 @item S-@key{TAB} | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
604 @itemx C-u @key{TAB} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
605 @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
|
606 |
58792 | 607 @example |
608 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --. | |
609 '--------------------------------------' | |
610 @end example | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
611 |
58792 | 612 Note that inside tables, @kbd{S-@key{TAB}} jumps to the previous field. |
613 | |
614 @cindex show all, command | |
615 @kindex C-c C-a | |
616 @item C-c C-a | |
617 Show all. | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
618 @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
|
619 @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
|
620 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
|
621 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
|
622 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
623 command (@pxref{Agenda commands}). |
58792 | 624 @end table |
625 | |
63833 | 626 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
|
627 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
|
628 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
|
629 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
|
630 buffer: |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
631 |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
632 @example |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
633 #+STARTUP: overview |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
634 #+STARTUP: content |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
635 #+STARTUP: showall |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
636 @end example |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
637 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
638 @node Motion, Structure editing, Visibility cycling, Document structure |
58792 | 639 @section Motion |
640 @cindex motion, between headlines | |
641 @cindex jumping, to headlines | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
642 @cindex headline navigation |
58792 | 643 The following commands jump to other headlines in the buffer. |
644 | |
645 @table @kbd | |
646 @kindex C-c C-n | |
647 @item C-c C-n | |
648 Next heading. | |
649 @kindex C-c C-p | |
650 @item C-c C-p | |
651 Previous heading. | |
652 @kindex C-c C-f | |
653 @item C-c C-f | |
654 Next heading same level. | |
655 @kindex C-c C-b | |
656 @item C-c C-b | |
657 Previous heading same level. | |
658 @kindex C-c C-u | |
659 @item C-c C-u | |
660 Backward to higher level heading. | |
661 @kindex C-c C-j | |
662 @item C-c C-j | |
663 Jump to a different place without changing the current outline | |
664 visibility. Shows the document structure in a temporary buffer, where | |
665 you can use visibility cycling (@key{TAB}) to find your destination. | |
666 After pressing @key{RET}, the cursor moves to the selected location in | |
667 the original buffer, and the headings hierarchy above it is made | |
668 visible. | |
669 @end table | |
670 | |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
671 @node Structure editing, Archiving, Motion, Document structure |
58792 | 672 @section Structure editing |
673 @cindex structure editing | |
674 @cindex headline, promotion and demotion | |
675 @cindex promotion, of subtrees | |
676 @cindex demotion, of subtrees | |
677 @cindex subtree, cut and paste | |
63833 | 678 @cindex pasting, of subtrees |
679 @cindex cutting, of subtrees | |
680 @cindex copying, of subtrees | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
681 @cindex subtrees, cut and paste |
58792 | 682 |
683 @table @kbd | |
684 @kindex M-@key{RET} | |
685 @item M-@key{RET} | |
67382
62adeda8b0dd
Structure editing): DOcument new fucntionality of
Carsten Dominik <dominik@science.uva.nl>
parents:
67353
diff
changeset
|
686 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
|
687 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
|
688 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
|
689 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
|
690 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
|
691 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
|
692 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
|
693 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
|
694 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
|
695 (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
|
696 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
|
697 @kindex M-S-@key{RET} |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
698 @item M-S-@key{RET} |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
699 Insert new TODO entry with same level as current heading. |
58792 | 700 @kindex M-@key{left} |
701 @item M-@key{left} | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
702 Promote current heading by one level. |
58792 | 703 @kindex M-@key{right} |
704 @item M-@key{right} | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
705 Demote current heading by one level. |
58792 | 706 @kindex M-S-@key{left} |
707 @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
|
708 Promote the current subtree by one level. |
58792 | 709 @kindex M-S-@key{right} |
710 @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
|
711 Demote the current subtree by one level. |
58792 | 712 @kindex M-S-@key{up} |
713 @item M-S-@key{up} | |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
714 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
|
715 level). |
58792 | 716 @kindex M-S-@key{down} |
717 @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
|
718 Move subtree down (swap with next subtree of same level). |
65656 | 719 @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
|
720 @kindex C-c C-x C-k |
65656 | 721 @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
|
722 @itemx C-c C-x C-k |
58792 | 723 Kill subtree, i.e. remove it from buffer but save in kill ring. |
65656 | 724 @kindex C-c C-x M-w |
725 @item C-c C-x M-w | |
58792 | 726 Copy subtree to kill ring. |
65656 | 727 @kindex C-c C-x C-y |
728 @item C-c C-x C-y | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
729 Yank subtree from kill ring. This does modify the level of the subtree to |
58792 | 730 make sure the tree fits in nicely at the yank position. The yank |
731 level can also be specified with a prefix arg, or by yanking after a | |
732 headline marker like @samp{****}. | |
733 @end table | |
734 | |
735 @cindex region, active | |
736 @cindex active region | |
737 @cindex transient-mark-mode | |
738 When there is an active region (transient-mark-mode), promotion and | |
739 demotion work on all headlines in the region. To select a region of | |
740 headlines, it is best to place both point and mark at the beginning of a | |
741 line, mark at the beginning of the first headline, and point at the line | |
742 just after the last headline to change. Note that when the cursor is | |
743 inside a table (@pxref{Tables}), the Meta-Cursor keys have different | |
744 functionality. | |
745 | |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
746 @node Archiving, Sparse trees, Structure editing, Document structure |
63362 | 747 @section Archiving |
748 @cindex archiving | |
749 | |
63833 | 750 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
|
751 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
|
752 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
|
753 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
|
754 location. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
755 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
756 @menu |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
757 * ARCHIVE tag:: Marking a tree as inactive |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
758 * Moving subtrees:: Moving a tree to an archive file |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
759 @end menu |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
760 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
761 @node ARCHIVE tag, Moving subtrees, Archiving, Archiving |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
762 @subsection The ARCHIVE tag |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
763 @cindex internal archiving |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
764 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
765 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
|
766 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
|
767 @itemize @minus |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
768 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
769 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
|
770 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
|
771 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
|
772 @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
|
773 @code{show-all} will open archived subtrees. |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
774 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
775 During sparse tree construction (@pxref{Sparse trees}), matches in |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
776 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
|
777 @code{org-sparse-tree-open-archived-trees}. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
778 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
779 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
|
780 archived trees is ignored unless you configure the option |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
781 @code{org-agenda-skip-archived-trees}. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
782 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
783 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
|
784 is. Configure the details using the variable |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
785 @code{org-export-with-archived-trees}. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
786 @end itemize |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
787 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
788 The following commands help managing the ARCHIVE tag: |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
789 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
790 @table @kbd |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
791 @kindex C-c C-x C-a |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
792 @item C-c C-x C-a |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
793 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
|
794 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
|
795 hidden. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
796 @kindex C-u C-c C-x C-a |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
797 @item C-u C-c C-x C-a |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
798 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
|
799 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
|
800 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
|
801 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
|
802 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
|
803 @kindex C-@kbd{TAB} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
804 @item C-@kbd{TAB} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
805 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
|
806 @end table |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
807 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
808 @node Moving subtrees, , ARCHIVE tag, Archiving |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
809 @subsection Moving subtrees |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
810 @cindex external archiving |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
811 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
812 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
|
813 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
|
814 file, the archive file. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
815 |
63362 | 816 @table @kbd |
63833 | 817 @kindex C-c $ |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
818 @item C-c $ |
63362 | 819 Archive the subtree starting at the cursor position to the location |
820 given by @code{org-archive-location}. | |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
821 @kindex C-u C-c $ |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
822 @item C-u C-c $ |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
823 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
|
824 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
|
825 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
|
826 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
|
827 is invoked, the level 1 trees will be checked. |
63362 | 828 @end table |
829 | |
830 @cindex archive locations | |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
831 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
|
832 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
|
833 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
|
834 see the documentation string of the variable |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
835 @code{org-archive-location}. |
63362 | 836 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
837 @node Sparse trees, Plain lists, Archiving, Document structure |
58792 | 838 @section Sparse trees |
839 @cindex sparse trees | |
840 @cindex trees, sparse | |
841 @cindex folding, sparse trees | |
842 @cindex occur, command | |
843 | |
844 An important feature of Org-mode is the ability to construct | |
845 @emph{sparse trees} for selected information in an outline tree. A | |
846 sparse tree means that the entire document is folded as much as | |
847 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
|
848 headline structure above it@footnote{See also the variables |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
849 @code{org-show-hierarchy-above} and |
63833 | 850 @code{org-show-following-heading}.}. Just try it out and you will see |
58792 | 851 immediately how it works. |
852 | |
853 Org-mode contains several commands creating such trees. The most | |
854 basic one is @command{org-occur}: | |
855 | |
856 @table @kbd | |
857 @kindex C-c / | |
858 @item C-c / | |
859 Occur. Prompts for a regexp and shows a sparse tree with all matches. | |
860 If the match is in a headline, the headline is made visible. If the | |
861 match is in the body of an entry, headline and body are made visible. | |
862 In order to provide minimal context, also the full hierarchy of | |
863 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
|
864 the match. Each match is also highlighted; the highlights disappear |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
865 when the bufer is changes an editing command, or by pressing @kbd{C-c |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
866 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
|
867 are kept, so several calls to this command can be stacked. |
58792 | 868 @end table |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
869 @noindent |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
870 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
|
871 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
|
872 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
|
873 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
|
874 For example: |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
875 |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
876 @lisp |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
877 (setq org-agenda-custom-commands |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
878 '(("f" occur-tree "FIXME"))) |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
879 @end lisp |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
880 |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
881 @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
|
882 a sparse tree matching the string @samp{FIXME}. |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
883 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
884 Other commands use sparse trees as well. For example @kbd{C-c |
58792 | 885 C-v} creates a sparse TODO tree (@pxref{TODO basics}). |
886 | |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
887 @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
|
888 @cindex printing sparse trees |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
889 @cindex visible text, printing |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
890 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
|
891 @code{ps-print-buffer-with-faces} which does not print invisible parts |
63833 | 892 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
|
893 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
|
894 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
|
895 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
|
896 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
897 @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
|
898 @section Plain lists |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
899 @cindex plain lists |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
900 @cindex lists, plain |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
901 @cindex lists, ordered |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
902 @cindex ordered lists |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
903 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
904 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
|
905 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
|
906 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
|
907 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
|
908 |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
909 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
|
910 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
|
911 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
|
912 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
|
913 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
|
914 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
|
915 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
|
916 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
|
917 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
|
918 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
|
919 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
|
920 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
|
921 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
|
922 less. For example: |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
923 |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
924 @example |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
925 @group |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
926 ** 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
|
927 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
|
928 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
|
929 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
|
930 + 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
|
931 + 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
|
932 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
|
933 - on DVD only |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
934 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
|
935 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
|
936 @end group |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
937 @end example |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
938 |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
939 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
|
940 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
|
941 settings for Emacs. For XEmacs, you should use Kyle E. Jones' |
74030 | 942 @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
|
943 @example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
944 (require 'filladapt) |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
945 @end example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
946 }. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
947 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
948 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
|
949 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
|
950 |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
951 @table @kbd |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
952 @kindex @key{TAB} |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
953 @item @key{TAB} |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
954 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
|
955 @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
|
956 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
|
957 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
|
958 completely separated. |
67382
62adeda8b0dd
Structure editing): DOcument new fucntionality of
Carsten Dominik <dominik@science.uva.nl>
parents:
67353
diff
changeset
|
959 @kindex M-@key{RET} |
62adeda8b0dd
Structure editing): DOcument new fucntionality of
Carsten Dominik <dominik@science.uva.nl>
parents:
67353
diff
changeset
|
960 @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
|
961 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
|
962 (@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
|
963 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
|
964 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
|
965 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
|
966 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
|
967 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
|
968 current line. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
969 @kindex M-S-@key{RET} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
970 @item M-S-@key{RET} |
71525
f3876738c127
(Checkboxes): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71508
diff
changeset
|
971 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
|
972 @kindex S-@key{up} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
973 @kindex S-@key{down} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
974 @item S-@key{up} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
975 @itemx S-@key{down} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
976 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
|
977 @kindex M-S-@key{up} |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
978 @kindex M-S-@key{down} |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
979 @item M-S-@key{up} |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
980 @itemx M-S-@key{down} |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
981 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
|
982 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
|
983 automatic. |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
984 @kindex M-S-@key{left} |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
985 @kindex M-S-@key{right} |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
986 @item M-S-@key{left} |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
987 @itemx M-S-@key{right} |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
988 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
|
989 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
|
990 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
|
991 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
|
992 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
|
993 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
|
994 @kindex C-c C-c |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
995 @item C-c C-c |
71525
f3876738c127
(Checkboxes): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71508
diff
changeset
|
996 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
|
997 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
|
998 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
|
999 @end table |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1000 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
1001 @node Tables, Hyperlinks, Document structure, Top |
58792 | 1002 @chapter Tables |
1003 @cindex tables | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1004 @cindex editing tables |
58792 | 1005 |
63833 | 1006 Org-mode has a very fast and intuitive table editor built-in. |
1007 Spreadsheet-like calculations are supported in connection with the | |
1008 Emacs @file{calc} package. | |
58792 | 1009 |
1010 @menu | |
1011 * 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
|
1012 * Narrow columns:: Stop wasting space in tables |
63833 | 1013 * Table calculations:: Compute a field from other fields |
1014 * orgtbl-mode:: The table editor as minor mode | |
58792 | 1015 * table.el:: Complex tables |
1016 @end menu | |
1017 | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1018 @node Built-in table editor, Narrow columns, Tables, Tables |
58792 | 1019 @section The built-in table editor |
1020 @cindex table editor, builtin | |
1021 | |
1022 Org-mode makes it easy to format tables in plain ASCII. Any line with | |
1023 @samp{|} as the first non-white character is considered part of a | |
1024 table. @samp{|} is also the column separator. A table might look | |
1025 like this: | |
1026 | |
1027 @example | |
1028 | Name | Phone | Age | | |
1029 |-------+-------+-----| | |
1030 | Peter | 1234 | 17 | | |
1031 | Anna | 4321 | 25 | | |
1032 @end example | |
1033 | |
1034 A table is re-aligned automatically each time you press @key{TAB} or | |
63833 | 1035 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to |
1036 the next field (@key{RET} to the next row) and creates new table rows | |
1037 at the end of the table or before horizontal lines. The indentation | |
1038 of the table is set by the first line. Any line starting with | |
1039 @samp{|-} is considered as a horizontal separator line and will be | |
1040 expanded on the next re-align to span the whole table width. So, to | |
1041 create the above table, you would only type | |
58792 | 1042 |
1043 @example | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1044 |Name|Phone|Age| |
58792 | 1045 |- |
1046 @end example | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1047 |
58792 | 1048 @noindent and then press @key{TAB} to align the table and start filling in |
1049 fields. | |
1050 | |
65656 | 1051 When typing text into a field, Org-mode treats @key{DEL}, |
1052 @key{Backspace}, and all character keys in a special way, so that | |
1053 inserting and deleting avoids shifting other fields. Also, when | |
1054 typing @emph{immediately after the cursor was moved into a new field | |
1055 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the | |
1056 field is automatically made blank. If this behavior is too | |
1057 unpredictable for you, configure the variables | |
1058 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}. | |
1059 | |
58792 | 1060 @table @kbd |
1061 @tsubheading{Creation and conversion} | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1062 @kindex C-c | |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1063 @item C-c | |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1064 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
|
1065 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
|
1066 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
|
1067 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
|
1068 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
|
1069 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
|
1070 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
|
1071 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}. |
58792 | 1072 |
1073 @tsubheading{Re-aligning and field motion} | |
1074 @kindex C-c C-c | |
1075 @item C-c C-c | |
1076 Re-align the table without moving the cursor. | |
1077 | |
1078 @kindex @key{TAB} | |
1079 @item @key{TAB} | |
1080 Re-align the table, move to the next field. Creates a new row if | |
1081 necessary. | |
1082 | |
1083 @kindex S-@key{TAB} | |
1084 @item S-@key{TAB} | |
63833 | 1085 Re-align, move to previous field. |
58792 | 1086 |
1087 @kindex @key{RET} | |
1088 @item @key{RET} | |
1089 Re-align the table and move down to next row. Creates a new row if | |
1090 necessary. At the beginning or end of a line, @key{RET} still does | |
1091 NEWLINE, so it can be used to split a table. | |
1092 | |
1093 @tsubheading{Column and row editing} | |
1094 @kindex M-@key{left} | |
1095 @kindex M-@key{right} | |
1096 @item M-@key{left} | |
1097 @itemx M-@key{right} | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1098 Move the current column left/right. |
58792 | 1099 |
1100 @kindex M-S-@key{left} | |
1101 @item M-S-@key{left} | |
1102 Kill the current column. | |
1103 | |
1104 @kindex M-S-@key{right} | |
1105 @item M-S-@key{right} | |
1106 Insert a new column to the left of the cursor position. | |
1107 | |
1108 @kindex M-@key{up} | |
1109 @kindex M-@key{down} | |
1110 @item M-@key{up} | |
1111 @itemx M-@key{down} | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1112 Move the current row up/down. |
58792 | 1113 |
1114 @kindex M-S-@key{up} | |
1115 @item M-S-@key{up} | |
1116 Kill the current row or horizontal line. | |
1117 | |
1118 @kindex M-S-@key{down} | |
1119 @item M-S-@key{down} | |
1120 Insert a new row above (with arg: below) the current row. | |
1121 | |
1122 @kindex C-c - | |
1123 @item C-c - | |
63833 | 1124 Insert a horizontal line below current row. With prefix arg, the line |
1125 is created above the current line. | |
58792 | 1126 |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
1127 @kindex C-c ^ |
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
1128 @item C-c ^ |
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
1129 Sort the table lines in the region. Point and mark must be in the first |
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
1130 and last line to be included, and must be in the column that should be |
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
1131 used for sorting. The command prompts for numerical versus |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1132 alphanumerical sorting. |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
1133 |
58792 | 1134 @tsubheading{Regions} |
65656 | 1135 @kindex C-c C-x M-w |
1136 @item C-c C-x M-w | |
63833 | 1137 Copy a rectangular region from a table to a special clipboard. Point |
58792 | 1138 and mark determine edge fields of the rectangle. The process ignores |
1139 horizontal separator lines. | |
65656 | 1140 @kindex C-c C-x C-w |
1141 @item C-c C-x C-w | |
63833 | 1142 Copy a rectangular region from a table to a special clipboard, and |
1143 blank all fields in the rectangle. So this is the ``cut'' operation. | |
65656 | 1144 @kindex C-c C-x C-y |
1145 @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
|
1146 Paste a rectangular region into a table. |
58792 | 1147 The upper right corner ends up in the current field. All involved fields |
1148 will be overwritten. If the rectangle does not fit into the present table, | |
1149 the table is enlarged as needed. The process ignores horizontal separator | |
1150 lines. | |
1151 @kindex C-c C-q | |
1152 @item C-c C-q | |
1153 Wrap several fields in a column like a paragraph. If there is an active | |
1154 region, and both point and mark are in the same column, the text in the | |
1155 column is wrapped to minimum width for the given number of lines. A | |
1156 prefix ARG may be used to change the number of desired lines. If there | |
1157 is no region, the current field is split at the cursor position and the | |
1158 text fragment to the right of the cursor is prepended to the field one | |
1159 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
|
1160 current field is made blank, and the content is appended to the field |
58792 | 1161 above. |
1162 | |
1163 @tsubheading{Calculations} | |
63833 | 1164 @cindex formula, in tables |
1165 @cindex calculations, in tables | |
1166 @kindex C-c = | |
1167 @item C-c = | |
64517 | 1168 Install a new formula for the current column and replace current field |
1169 with the result of the formula. | |
1170 | |
1171 @kindex C-u C-c = | |
1172 @item C-u C-c = | |
1173 Install a new formula for the current field, which must be a named | |
1174 field. Evaluate the formula and replace the field content with the | |
1175 result. | |
1176 | |
1177 @kindex C-c ' | |
1178 @item C-c ' | |
1179 Edit all formulas associated with the current table in a separate | |
1180 buffer. | |
63833 | 1181 |
1182 @kindex C-c * | |
1183 @item C-c * | |
1184 Recalculate the current row by applying the stored formulas from left | |
1185 to right. When called with a @kbd{C-u} prefix, recalculate the | |
1186 entire table, starting with the first non-header line (i.e. below the | |
1187 first horizontal separator line). For details, see @ref{Table calculations}. | |
1188 | |
1189 @kindex C-# | |
1190 @item C-# | |
64517 | 1191 Rotate the calculation mark in first column through the states |
63833 | 1192 @samp{}, @samp{#}, @samp{*}, @samp{!}, @samp{$}. For the meaning of |
64517 | 1193 these marks see @ref{Advanced features}. When there is an active |
63833 | 1194 region, change all marks in the region. |
1195 | |
58792 | 1196 @kindex C-c ? |
1197 @item C-c ? | |
1198 Which table column is the cursor in? Displays number >0 in echo | |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
1199 area. |
58792 | 1200 |
1201 @cindex region, active | |
1202 @cindex active region | |
1203 @cindex transient-mark-mode | |
1204 @kindex C-c + | |
1205 @item C-c + | |
1206 Sum the numbers in the current column, or in the rectangle defined by | |
63833 | 1207 the active region. The result is shown in the echo area and can |
58792 | 1208 be inserted with @kbd{C-y}. |
1209 | |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
1210 @kindex S-@key{RET} |
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
1211 @item S-@key{RET} |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
1212 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
|
1213 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
|
1214 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
|
1215 @code{org-table-copy-increment}, integer field values will be |
63362 | 1216 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
|
1217 (@pxref{Cooperation}). |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
1218 |
58792 | 1219 @tsubheading{Miscellaneous} |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1220 @kindex C-c ` |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1221 @item C-c ` |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1222 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
|
1223 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
|
1224 @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
|
1225 edited in place. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1226 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1227 @kindex C-c @key{TAB} |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1228 @item C-c @key{TAB} |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1229 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
|
1230 visible. |
58792 | 1231 |
1232 @item M-x org-table-import | |
1233 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
|
1234 separated. Useful, for example, to import an Excel table or data from a |
58792 | 1235 database, because these programs generally can write TAB-separated text |
1236 files. This command works by inserting the file into the buffer and | |
1237 then converting the region to a table. Any prefix argument is passed on | |
1238 to the converter, which uses it to determine the separator. | |
1239 | |
1240 @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
|
1241 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
|
1242 for example, Excel or database programs. |
58792 | 1243 |
1244 @end table | |
1245 | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1246 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
|
1247 way on lines which you would like to start with @samp{|}, you can turn |
58792 | 1248 it off with |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1249 |
58792 | 1250 @lisp |
1251 (setq org-enable-table-editor nil) | |
1252 @end lisp | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1253 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1254 @noindent Then the only table command that still works is |
58792 | 1255 @kbd{C-c C-c} to do a manual re-align. |
1256 | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1257 @node Narrow columns, Table calculations, Built-in table editor, Tables |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1258 @section Narrow columns |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1259 @cindex narrow columns in tables |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1260 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1261 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
|
1262 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
|
1263 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
|
1264 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
|
1265 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
|
1266 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
|
1267 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
|
1268 value. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1269 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1270 @example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1271 |---+------------------------------| |---+--------| |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1272 | | | | | <6> | |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1273 | 1 | one | | 1 | one | |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1274 | 2 | two | ----\ | 2 | two | |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1275 | 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
|
1276 | 4 | four | | 4 | four | |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1277 |---+------------------------------| |---+--------| |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1278 @end example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1279 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1280 @noindent |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1281 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
|
1282 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
|
1283 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
|
1284 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
|
1285 @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
|
1286 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
|
1287 C-c}. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1288 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1289 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
|
1290 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
|
1291 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
|
1292 @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
|
1293 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
|
1294 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
|
1295 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1296 @example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1297 #+STARTUP: align |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1298 #+STARTUP: noalign |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1299 @end example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1300 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1301 @node Table calculations, orgtbl-mode, Narrow columns, Tables |
63833 | 1302 @section Calculations in tables |
1303 @cindex calculations, in tables | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1304 @cindex spreadsheet capabilities |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1305 @cindex @file{calc} package |
63833 | 1306 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1307 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
|
1308 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1309 derive fields from other fields. Org-mode has two levels of complexity |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1310 for table calculations. On the basic level, tables do only horizontal |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1311 computations, so a field can be computed from other fields @emph{in the |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1312 same row}, and Org-mode assumes that there is only one formula for each |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1313 column. This is very efficient to work with and enough for many tasks. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1314 On the complex level, columns and individual fields can be named for |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1315 easier referencing in formulas, individual named fields can have their |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1316 own formula associated with them, and recalculation can be automated. |
63833 | 1317 |
1318 @menu | |
1319 * Formula syntax:: How to write a formula | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1320 * Lisp formulas:: An alternative way to write formulas |
64517 | 1321 * Column formulas:: Formulas valid for all fields in a column |
1322 * Advanced features:: Field names, parameters and automatic recalc | |
1323 * Named-field formulas:: Formulas valid in single fields | |
1324 * Editing/debugging formulas:: Changing a stored formula | |
1325 * Appetizer:: Taste the power of calc | |
63833 | 1326 @end menu |
1327 | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1328 @node Formula syntax, Lisp formulas, Table calculations, Table calculations |
63833 | 1329 @subsection Formula syntax |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1330 @cindex formula syntax |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1331 @cindex syntax, of formulas |
63833 | 1332 |
64517 | 1333 A formula can be any algebraic expression understood by the Emacs |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
1334 @file{calc} package. Note that @file{calc} has the slightly |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1335 non-standard convention that @samp{/} has lower precedence than |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
1336 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}. Before |
70065
4804517d7073
(Formula syntax): Fixed link to Calc Manual.
Carsten Dominik <dominik@science.uva.nl>
parents:
70011
diff
changeset
|
1337 evaluation by @code{calc-eval} (@pxref{Calling Calc from Your |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
1338 Programs,calc-eval,Calling calc from Your Lisp Programs,calc,GNU Emacs |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
1339 Calc Manual}), variable substitution takes place: |
64517 | 1340 |
1341 @example | |
1342 $ @r{refers to the current field} | |
1343 $3 @r{refers to the field in column 3 of the current row} | |
1344 $3..$7 @r{a vector of the fields in columns 3-7 of current row} | |
1345 $P1..$P3 @r{vector of column range, using column names} | |
1346 &2 @r{second data field above the current, in same column} | |
1347 &5-2 @r{vector from fifth to second field above current} | |
1348 &III-II @r{vector of fields between 2nd and 3rd hline above} | |
1349 &III @r{vector of fields between third hline above and current field} | |
1350 $name @r{a named field, parameter or constant} | |
1351 @end example | |
1352 | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1353 @cindex vectors, in table calculations |
64517 | 1354 The range vectors can be directly fed into the calc vector functions |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
1355 like @samp{vmean} and @samp{vsum}. |
64517 | 1356 |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1357 @cindex name, of column or field |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1358 @cindex constants, in calculations |
64517 | 1359 @samp{$name} is interpreted as the name of a column, parameter or |
1360 constant. Constants are defined globally through the variable | |
1361 @code{org-table-formula-constants}. If you have the | |
63833 | 1362 @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
|
1363 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
|
1364 constant, and units like @samp{$km} for kilometers. Column names and |
63833 | 1365 parameters can be specified in special table lines. These are |
64517 | 1366 described below, see @ref{Advanced features}. |
63833 | 1367 |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1368 @cindex format specifier |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1369 @cindex mode, for @file{calc} |
63833 | 1370 A formula can contain an optional mode string after a semicolon. This |
1371 string consists of flags to influence calc's modes@footnote{By | |
1372 default, Org-mode uses the standard calc modes (precision 12, angular | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1373 units degrees, fraction and symbolic modes off). The display format, |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1374 however, has been changed to @code{(float 5)} to keep tables compact. |
65656 | 1375 The default settings can be configured using the variable |
63833 | 1376 @code{org-calc-default-modes}.} during execution, e.g. @samp{p20} to |
1377 switch the internal precision to 20 digits, @samp{n3}, @samp{s3}, | |
1378 @samp{e2} or @samp{f4} to switch to normal, scientific, engineering, | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1379 or fixed display format, respectively, and @samp{D}, @samp{R}, @samp{F}, |
63833 | 1380 and @samp{S} to turn on degrees, radians, fraction and symbolic modes, |
64517 | 1381 respectively. In addition, you may provide a @code{printf} format |
1382 specifier to 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
|
1383 |
63833 | 1384 @example |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1385 $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
|
1386 $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
|
1387 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
|
1388 $;%.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
|
1389 ($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
|
1390 $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
|
1391 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
|
1392 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
|
1393 vmean($2..$7) @r{Compute column range mean, using vector function} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1394 vsum(&III) @r{Sum numbers from 3rd hline above, up to here} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1395 taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree} |
63833 | 1396 @end example |
1397 | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1398 @node Lisp formulas, Column formulas, Formula syntax, Table calculations |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1399 @subsection Emacs Lisp forms as formulas |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1400 @cindex Lisp forms, as table formulas |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1401 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1402 It is also possible to write a formula in Emacs lisp; this can be useful |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1403 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
|
1404 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
|
1405 evaluated as a lisp form. The evaluation should return either a string |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1406 or a number. Just as with @file{calc} formulas, you can provide a |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1407 format specifier after a semicolon. A few examples: |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1408 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1409 @example |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1410 @r{swap the first two characters of the content of column 1} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1411 '(concat (substring "$1" 1 2) (substring "$1" 0 1) (substring "$1" 2)) |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1412 @r{Add columns 1 and 2, equivalent to the calc's @code{$1+$2}} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1413 '(+ $1 $2) |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1414 @end example |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1415 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1416 @node Column formulas, Advanced features, Lisp formulas, Table calculations |
64517 | 1417 @subsection Column formulas |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1418 @cindex column formula |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1419 @cindex formula, for table column |
63833 | 1420 |
1421 To apply a formula to a field, type it directly into the field, | |
1422 preceded by an equal sign, like @samp{=$1+$2}. When you press | |
1423 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the | |
64517 | 1424 field, the formula will be stored as the formula for the current |
1425 column, evaluated and the current field replaced with the result. If | |
1426 the field contains only @samp{=}, the previously stored formula for | |
1427 this column is used. | |
63833 | 1428 |
1429 For each column, Org-mode will remember the most recently used | |
64517 | 1430 formula. The information is stored in a special line starting with |
1431 @samp{#+TBLFM} directly below the table. When adding/deleting/moving | |
1432 columns with the appropriate commands, the stored equations will be | |
1433 modified accordingly. When a column used in a calculation is removed, | |
1434 references to this column become invalid and will cause an error upon | |
1435 applying the equation. | |
63833 | 1436 |
1437 Instead of typing an equation into the field, you may also use the | |
1438 command @kbd{C-c =}. It prompts for a formula (with default taken | |
64517 | 1439 from the @samp{#+TBLFM:} line) and applies it to the current field. A |
1440 numerical prefix (e.g. @kbd{C-5 C-c =}) will apply it to that many | |
71246
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
1441 consecutive fields in the current column. |
58792 | 1442 |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1443 @cindex recomputing table fields |
63833 | 1444 To recompute all the fields in a line, use the command @kbd{C-c *}. |
1445 It re-applies all stored equations to the current row, from left to | |
1446 right. With a @kbd{C-u} prefix, this will be done to every line in | |
1447 the table, so use this command it you want to make sure the entire | |
64517 | 1448 table is up-to-date. @kbd{C-u C-c C-c} is another way to update the |
1449 entire table. Global updating does not touch the line(s) above the | |
1450 first horizontal separator line, assuming that this is the table | |
1451 header. | |
1452 | |
1453 @node Advanced features, Named-field formulas, Column formulas, Table calculations | |
1454 @subsection Advanced features | |
1455 | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1456 If you want the recalculation of fields to happen automatically, |
64517 | 1457 or if you want to be able to assign a formula to an individual field |
1458 (instead of an entire column) you need to reserve the first column of | |
1459 the table for special marking characters. Here is an example of a | |
1460 table that collects exam results of students and makes use of these | |
1461 features: | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1462 |
63833 | 1463 @example |
1464 @group | |
1465 |---+---------+--------+--------+--------+-------+------| | |
1466 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note | | |
1467 |---+---------+--------+--------+--------+-------+------| | |
1468 | ! | | P1 | P2 | P3 | Tot | | | |
1469 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 | | |
64069 | 1470 | ^ | | m1 | m2 | m3 | mt | | |
63833 | 1471 |---+---------+--------+--------+--------+-------+------| |
1472 | # | Peter | 10 | 8 | 23 | 41 | 8.2 | | |
64517 | 1473 | # | Sara | 6 | 14 | 19 | 39 | 7.8 | |
63833 | 1474 | # | Sam | 2 | 4 | 3 | 9 | 1.8 | |
1475 |---+---------+--------+--------+--------+-------+------| | |
64517 | 1476 | | Average | | | | 29.7 | | |
1477 | ^ | | | | | at | | | |
63833 | 1478 | $ | max=50 | | | | | | |
1479 |---+---------+--------+--------+--------+-------+------| | |
64517 | 1480 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(&II);%.1f |
63833 | 1481 @end group |
1482 @end example | |
64517 | 1483 |
1484 @noindent @b{Important}: Please note that for these special tables, | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1485 recalculating the table with @kbd{C-u C-c *} will only affect rows |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1486 that are marked @samp{#} or @samp{*}, and named fields. The column |
64517 | 1487 formulas are not applied in rows with empty first field. |
1488 | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1489 @cindex marking characters, tables |
64517 | 1490 The marking characters have the following meaning: |
1491 @table @samp | |
1492 @item ! | |
1493 The fields in this line define names for the columns, so that you may | |
1494 refer to a column as @samp{$Tot} instead of @samp{$6}. | |
1495 @item ^ | |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
1496 This row defines names for the fields @emph{above} the row. With such |
64517 | 1497 a definition, any formula in the table may use @samp{$m1} to refer to |
1498 the value @samp{10}. Also, named fields can have their own formula | |
1499 associated with them. | |
1500 @item _ | |
1501 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
|
1502 @emph{below}. |
64517 | 1503 @item $ |
1504 Fields in this row can define @emph{parameters} for formulas. For | |
1505 example, if a field in a @samp{$} row contains @samp{max=50}, then | |
1506 formulas in this table can refer to the value 50 using @samp{$max}. | |
1507 Parameters work exactly like constants, only that they can be defined on | |
1508 a per-table basis. Changing a parameter and then recalculating the | |
1509 table can be useful. | |
1510 @item # | |
1511 Fields in this row are automatically recalculated when pressing | |
1512 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row | |
1513 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked | |
1514 lines will be left alone by this command. | |
1515 @item * | |
1516 Selects this line for global recalculation with @kbd{C-u C-c *}, but | |
1517 not for automatic recalculation. Use this when automatic | |
1518 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
|
1519 @item |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1520 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}. |
64517 | 1521 All lines that should be recalculated should be marked with @samp{#} |
1522 or @samp{*}. | |
1523 @end table | |
1524 | |
1525 @node Named-field formulas, Editing/debugging formulas, Advanced features, Table calculations | |
1526 @subsection Named-field formulas | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1527 @cindex named field formula |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1528 @cindex formula, for named table field |
64517 | 1529 |
1530 A named field can have its own formula associated with it. In the | |
1531 example above, this is used for the @samp{at} field that contains | |
1532 the average result of the students. To enter a formula for a named | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1533 field, just type it into the buffer, preceded by @samp{:=}. Or use |
64517 | 1534 @kbd{C-u C-c =}. This equation will be stored below the table like |
1535 @samp{$name=...}. Any recalculation in the table (even if only | |
1536 requested for the current line) will also update all named field | |
1537 formulas. | |
1538 | |
1539 @node Editing/debugging formulas, Appetizer, Named-field formulas, Table calculations | |
1540 @subsection Editing and debugging formulas | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1541 @cindex formula editing |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1542 @cindex editing, of table formulas |
64517 | 1543 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1544 To edit a column or field formula, use the commands @kbd{C-c |
64517 | 1545 =} and @kbd{C-u C-c =}, respectively. The currently active expression |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1546 is then presented as default in the minibuffer, where it may be edited. |
64517 | 1547 |
1548 Note that making a table field blank does not remove the formula | |
1549 associated with the field - during the next recalculation the field | |
1550 will be filled again. To remove a formula from a field, you have to | |
1551 give an empty reply when prompted for the formula, or to edit the | |
1552 @samp{#+TBLFM} line. | |
1553 | |
1554 @kindex C-c C-c | |
1555 You may edit the @samp{#+TBLFM} directly and re-apply | |
1556 the changed equations with @kbd{C-c C-c} in that line, or with the | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1557 normal recalculation commands in the table. |
64517 | 1558 |
1559 @kindex C-c ' | |
1560 @kindex C-c C-c | |
1561 @kindex C-c C-q | |
1562 @kindex C-c ? | |
1563 In particular for large tables with many formulas, it is convenient to | |
1564 use the command @kbd{C-c '} to edit the formulas of the current table | |
1565 in a separate buffer. That buffer will show the formulas one per | |
1566 line, and you are free to edit, add and remove formulas. Press | |
1567 @kbd{C-c ?} on a @samp{$...} expression to get information about its | |
1568 interpretation. Exiting the buffer with @kbd{C-c C-c} only stores the | |
1569 modified formulas below the table. Exiting with @kbd{C-u C-c C-c} | |
1570 also applies them to the entire table. @kbd{C-c C-q} exits without | |
1571 installing the changes. | |
1572 | |
1573 When the evaluation of a formula leads to an error, the field content | |
1574 becomes the string @samp{#ERROR}. If you would like see what is going | |
1575 on during variable substitution and calculation in order to find a | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1576 bug, turn on formula debugging in the menu and repeat the calculation, |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1577 for example by pressing @kbd{C-c = @key{RET}} in a field. |
64517 | 1578 Detailed information will be displayed. |
1579 | |
1580 @node Appetizer, , Editing/debugging formulas, Table calculations | |
1581 @subsection Appetizer | |
1582 | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1583 Finally, just to whet your appetite on what can be done with the fantastic |
63833 | 1584 @file{calc} package, here is a table that computes the Taylor series |
1585 for a couple of functions (homework: try that with Excel :-) | |
1586 | |
1587 @example | |
1588 @group | |
1589 |---+-------------+---+-----+--------------------------------------| | |
1590 | | Func | n | x | Result | | |
1591 |---+-------------+---+-----+--------------------------------------| | |
1592 | # | exp(x) | 1 | x | 1 + x | | |
1593 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 | | |
1594 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 | | |
1595 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 | | |
1596 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 | | |
1597 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 | | |
1598 |---+-------------+---+-----+--------------------------------------| | |
1599 #+TBLFM: $5=taylor($2,$4,$3);n3 | |
1600 @end group | |
1601 @end example | |
1602 | |
1603 @node orgtbl-mode, table.el, Table calculations, Tables | |
59541 | 1604 @section The Orgtbl minor mode |
1605 @cindex orgtbl-mode | |
63833 | 1606 @cindex minor mode for tables |
59541 | 1607 |
1608 If you like the intuitive way the Org-mode table editor works, you | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1609 might also want to use it in other modes like text-mode or mail-mode. |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1610 The minor mode Orgtbl-mode makes this possible. You can always toggle |
59541 | 1611 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for |
1612 example in mail mode, use | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1613 |
59541 | 1614 @lisp |
1615 (add-hook 'mail-mode-hook 'turn-on-orgtbl) | |
1616 @end lisp | |
1617 | |
63833 | 1618 @node table.el, , orgtbl-mode, Tables |
1619 @section The @file{table.el} package | |
1620 @kindex C-c C-c | |
1621 @cindex table editor, @file{table.el} | |
1622 @cindex @file{table.el} | |
1623 | |
1624 Complex ASCII tables with automatic line wrapping, column- and | |
1625 row-spanning, and alignment can be created using the Emacs table | |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1626 package by Takaaki Ota (@uref{http://sourceforge.net/projects/table}, |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1627 and also part of Emacs 22). |
63833 | 1628 When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org-mode |
1629 will call @command{table-recognize-table} and move the cursor into the | |
1630 table. Inside a table, the keymap of Org-mode is inactive. In order | |
1631 to execute Org-mode-related commands, leave the table. | |
1632 | |
1633 @table @kbd | |
1634 @kindex C-c C-c | |
1635 @item C-c C-c | |
1636 Recognize @file{table.el} table. Works when the cursor is in a | |
1637 table.el table. | |
1638 | |
1639 @kindex C-c ~ | |
1640 @item C-c ~ | |
1641 Insert a table.el table. If there is already a table at point, this | |
1642 command converts it between the table.el format and the Org-mode | |
1643 format. See the documentation string of the command | |
1644 @code{org-convert-table} for the restrictions under which this is | |
1645 possible. | |
1646 @end table | |
1647 | |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
1648 @node Hyperlinks, TODO items, Tables, Top |
58792 | 1649 @chapter Hyperlinks |
1650 @cindex hyperlinks | |
1651 | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1652 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
|
1653 links to other files, Usenet articles, emails, and much more. |
58792 | 1654 |
1655 @menu | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1656 * 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
|
1657 * 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
|
1658 * External links:: URL-like links to the world |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1659 * 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
|
1660 * 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
|
1661 * 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
|
1662 * Custom searches:: When the default search is not enough |
58792 | 1663 * Remember:: Org-trees store quick notes |
1664 @end menu | |
1665 | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1666 @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
|
1667 @section Link format |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1668 @cindex link format |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1669 @cindex format, of links |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1670 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1671 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
|
1672 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
|
1673 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1674 @example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1675 [[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
|
1676 @end example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1677 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1678 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
|
1679 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
|
1680 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
|
1681 @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
|
1682 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
|
1683 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
|
1684 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
|
1685 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
|
1686 cursor on the link. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1687 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1688 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
|
1689 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
|
1690 (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
|
1691 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
|
1692 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
|
1693 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
|
1694 @code{Org->Hyperlinks->Literal links}. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1695 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1696 @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
|
1697 @section Internal links |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1698 @cindex internal links |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1699 @cindex links, internal |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1700 @cindex CamelCase links |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1701 @cindex targets, for links |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1702 |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1703 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
|
1704 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
|
1705 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
|
1706 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
|
1707 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
|
1708 match for such a link is a dedicated target: the same string in double |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1709 angular brackets. Targets may be located anywhere; often it is |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1710 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
|
1711 |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1712 @example |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1713 # <<My Target>> |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1714 @end example |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1715 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
1716 @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
|
1717 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
|
1718 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
|
1719 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
|
1720 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1721 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
|
1722 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
|
1723 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
|
1724 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
|
1725 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
|
1726 @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
|
1727 |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1728 @example |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1729 ** My targets |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1730 ** TODO my targets are bright |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1731 ** my 20 targets are |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1732 @end example |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1733 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1734 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
|
1735 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
|
1736 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
|
1737 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
|
1738 creating links. |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1739 |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1740 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
|
1741 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
|
1742 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
|
1743 earlier. |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1744 |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1745 @menu |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1746 * 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
|
1747 * CamelCase links:: Activating CamelCase words as links |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1748 @end menu |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1749 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1750 @node Radio targets, CamelCase links, 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
|
1751 @subsection Radio targets |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1752 @cindex radio targets |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1753 @cindex targets, radio |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1754 @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
|
1755 |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1756 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
|
1757 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
|
1758 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
|
1759 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
|
1760 @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
|
1761 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
|
1762 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
|
1763 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
|
1764 @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
|
1765 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1766 @node CamelCase links, , Radio targets, Internal links |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1767 @subsection CamelCase words as links |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1768 @cindex completion, of CamelCase links |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1769 @cindex CamelCase links, completion of |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1770 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1771 Org-mode also supports CamelCase words as links. This feature is not |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1772 turned on by default because of the inconsistencies this system suffers |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1773 from. It is also possible that this feature will disappear entirely in |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1774 a future version of Org-mode. To activate CamelCase words as links, you |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1775 need to customize the option @code{org-activate-links}. A CamelCase |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1776 word then leads to a text search such that @samp{CamelCaseLink} is |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1777 equivalent to @samp{[[camel case link]]}. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1778 |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1779 @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
|
1780 @section External links |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1781 @cindex links, external |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1782 @cindex external links |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1783 @cindex links, external |
58792 | 1784 @cindex GNUS links |
1785 @cindex BBDB links | |
63833 | 1786 @cindex URL links |
1787 @cindex file links | |
58792 | 1788 @cindex VM links |
1789 @cindex RMAIL links | |
1790 @cindex WANDERLUST links | |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1791 @cindex MH-E links |
58792 | 1792 @cindex USENET links |
1793 @cindex SHELL links | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1794 @cindex Info links |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1795 @cindex elisp links |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1796 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1797 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
|
1798 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
|
1799 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
|
1800 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
|
1801 link type. |
58792 | 1802 |
1803 @example | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1804 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
|
1805 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
|
1806 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
|
1807 news:comp.emacs @r{Usenet link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1808 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
|
1809 vm:folder @r{VM folder link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1810 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
|
1811 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
|
1812 wl:folder @r{WANDERLUST folder link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1813 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
|
1814 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
|
1815 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
|
1816 rmail:folder @r{RMAIL folder link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1817 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
|
1818 gnus:group @r{GNUS group link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1819 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
|
1820 bbdb:Richard Stallman @r{BBDB link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1821 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
|
1822 elisp:(find-file-other-frame "Elisp.org") @r{An elisp form to evaluate} |
58792 | 1823 @end example |
1824 | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1825 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
|
1826 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
|
1827 format}), for example: |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1828 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1829 @example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1830 [[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
|
1831 @end example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1832 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1833 @cindex angular brackets, around links |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1834 @cindex plain text external links |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1835 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
|
1836 as links. If spaces must be part of the link (for example in |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1837 @samp{bbdb:Richard Stallman}), or you need to remove ambiguities about the end of |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1838 the link, enclose them in angular brackets. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1839 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1840 @node Handling links, Link abbreviations, External links, Hyperlinks |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1841 @section Handling links |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1842 @cindex links, handling |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1843 |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1844 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
|
1845 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
|
1846 |
58792 | 1847 @table @kbd |
1848 @kindex C-c l | |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1849 @cindex storing links |
58792 | 1850 @item C-c l |
1851 Store a link to the current location. This is a @emph{global} command | |
1852 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
|
1853 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
|
1854 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
|
1855 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
|
1856 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
|
1857 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
|
1858 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
|
1859 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
|
1860 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
|
1861 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
|
1862 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
|
1863 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
|
1864 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
|
1865 The key binding @kbd{C-c l} is only a suggestion - see @ref{Installation}. |
58792 | 1866 |
1867 @kindex C-c C-l | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1868 @cindex link completion |
63833 | 1869 @cindex completion, of links |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1870 @cindex inserting links |
58792 | 1871 @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
|
1872 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
|
1873 You can just type a link, using text for an internal link, or one of the |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1874 link type prefixes mentioned in the examples above. Through completion, |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
1875 all links stored during the current session can be |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
1876 accessed@footnote{After insertion of a stored link, the link will be |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
1877 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
|
1878 use, use a triple @kbd{C-u} prefix to @kbd{C-c C-l}, or configure the |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
1879 option @code{org-keep-stored-link-after-insertion}.}. The link |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1880 will be inserted into the buffer, along with a descriptive text. Note |
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1881 that you don't have to use this command to insert a link. Links in |
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1882 Org-mode are plain text, and you can type or paste them straight into |
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1883 the buffer. By using this command, the links are automatically enclosed |
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1884 in double brackets, and you will be asked for the optional descriptive |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1885 text. If the link is a @samp{file:} link and the linked file is located |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1886 in the same directory as the current file or a subdirectory of it, the |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1887 path of the file will be inserted relative to the current directory. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1888 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1889 @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
|
1890 @cindex file name completion |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1891 @cindex completion, of file names |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1892 @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
|
1893 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
|
1894 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
|
1895 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
|
1896 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
|
1897 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
|
1898 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
|
1899 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
|
1900 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
|
1901 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1902 @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
|
1903 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
|
1904 link and description parts of the link. |
58792 | 1905 |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1906 @cindex following links |
58792 | 1907 @kindex C-c C-o |
1908 @item C-c C-o | |
1909 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
|
1910 @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
|
1911 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
|
1912 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
|
1913 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
|
1914 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
|
1915 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
|
1916 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
|
1917 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
|
1918 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
|
1919 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
|
1920 Emacs, use a @kbd{C-u} prefix. |
58792 | 1921 |
1922 @kindex mouse-2 | |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
1923 @kindex mouse-1 |
58792 | 1924 @item mouse-2 |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
1925 @itemx mouse-1 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1926 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
|
1927 would. Under Emacs 22, also @kbd{mouse-1} will follow a link. |
58792 | 1928 |
1929 @kindex mouse-3 | |
1930 @item mouse-3 | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1931 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
|
1932 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
|
1933 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
|
1934 |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1935 @cindex mark ring |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1936 @kindex C-c % |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1937 @item C-c % |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1938 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
|
1939 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
|
1940 |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1941 @cindex links, returning to |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1942 @kindex C-c & |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1943 @item C-c & |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
1944 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
|
1945 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
|
1946 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
|
1947 previously recorded positions. |
58792 | 1948 @end table |
1949 | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1950 @node Link abbreviations, Search options, Handling links, Hyperlinks |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1951 @section Link abbreviatons |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1952 @cindex link abbreviations |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1953 @cindex abbreviation, links |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1954 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1955 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
|
1956 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
|
1957 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
|
1958 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1959 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1960 [[linkword::tag][description]] |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1961 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1962 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1963 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1964 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
|
1965 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
|
1966 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
|
1967 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1968 @lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1969 @group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1970 (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
|
1971 '(("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
|
1972 ("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
|
1973 ("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
|
1974 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
|
1975 @end group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1976 @end lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1977 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1978 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
|
1979 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
|
1980 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
|
1981 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
|
1982 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1983 With the above setting, you could link to a specific bug with |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1984 @code{[[bugzilla::129]]}, search the web for OrgMode with |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1985 @code{[[google::OrgMode]]} and find out what the Org-mode author is |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1986 doing besides Emacs hacking with @code{[[ads::Dominik,C]]}. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1987 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1988 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
|
1989 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
|
1990 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1991 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1992 #+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
|
1993 #+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
|
1994 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1995 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1996 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1997 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
|
1998 complete link abbreviations. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1999 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2000 @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
|
2001 @section Search options in file links |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2002 @cindex search option in file links |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2003 @cindex file links, searching |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2004 |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2005 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
|
2006 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
|
2007 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
|
2008 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
|
2009 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
|
2010 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
|
2011 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
|
2012 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
|
2013 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2014 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
|
2015 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
|
2016 |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2017 @example |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2018 [[file:~/code/main.c::255]] |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2019 [[file:~/xx.org::My Target]] |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2020 [[file:~/xx.org::*My Target]] |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2021 [[file:~/xx.org::/regexp/]] |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2022 @end example |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2023 |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2024 @table @code |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2025 @item 255 |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2026 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
|
2027 @item My Target |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2028 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
|
2029 @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
|
2030 @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
|
2031 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
|
2032 the linked file. |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2033 @item *My Target |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2034 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
|
2035 @item /regexp/ |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2036 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
|
2037 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
|
2038 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
|
2039 sparse tree with the matches. |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2040 @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
|
2041 @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
|
2042 @end table |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2043 |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2044 As a degenerate case, a file link with an empty file name can be used |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2045 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
|
2046 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
|
2047 @samp{[[find me]]} would. |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2048 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2049 @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
|
2050 @section Custom Searches |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2051 @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
|
2052 @cindex search strings, custom |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2053 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2054 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
|
2055 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
|
2056 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
|
2057 @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
|
2058 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
|
2059 citation key. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2060 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2061 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
|
2062 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
|
2063 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
|
2064 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
|
2065 @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
|
2066 @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
|
2067 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
|
2068 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
|
2069 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
|
2070 file. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2071 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2072 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2073 @node Remember, , Custom searches, Hyperlinks |
58792 | 2074 @section Remember |
2075 @cindex @file{remember.el} | |
2076 | |
2077 Another way to create org entries with links to other files is through | |
2078 the @emph{Remember} package by John Wiegley. @emph{Remember} lets you | |
2079 store quick notes with little interruption of your work flow. See | |
2080 @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more | |
2081 information. The notes produced by @emph{Remember} can be stored in | |
64517 | 2082 different ways, and Org-mode files are a good target. Org-mode allows |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2083 you to file away notes either to a default file, or directly to the correct |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2084 location in your Org-mode outline tree. The following customization |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2085 will tell @emph{Remember} to use org files as target, and to create |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2086 annotations compatible with Org-mode links. |
64517 | 2087 |
58792 | 2088 @example |
2089 (setq org-directory "~/path/to/my/orgfiles/") | |
2090 (setq org-default-notes-file "~/.notes") | |
2091 (setq remember-annotation-functions '(org-remember-annotation)) | |
2092 (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
|
2093 (add-hook 'remember-mode-hook 'org-remember-apply-template) |
58792 | 2094 @end example |
2095 | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2096 @cindex templates, for remember |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2097 In combination with Org-mode, you can use templates to generate |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2098 different types of remember notes. For example, if you would like to |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2099 use one template to create general TODO entries, and another one for |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2100 journal entries, you could use: |
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 @example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2103 (setq org-remember-templates |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2104 '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org") |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2105 (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org"))) |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2106 @end example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2107 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2108 @noindent In these entries, the character specifies how to select the |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2109 template, the first string specifies the template, and the (optional) |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2110 second string specifies a default file (overruling |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2111 @code{org-default-notes-file}) as a target for this note. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2112 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2113 When you call @kbd{M-x remember} to remember something, org will prompt |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2114 for a key to select the template and then prepare the buffer like |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2115 @example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2116 * TODO |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2117 <file:link to where you called remember> |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2118 @end example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2119 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2120 @noindent or |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2121 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2122 @example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2123 * [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
|
2124 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2125 <file:link to where you called remember> |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2126 @end example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2127 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2128 @noindent See the variable @code{org-remember-templates} for more details. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2129 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2130 When you are finished composing a note with remember, you have to press |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2131 @kbd{C-c C-c} to file the note away. The handler first prompts for a |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2132 target file - if you press @key{RET}, the value of |
58792 | 2133 @code{org-default-notes-file} is used. Then the command offers the |
2134 headings tree of the selected file. You can either immediately press | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2135 @key{RET} to get the note appended to the file. Or you can use vertical |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2136 cursor motion (@key{up} and @key{down}) and visibility cycling |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2137 (@key{TAB}) to find a better place. Pressing @key{RET} or @key{left} or |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2138 @key{right} leads to the following result. |
58792 | 2139 |
2140 @multitable @columnfractions 0.2 0.1 0.7 | |
2141 @item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted} | |
2142 @item buffer-start @tab @key{RET} @tab as level 2 heading at end of file | |
2143 @item on headline @tab @key{RET} @tab as sublevel of the heading at cursor | |
2144 @item @tab @key{left} @tab as same level, before current heading | |
2145 @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
|
2146 @item not on headline @tab @key{RET} |
58792 | 2147 @tab at cursor position, level taken from context. |
2148 Or use prefix arg to specify level manually. | |
2149 @end multitable | |
2150 | |
63362 | 2151 So a fast way to store the note is to press @kbd{C-c C-c @key{RET} |
2152 @key{RET}} to append it to the default file. Even shorter would be | |
2153 @kbd{C-u C-c C-c}, which does the same without even showing the tree. | |
2154 But with little extra effort, you can push it directly to the correct | |
2155 location. | |
58792 | 2156 |
2157 Before inserting the text into a tree, the function ensures that the | |
2158 text has a headline, i.e. a first line that starts with a @samp{*}. | |
2159 If not, a headline is constructed from the current date and some | |
2160 additional data. If the variable @code{org-adapt-indentation} is | |
63833 | 2161 non-nil, the entire text is also indented so that it starts in the |
2162 same column as the headline (after the asterisks). | |
58792 | 2163 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2164 |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2165 @node TODO items, Timestamps, Hyperlinks, Top |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2166 @chapter TODO items |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2167 @cindex TODO items |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2168 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2169 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
|
2170 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
|
2171 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
|
2172 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
|
2173 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
|
2174 item emerged is always present when you check. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2175 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2176 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
|
2177 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
|
2178 things you have to do. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2179 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2180 @menu |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2181 * TODO basics:: Marking and displaying TODO entries |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2182 * TODO extensions:: Workflow and assignments |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2183 * 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
|
2184 * 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
|
2185 * Checkboxes:: Tick-off lists |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2186 @end menu |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2187 |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2188 @node TODO basics, TODO extensions, TODO items, TODO items |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2189 @section Basic TODO functionality |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2190 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2191 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
|
2192 for example: |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2193 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2194 @example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2195 *** TODO Write letter to Sam Fortune |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2196 @end example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2197 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2198 @noindent |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2199 The most important commands to work with TODO entries are: |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2200 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2201 @table @kbd |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2202 @kindex C-c C-t |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2203 @cindex cycling, of TODO states |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2204 @item C-c C-t |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2205 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
|
2206 |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2207 @example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2208 ,-> (unmarked) -> TODO -> DONE --. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2209 '--------------------------------' |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2210 @end example |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2211 |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2212 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
|
2213 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
|
2214 @kindex S-@key{right} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2215 @kindex S-@key{left} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2216 @item S-@key{right} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2217 @itemx S-@key{left} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2218 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
|
2219 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
|
2220 @kindex C-c C-v |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2221 @cindex sparse tree, for TODO |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2222 @item C-c C-v |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2223 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
|
2224 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
|
2225 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
|
2226 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
|
2227 @code{org-todo-keywords}. |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2228 @kindex C-c a t |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2229 @item C-c a t |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2230 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
|
2231 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
|
2232 @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
|
2233 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
|
2234 @xref{Global TODO list}, for more information. |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
2235 @c @item @code{org-agenda-include-all-todo} |
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
2236 @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
|
2237 @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
|
2238 @end table |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2239 |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2240 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2241 @node TODO extensions, Priorities, TODO basics, TODO items |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2242 @section Extended use of TODO keywords |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2243 @cindex extended TODO keywords |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2244 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2245 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
|
2246 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
|
2247 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
|
2248 @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
|
2249 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
|
2250 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2251 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
|
2252 TODO items in particular (@pxref{Tags}). |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2253 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2254 @menu |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2255 * Workflow states:: From TODO to DONE in steps |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2256 * TODO types:: I do this, Fred the rest |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2257 * Per file keywords:: Different files, different requirements |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2258 @end menu |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2259 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2260 @node Workflow states, TODO types, TODO extensions, TODO extensions |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2261 @subsection TODO keywords as workflow states |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2262 @cindex TODO workflow |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2263 @cindex workflow states as TODO keywords |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2264 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2265 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
|
2266 of working on an item, for example: |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2267 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2268 @lisp |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2269 (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE") |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2270 org-todo-interpretation 'sequence) |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2271 @end lisp |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2272 |
63833 | 2273 @cindex completion, of TODO keywords |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2274 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
|
2275 With this setup, the command @kbd{C-c C-t} will cycle an entry from |
65656 | 2276 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
|
2277 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
|
2278 @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
|
2279 If you define many keywords, you can use in-buffer completion (see |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2280 @ref{Completion}) to insert these words into the buffer. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2281 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2282 @node TODO types, Per file keywords, Workflow states, TODO extensions |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2283 @subsection TODO keywords as types |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2284 @cindex TODO types |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2285 @cindex names as TODO keywords |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2286 @cindex types as TODO keywords |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2287 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2288 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
|
2289 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
|
2290 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
|
2291 @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
|
2292 @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
|
2293 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
|
2294 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
|
2295 keywords. This would be set up like this: |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2296 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2297 @lisp |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2298 (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE") |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2299 org-todo-interpretation 'type) |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2300 @end lisp |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2301 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2302 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
|
2303 rather different types. So it is normally not useful to change from |
63833 | 2304 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
|
2305 command @kbd{C-c C-t} is changed slightly@footnote{This is also true |
63833 | 2306 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
|
2307 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
|
2308 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
|
2309 @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
|
2310 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
|
2311 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
|
2312 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
|
2313 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
|
2314 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
|
2315 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
|
2316 @kbd{C-3 C-c t}. |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2317 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2318 @node Per file keywords, , TODO types, TODO extensions |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2319 @subsection Setting up TODO keywords for individual files |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2320 @cindex keyword options |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2321 @cindex per file keywords |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2322 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2323 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
|
2324 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
|
2325 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
|
2326 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
|
2327 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
|
2328 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
|
2329 anywhere in the file: |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2330 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2331 @example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2332 #+SEQ_TODO: TODO FEEDBACK VERIFY DONE |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2333 #+TYP_TODO: Fred Sara Lucy Mike DONE |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2334 @end example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2335 |
63833 | 2336 @cindex Completion, of option keywords |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2337 @kindex M-@key{TAB} |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2338 @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
|
2339 @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
|
2340 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2341 @cindex DONE, final TODO keyword |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2342 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
|
2343 (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
|
2344 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
|
2345 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
|
2346 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
|
2347 parses these lines only when Org-mode is activated after visiting a |
65656 | 2348 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
|
2349 is simply restarting Org-mode for the current buffer.}. |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2350 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2351 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
|
2352 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
|
2353 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2354 @example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2355 #+TYP_TODO: Fred Sara Lucy Mike |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2356 #+TYP_TODO: Luis George Jules Jessica |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2357 #+TYP_TODO: Kim Arnold Peter |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2358 #+TYP_TODO: DONE |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2359 @end example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2360 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2361 @node Priorities, Breaking down tasks, TODO extensions, TODO items |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2362 @section Priorities |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2363 @cindex priorities |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2364 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2365 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
|
2366 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
|
2367 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
|
2368 headline, like this |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2369 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2370 @example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2371 *** TODO [#A] Write letter to Sam Fortune |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2372 @end example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2373 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2374 @noindent |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2375 With its standard setup, Org-mode supports priorities @samp{A}, |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2376 @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
|
2377 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
|
2378 difference only in the agenda (@pxref{Weekly/Daily agenda}). |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2379 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2380 @table @kbd |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2381 @kindex @kbd{C-c ,} |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2382 @item @kbd{C-c ,} |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2383 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
|
2384 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
|
2385 @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
|
2386 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
|
2387 agenda buffer with the @kbd{,} command (@pxref{Agenda commands}). |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2388 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2389 @kindex S-@key{up} |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2390 @kindex S-@key{down} |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2391 @item S-@key{up} |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2392 @itemx S-@key{down} |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2393 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
|
2394 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
|
2395 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
|
2396 @end table |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2397 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2398 @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
|
2399 @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
|
2400 @cindex tasks, breaking down |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2401 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2402 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
|
2403 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
|
2404 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
|
2405 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
|
2406 @code{org-agenda-todo-list-sublevels}.}. Another possibility is the use |
74030 | 2407 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
|
2408 (@pxref{Checkboxes}). |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2409 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2410 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2411 @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
|
2412 @section Checkboxes |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2413 @cindex checkboxes |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2414 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2415 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
|
2416 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
|
2417 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
|
2418 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
|
2419 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
|
2420 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
|
2421 @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
|
2422 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2423 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2424 * 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
|
2425 - call people [1/3] |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2426 - [ ] Peter |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2427 - [X] Sarah |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2428 - [ ] Sam |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2429 - [X] order food |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2430 - [ ] 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
|
2431 - [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
|
2432 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2433 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2434 @cindex statistics, for checkboxes |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2435 @cindex checkbox statistics |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2436 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
|
2437 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
|
2438 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
|
2439 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
|
2440 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
|
2441 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
|
2442 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
|
2443 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
|
2444 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
|
2445 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
|
2446 @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
|
2447 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2448 @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
|
2449 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2450 @table @kbd |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2451 @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
|
2452 @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
|
2453 Toggle checkbox at point. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2454 @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
|
2455 @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
|
2456 Toggle checkbox at point. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2457 @itemize @minus |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2458 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2459 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
|
2460 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
|
2461 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
|
2462 argument. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2463 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2464 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
|
2465 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
|
2466 @item |
74030 | 2467 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
|
2468 @end itemize |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2469 @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
|
2470 @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
|
2471 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
|
2472 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
|
2473 (@pxref{Plain lists}). |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2474 @kindex C-c # |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2475 @item C-c # |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2476 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
|
2477 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
|
2478 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
|
2479 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
|
2480 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
|
2481 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
|
2482 @end table |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2483 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2484 @node Timestamps, Tags, TODO items, Top |
58792 | 2485 @chapter Timestamps |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2486 @cindex time stamps |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2487 @cindex date stamps |
58792 | 2488 |
2489 Items can be labeled with timestamps to make them useful for project | |
2490 planning. | |
2491 | |
2492 @menu | |
2493 * Time stamps:: Assigning a time to a tree entry | |
2494 * 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
|
2495 * Custom time format:: If you cannot work with the ISO format |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2496 * Progress logging:: Documenting when what work was done. |
58792 | 2497 @end menu |
2498 | |
2499 | |
2500 @node Time stamps, Creating timestamps, Timestamps, Timestamps | |
2501 @section Time stamps, deadlines and scheduling | |
2502 @cindex time stamps | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2503 @cindex ranges, time |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2504 @cindex date stamps |
58792 | 2505 @cindex deadlines |
2506 @cindex scheduling | |
2507 | |
2508 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
|
2509 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
|
2510 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
|
2511 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
|
2512 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
|
2513 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
|
2514 (@pxref{Weekly/Daily agenda}). We distinguish: |
58792 | 2515 |
2516 @table @var | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2517 @item Plain time stamp |
58792 | 2518 @cindex timestamp |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2519 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
|
2520 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
|
2521 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
|
2522 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
|
2523 associated with a plain time stamp will be shown exactly on that date. |
58792 | 2524 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2525 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2526 * 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
|
2527 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2528 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2529 @item Inactive time stamp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2530 @cindex timestamp, inactive |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2531 @cindex inactive timestamp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2532 Just like a plain time stamp, but with square brackets instead of |
74030 | 2533 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
|
2534 @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
|
2535 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2536 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2537 * 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
|
2538 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2539 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2540 @item Time stamp range |
58792 | 2541 @cindex timerange |
2542 Two time stamps connected by @samp{--} denote a time range. The | |
2543 headline will be shown on the first and last day of the range, and on | |
2544 any dates that are displayed and fall in the range. Here is an | |
2545 example: | |
2546 | |
2547 @example | |
2548 ** Meeting in Amsterdam | |
2549 <2004-08-23 Mon>--<2004-08-26 Thu> | |
2550 @end example | |
2551 | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2552 @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
|
2553 @cindex SCHEDULED keyword |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2554 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
|
2555 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
|
2556 not about recording an event, but about planning your work. The |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2557 headline will be listed under the given date. In addition, a reminder |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2558 that the scheduled date has passed will be present in the compilation |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2559 for @emph{today}, until the entry is marked DONE. I.e., the task will |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2560 automatically be forwarded until completed. |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2561 |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2562 @example |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
2563 *** 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
|
2564 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
|
2565 @end example |
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2566 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2567 @item Time stamp with DEADLINE keyword |
63833 | 2568 @cindex DEADLINE keyword |
58792 | 2569 If a time stamp is preceded by the word @samp{DEADLINE:}, the task |
2570 (most likely a TODO item) is supposed to be finished on that date, and | |
63833 | 2571 it will be listed then. In addition, the compilation for @emph{today} |
2572 will carry a warning about the approaching or missed deadline, | |
2573 starting @code{org-deadline-warning-days} before the due date, and | |
2574 continuing until the entry is marked DONE. An example: | |
58792 | 2575 |
2576 @example | |
2577 *** TODO write article about the Earth for the Guide | |
63833 | 2578 The editor in charge is <bbdb:Ford Prefect> |
58792 | 2579 DEADLINE: <2004-02-29 Sun> |
2580 @end example | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2581 @item Time stamp with CLOSED keyword |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2582 @cindex CLOSED keyword |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2583 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
|
2584 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
|
2585 (@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
|
2586 brackets instead of angular brackets. |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2587 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2588 @item Time range with CLOCK keyword |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2589 @cindex CLOCK keyword |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2590 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
|
2591 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
|
2592 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
|
2593 brackets instead of angular brackets. @xref{Clocking work time}. |
58792 | 2594 @end table |
2595 | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2596 @node Creating timestamps, Custom time format, Time stamps, Timestamps |
58792 | 2597 @section Creating timestamps |
2598 @cindex creating timestamps | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2599 @cindex timestamps, creating |
58792 | 2600 |
2601 For Org-mode to recognize time stamps, they need to be in the specific | |
2602 format. All commands listed below produce time stamps in the correct | |
2603 format. | |
2604 | |
2605 @table @kbd | |
2606 @kindex C-c . | |
2607 @item C-c . | |
2608 Prompt for a date and insert a corresponding time stamp. When the | |
2609 cursor is at a previously used time stamp, it is updated to NOW. When | |
2610 this command is used twice in succession, a time range is inserted. | |
2611 | |
2612 @kindex C-u C-c . | |
2613 @item C-u C-c . | |
2614 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
|
2615 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
|
2616 see the option @code{org-time-stamp-rounding-minutes}. |
58792 | 2617 |
65656 | 2618 @kindex C-c ! |
2619 @item C-c ! | |
2620 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
|
2621 agenda. |
65656 | 2622 |
58792 | 2623 @kindex C-c < |
2624 @item C-c < | |
2625 Insert a time stamp corresponding to the cursor date in the Calendar. | |
2626 | |
2627 @kindex C-c > | |
2628 @item C-c > | |
2629 Access the Emacs calendar for the current date. If there is a | |
2630 timestamp in the current line, goto the corresponding date | |
2631 instead. | |
2632 | |
2633 @kindex C-c C-o | |
2634 @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
|
2635 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
|
2636 point (@pxref{Weekly/Daily agenda}). |
58792 | 2637 |
2638 @kindex C-c C-d | |
2639 @item C-c C-d | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2640 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
|
2641 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
|
2642 @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
|
2643 |
58792 | 2644 @kindex C-c C-w |
2645 @cindex sparse tree, for deadlines | |
2646 @item C-c C-w | |
2647 Create a sparse tree with all deadlines that are either past-due, or | |
2648 which will become due within @code{org-deadline-warning-days}. | |
2649 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric | |
2650 prefix, check that many days. For example, @kbd{C-1 C-c C-w} shows | |
2651 all deadlines due tomorrow. | |
2652 | |
2653 @kindex C-c C-s | |
2654 @item C-c C-s | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2655 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
|
2656 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
|
2657 timestamp will be removed. |
58792 | 2658 |
2659 @kindex S-@key{left} | |
2660 @kindex S-@key{right} | |
2661 @item S-@key{left} | |
2662 @itemx S-@key{right} | |
63362 | 2663 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
|
2664 CUA-mode (@pxref{Conflicts}). |
58792 | 2665 |
2666 @kindex S-@key{up} | |
2667 @kindex S-@key{down} | |
2668 @item S-@key{up} | |
2669 @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
|
2670 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
|
2671 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
|
2672 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
|
2673 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
|
2674 CUA-mode (@pxref{Conflicts}). |
63362 | 2675 |
58792 | 2676 |
2677 @kindex C-c C-y | |
2678 @cindex evaluate time range | |
2679 @item C-c C-y | |
2680 Evaluate a time range by computing the difference between start and | |
2681 end. With prefix arg, insert result after the time range (in a table: | |
2682 into the following column). | |
2683 @end table | |
2684 | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2685 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2686 @menu |
74030 | 2687 * 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
|
2688 @end menu |
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 @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
|
2691 @subsection The date/time prompt |
58792 | 2692 @cindex date, reading in minibuffer |
2693 @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
|
2694 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2695 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
|
2696 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
|
2697 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
|
2698 (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
|
2699 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
|
2700 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
|
2701 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2702 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2703 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
|
2704 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
|
2705 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
|
2706 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
|
2707 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
|
2708 12 --> currentyear-currentmonth-12 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2709 Fri --> nearest Friday (today or later) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2710 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2711 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2712 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
|
2713 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
|
2714 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
|
2715 |
58792 | 2716 @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
|
2717 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
|
2718 you don't need/want the calendar, configure the variable |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2719 @code{org-popup-calendar-for-date-prompt}.}. You can control the |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2720 calendar fully from the minibuffer: |
58792 | 2721 |
2722 @table @kbd | |
2723 @kindex < | |
2724 @item < | |
2725 Scroll calendar backwards by one month. | |
2726 @kindex > | |
2727 @item > | |
2728 Scroll calendar forwards by one month. | |
2729 @kindex mouse-1 | |
2730 @item mouse-1 | |
2731 Select date by clicking on it. | |
2732 @kindex S-@key{right} | |
2733 @item S-@key{right} | |
2734 One day forward. | |
2735 @kindex S-@key{left} | |
2736 @item S-@key{left} | |
2737 One day back. | |
2738 @kindex S-@key{down} | |
2739 @item S-@key{down} | |
2740 One week forward. | |
2741 @kindex S-@key{up} | |
2742 @item S-@key{up} | |
2743 One week back. | |
2744 @kindex M-S-@key{right} | |
2745 @item M-S-@key{right} | |
2746 One month forward. | |
2747 @kindex M-S-@key{left} | |
2748 @item M-S-@key{left} | |
2749 One month back. | |
2750 @kindex @key{RET} | |
2751 @item @key{RET} | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2752 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
|
2753 @end table |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2754 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2755 @node Custom time format, Progress logging, Creating timestamps, Timestamps |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2756 @section Custom time format |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2757 @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
|
2758 @cindex time format, custom |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2759 @cindex date format, custom |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2760 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2761 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
|
2762 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
|
2763 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
|
2764 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
|
2765 @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
|
2766 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2767 @table @kbd |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2768 @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
|
2769 @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
|
2770 Toggle the display of custom formats for dates and times. |
58792 | 2771 @end table |
2772 | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2773 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2774 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
|
2775 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
|
2776 @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
|
2777 following consequences: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2778 @itemize @bullet |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2779 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2780 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
|
2781 after. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2782 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2783 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
|
2784 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
|
2785 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
|
2786 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
|
2787 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
|
2788 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2789 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
|
2790 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
|
2791 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
|
2792 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2793 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
|
2794 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
|
2795 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
|
2796 @end itemize |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2797 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2798 @node Progress logging, , Custom time format, Timestamps |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2799 @section Progress Logging |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2800 @cindex progress logging |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2801 @cindex logging, of progress |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2802 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2803 Org-mode can automatically record a time stamp when you mark a TODO item |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2804 as DONE. You can also measure precisely the time you spent on specific |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2805 items in a project by starting and stopping a clock when you start and |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2806 stop working on an aspect of a project. |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2807 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2808 @menu |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
2809 * Closing items:: When was this entry marked DONE? |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2810 * 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
|
2811 @end menu |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2812 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2813 @node Closing items, Clocking work time, Progress logging, Progress logging |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2814 @subsection Closing items |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2815 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2816 If you want to keep track of @emph{when} a certain TODO item was |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2817 finished, turn on logging with |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2818 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2819 @lisp |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2820 (setq org-log-done t) |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2821 @end lisp |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2822 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2823 @noindent |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2824 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
|
2825 C-t} in the Org-mode buffer or @kbd{t} in the agenda buffer, a line |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2826 @samp{CLOSED: [timestamp]} will be inserted just after the headline. |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2827 If you turn the entry back into a TODO item again through further |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2828 state cycling, that line will be removed again. In the timeline |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2829 (@pxref{Timeline}) and in the agenda (@pxref{Weekly/Daily agenda}), |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2830 you can then use the @kbd{l} key to display the TODO items closed on |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2831 each day, giving you an overview of what has been done on a day. |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2832 See the variable @code{org-log-done} for the possibility to record an |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2833 additional note together with a timestamp. |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2834 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2835 @node Clocking work time, , Closing items, Progress logging |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2836 @subsection Clocking work time |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2837 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2838 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
|
2839 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
|
2840 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
|
2841 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
|
2842 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
|
2843 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2844 @table @kbd |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2845 @kindex C-c C-x C-i |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2846 @item C-c C-x C-i |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2847 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
|
2848 keyword together with a timestamp. |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2849 @kindex C-c C-x C-o |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2850 @item C-c C-x C-o |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2851 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
|
2852 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
|
2853 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
|
2854 HH:MM}. See the variable @code{org-log-done} for the possibility to |
74030 | 2855 record an additional note together with the clock-out time stamp. |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
2856 @kindex C-c C-y |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
2857 @item C-c C-y |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
2858 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
|
2859 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
|
2860 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
|
2861 @kindex C-c C-t |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2862 @item C-c C-t |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2863 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
|
2864 if it is running in this same item. |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2865 @kindex C-c C-x C-x |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2866 @item C-c C-x C-x |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2867 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
|
2868 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
|
2869 @kindex C-c C-x C-d |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2870 @item C-c C-x C-d |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2871 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
|
2872 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
|
2873 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
|
2874 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
|
2875 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
|
2876 @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
|
2877 @kindex C-c C-x C-r |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
2878 @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
|
2879 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
|
2880 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
|
2881 @example |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
2882 #+BEGIN: clocktable :maxlevel 2 :emphasize nil |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
2883 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
2884 #+END: clocktable |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
2885 @end example |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
2886 @noindent |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
2887 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
|
2888 table. The @samp{BEGIN} line can specify options: |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
2889 @example |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
2890 :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
|
2891 :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
|
2892 :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
|
2893 @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
|
2894 @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
|
2895 @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
|
2896 :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
|
2897 :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
|
2898 @end example |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
2899 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
|
2900 @example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
2901 #+BEGIN: clocktable :maxlevel 2 :block today |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
2902 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
2903 #+END: clocktable |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
2904 @end example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
2905 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
|
2906 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
|
2907 only to fit it onto the manual.} |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
2908 @example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
2909 #+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
|
2910 :tend "<2006-08-10 Thu 12:00>" |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
2911 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
2912 #+END: clocktable |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
2913 @end example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
2914 @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
|
2915 @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
|
2916 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
|
2917 you have several clocktable blocks in a buffer. |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2918 @end table |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2919 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2920 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
|
2921 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
|
2922 worked on or closed during a day. |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2923 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2924 @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
|
2925 @chapter Tags |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2926 @cindex tags |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2927 @cindex headline tagging |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2928 @cindex matching, tags |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2929 @cindex sparse tree, tag based |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2930 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2931 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
|
2932 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
|
2933 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
|
2934 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2935 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
|
2936 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
|
2937 @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
|
2938 @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
|
2939 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2940 @menu |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2941 * 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
|
2942 * 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
|
2943 * 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
|
2944 @end menu |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2945 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2946 @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
|
2947 @section Tag inheritance |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2948 @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
|
2949 @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
|
2950 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2951 @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
|
2952 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
|
2953 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
|
2954 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2955 @example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2956 * 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
|
2957 ** Summary by Frank :BOSS:NOTES: |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2958 *** 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
|
2959 @end example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2960 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2961 @noindent |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2962 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
|
2963 @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
|
2964 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
|
2965 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
|
2966 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
|
2967 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
|
2968 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
|
2969 @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
|
2970 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2971 @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
|
2972 @section Setting tags |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2973 @cindex setting tags |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2974 @cindex tags, setting |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2975 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2976 @kindex M-@key{TAB} |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2977 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
|
2978 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
|
2979 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
|
2980 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2981 @table @kbd |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2982 @kindex C-c C-c |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2983 @item C-c C-c |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2984 @cindex completion, of tags |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2985 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
|
2986 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
|
2987 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
|
2988 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
|
2989 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
|
2990 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
|
2991 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
|
2992 @end table |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2993 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2994 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
|
2995 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
|
2996 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
|
2997 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
|
2998 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
|
2999 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3000 @example |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3001 #+TAGS: @@WORK @@HOME @@TENNISCLUB |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3002 #+TAGS: Laptop Car PC Sailboat |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3003 @end example |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3004 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3005 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
|
3006 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
|
3007 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
|
3008 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3009 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3010 #+TAGS: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3011 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3012 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3013 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
|
3014 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
|
3015 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
|
3016 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
|
3017 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
|
3018 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3019 @lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3020 (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
|
3021 @end lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3022 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3023 @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
|
3024 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3025 @example |
71246
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3026 #+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
|
3027 @end example |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3028 |
71246
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3029 @noindent |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3030 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
|
3031 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
|
3032 @code{'(:startgroup)} and @code{'(:endgroup)}, respectively. Several |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3033 groups are allowed.} |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3034 |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3035 @example |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3036 #+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
|
3037 @end example |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3038 |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3039 @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
|
3040 and @samp{@@TENNISCLUB} should be selected. |
71246
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3041 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3042 @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
|
3043 these lines to activate any changes. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3044 |
71246
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
3045 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
|
3046 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
|
3047 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
|
3048 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
|
3049 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
|
3050 the following keys: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3051 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3052 @table @kbd |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3053 @item a-z... |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3054 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
|
3055 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
|
3056 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
|
3057 @kindex @key{TAB} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3058 @item @key{TAB} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3059 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
|
3060 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
|
3061 @kindex @key{SPC} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3062 @item @key{SPC} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3063 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
|
3064 @kindex @key{RET} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3065 @item @key{RET} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3066 Accept the modified set. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3067 @item C-g |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3068 Abort without installing changes. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3069 @item q |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3070 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
|
3071 @item ! |
74030 | 3072 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
|
3073 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
|
3074 @item C-c |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3075 Toggle auto-exit after the next change (see below). |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3076 @end table |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3077 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3078 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3079 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
|
3080 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
|
3081 @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
|
3082 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
|
3083 @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
|
3084 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
|
3085 @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
|
3086 @key{RET} @key{RET}}. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3087 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3088 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
|
3089 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
|
3090 @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
|
3091 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
|
3092 after the first change. If you then occasionally need more keys, press |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3093 @kbd{C-c} to turn off auto-exit for the current tag selection process. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3094 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3095 @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
|
3096 @section Tag searches |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3097 @cindex tag searches |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3098 @cindex searching for tags |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3099 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3100 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
|
3101 information into special lists. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3102 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3103 @table @kbd |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3104 @kindex C-c \ |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3105 @item C-c \ |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3106 Create a sparse tree with all headlines matching a tags search. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3107 @kindex C-c a m |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3108 @item C-c a m |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3109 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
|
3110 @xref{Matching headline tags}. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3111 @kindex C-c a M |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3112 @item C-c a M |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3113 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
|
3114 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
|
3115 @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
|
3116 @end table |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3117 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3118 @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
|
3119 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
|
3120 @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
|
3121 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
|
3122 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
|
3123 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
|
3124 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
|
3125 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3126 @table @samp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3127 @item +WORK-BOSS |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3128 Select all headlines that are tagged @samp{:WORK:}, but discard those also tagged |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3129 @samp{:BOSS:}. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3130 @item WORK|LAPTOP |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3131 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
|
3132 @item WORK|LAPTOP&NIGHT |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3133 Like the previous example, but require the @samp{:LAPTOP:} lines to be |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3134 tagged also @samp{NIGHT}. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3135 @end table |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3136 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3137 @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
|
3138 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
|
3139 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
|
3140 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
|
3141 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
|
3142 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
|
3143 meaningfully be combined with boolean AND. However, @emph{negative |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3144 selection} combined with AND can be meaningful. Examples: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3145 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3146 @table @samp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3147 @item WORK/WAITING |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3148 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
|
3149 keyword @samp{WAITING}. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3150 @item WORK/-WAITING-NEXT |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3151 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
|
3152 nor @samp{NEXT} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3153 @item WORK/+WAITING|+NEXT |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3154 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
|
3155 @samp{NEXT}. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3156 @end table |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3157 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
3158 @node Agenda views, Embedded LaTeX, Tags, Top |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3159 @chapter Agenda Views |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3160 @cindex agenda views |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3161 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3162 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
|
3163 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
|
3164 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
|
3165 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
|
3166 sorted and displayed in an organized way. |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3167 |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3168 Org-mode can select items based on various criteria, and display them |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3169 in a separate buffer. Five 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
|
3170 |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3171 @itemize @bullet |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3172 @item |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3173 an @emph{agenda} that is like a calendar and shows information |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3174 for specific dates |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3175 @item |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3176 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
|
3177 action items, |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3178 @item |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3179 a @emph{tags view} that shows information based on |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3180 the tags associated with headlines in the outline tree, |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3181 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3182 a @emph{timeline view} that shows all events in a single Org-mode file, |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3183 in time-sorted view |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3184 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3185 @emph{custom views} that are special tag and keyword searches and |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3186 combinations of different views. |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3187 @end itemize |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3188 |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3189 @noindent |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3190 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
|
3191 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
|
3192 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
|
3193 edit these files remotely. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3194 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3195 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
|
3196 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
|
3197 @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
|
3198 @code{org-agenda-restore-windows-after-quit}. |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3199 |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3200 @menu |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3201 * Agenda files:: Files being searched for agenda information |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3202 * Agenda dispatcher:: Keyboard access to agenda views |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
3203 * Weekly/Daily agenda:: The calendar page with current tasks |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3204 * Global TODO list:: All unfinished action items |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3205 * Matching headline tags:: Structured information with fine-tuned search |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3206 * Timeline:: Time-sorted view for single file |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3207 * 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
|
3208 * 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
|
3209 * Custom agenda views:: Defining special searches and views |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3210 @end menu |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3211 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
3212 @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
|
3213 @section Agenda files |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3214 @cindex agenda files |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3215 @cindex files for agenda |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3216 |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3217 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
|
3218 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
|
3219 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
|
3220 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
|
3221 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
|
3222 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
|
3223 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
|
3224 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
|
3225 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
|
3226 the easiest way to maintain it is through the following commands |
58792 | 3227 |
3228 @cindex files, adding to agenda list | |
3229 @table @kbd | |
3230 @kindex C-c [ | |
3231 @item C-c [ | |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
3232 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
|
3233 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
|
3234 the front. With prefix arg, file is added/moved to the end. |
58792 | 3235 @kindex C-c ] |
3236 @item C-c ] | |
3237 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
|
3238 @kindex C-, |
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
3239 @item C-, |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3240 Cycle through agenda file list, visiting one file after the other. |
58792 | 3241 @end table |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3242 |
58792 | 3243 @noindent |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3244 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
|
3245 to visit any of them. |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3246 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
3247 @node Agenda dispatcher, Weekly/Daily agenda, Agenda files, Agenda views |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3248 @section The agenda dispatcher |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3249 @cindex agenda dispatcher |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3250 @cindex dispatching agenda commands |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3251 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
|
3252 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
|
3253 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
|
3254 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
|
3255 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
|
3256 command. The dispatcher offers the following default commands: |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3257 @table @kbd |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3258 @item a |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
3259 Create the calendar-like agenda (@pxref{Weekly/Daily agenda}). |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3260 @item t / T |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3261 Create a list of all TODO items (@pxref{Global TODO list}). |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3262 @item m / M |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3263 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
|
3264 headline tags}). |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3265 @item L |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3266 Create the timeline view for the current buffer (@pxref{Timeline}). |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3267 @item 1 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3268 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
|
3269 @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
|
3270 @item 0 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3271 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
|
3272 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
|
3273 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
|
3274 command. |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3275 @end table |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3276 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3277 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
|
3278 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
|
3279 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
|
3280 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
|
3281 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
|
3282 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
3283 @node Weekly/Daily agenda, Global TODO list, Agenda dispatcher, Agenda views |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3284 @section The weekly/daily agenda |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3285 @cindex agenda |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3286 @cindex weekly agenda |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3287 @cindex daily agenda |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3288 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3289 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
|
3290 paper agenda, showing all the tasks for the current week or day. |
58792 | 3291 |
3292 @table @kbd | |
3293 @cindex org-agenda, command | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3294 @kindex C-c a a |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3295 @item C-c a a |
58792 | 3296 Compile an agenda for the current week from a list of org files. The |
3297 agenda shows the entries for each day. With a @kbd{C-u} prefix (or | |
3298 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
|
3299 unfinished TODO items (including those without a date) are also listed at |
58792 | 3300 the beginning of the buffer, before the first date.@* |
3301 @end table | |
3302 | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3303 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
|
3304 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
|
3305 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
|
3306 commands}. |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3307 |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3308 @menu |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3309 * Calendar/Diary integration:: Integrating Anniversaries and more |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3310 @end menu |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3311 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3312 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3313 @node Calendar/Diary integration, , Weekly/Daily agenda, Weekly/Daily agenda |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3314 @subsection Calendar/Diary integration |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3315 @cindex calendar integration |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3316 @cindex diary integration |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3317 |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3318 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
|
3319 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
|
3320 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
|
3321 anniversaries, lunar phases, sunrise/set, recurrent appointments |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3322 (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
|
3323 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
|
3324 the diary. |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3325 |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3326 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
|
3327 agenda, you only need to customize the variable |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3328 |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3329 @lisp |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3330 (setq org-agenda-include-diary t) |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3331 @end lisp |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3332 |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3333 @noindent After that, everything will happen automatically. All diary |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3334 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
|
3335 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
|
3336 @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
|
3337 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
|
3338 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
|
3339 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
|
3340 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
|
3341 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
|
3342 between calendar and agenda. |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3343 |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3344 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
3345 @node Global TODO list, Matching headline tags, Weekly/Daily agenda, Agenda views |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3346 @section The global TODO list |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3347 @cindex global TODO list |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3348 @cindex TODO list, global |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3349 |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3350 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
|
3351 collected into a single place. |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3352 |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3353 @table @kbd |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3354 @kindex C-c a t |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3355 @item C-c a t |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3356 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
|
3357 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
|
3358 @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
|
3359 the TODO entries directly from that buffer (@pxref{Agenda commands}). |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3360 @kindex C-c a T |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3361 @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
|
3362 @cindex TODO keyword matching |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3363 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
|
3364 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
|
3365 @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
|
3366 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
|
3367 @kindex r |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3368 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
|
3369 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
|
3370 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
|
3371 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
|
3372 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
|
3373 search (@pxref{Tag searches}). |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3374 @end table |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3375 |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
3376 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
|
3377 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
|
3378 TODO list are described in @ref{Agenda commands}. |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3379 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3380 @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
|
3381 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
|
3382 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
|
3383 it more compact: |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
3384 @itemize @minus |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
3385 @item |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
3386 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
|
3387 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
|
3388 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
|
3389 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
|
3390 @item |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
3391 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
|
3392 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
|
3393 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
|
3394 @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
|
3395 @end itemize |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
3396 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
3397 @node Matching headline tags, Timeline, Global TODO list, Agenda views |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3398 @section Matching headline tags |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3399 @cindex matching, of tags |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3400 @cindex tags view |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3401 |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3402 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
|
3403 (@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
|
3404 to them and collect them into an agenda buffer. |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3405 |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3406 @table @kbd |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3407 @kindex C-c a m |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3408 @item C-c a m |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3409 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
|
3410 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
|
3411 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
|
3412 @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
|
3413 define a custom command for it (@pxref{Agenda dispatcher}). |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3414 @kindex C-c a M |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3415 @item C-c a M |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3416 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
|
3417 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
|
3418 @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
|
3419 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
|
3420 @end table |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3421 |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3422 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
|
3423 commands}. |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3424 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3425 @node Timeline, Presentation and sorting, Matching headline tags, Agenda views |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3426 @section Timeline for a single file |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3427 @cindex timeline, single file |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3428 @cindex time-sorted view |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3429 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3430 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
|
3431 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
|
3432 to give an overview over events in a project. |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3433 |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3434 @table @kbd |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3435 @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
|
3436 @item C-c a L |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3437 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
|
3438 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
|
3439 (scheduled or not) are also listed under the current date. |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3440 @end table |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3441 |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3442 @noindent |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3443 The commands available in the timeline buffer are listed in |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3444 @ref{Agenda commands}. |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3445 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3446 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3447 @node Presentation and sorting, Agenda commands, Timeline, Agenda views |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3448 @section Presentation and sorting |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3449 @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
|
3450 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3451 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
|
3452 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
|
3453 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
|
3454 (@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
|
3455 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
|
3456 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
|
3457 associated with the item. |
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 @menu |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3460 * 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
|
3461 * 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
|
3462 * 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
|
3463 @end menu |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3464 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3465 @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
|
3466 @subsection Categories |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3467 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3468 @cindex category |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3469 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
|
3470 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
|
3471 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
|
3472 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3473 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3474 #+CATEGORY: Thesis |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3475 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3476 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3477 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
|
3478 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
|
3479 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
|
3480 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
|
3481 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3482 @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
|
3483 @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
|
3484 @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
|
3485 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3486 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
|
3487 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
|
3488 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
|
3489 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
|
3490 @c |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3491 @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
|
3492 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3493 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
|
3494 plain text (like @samp{12:45} or a @samp{8:30-1pm}. If the agenda |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3495 integrates the Emacs diary (@pxref{Calendar/Diary integration}), time |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3496 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
|
3497 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3498 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
|
3499 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
|
3500 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
|
3501 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3502 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3503 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
|
3504 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
|
3505 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
|
3506 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
|
3507 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3508 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3509 @cindex time grid |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3510 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
|
3511 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
|
3512 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3513 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3514 8:00...... ------------------ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3515 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
|
3516 10:00...... ------------------ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3517 12:00...... ------------------ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3518 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
|
3519 14:00...... ------------------ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3520 16:00...... ------------------ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3521 18:00...... ------------------ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3522 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
|
3523 20:00...... ------------------ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3524 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
|
3525 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3526 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3527 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
|
3528 @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
|
3529 @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
|
3530 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3531 @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
|
3532 @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
|
3533 @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
|
3534 @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
|
3535 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
|
3536 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
|
3537 @itemize @bullet |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3538 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3539 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
|
3540 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
|
3541 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
|
3542 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
|
3543 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
|
3544 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
|
3545 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
|
3546 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
|
3547 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
|
3548 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3549 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
|
3550 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
|
3551 (@pxref{Priorities}). |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3552 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3553 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
|
3554 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
|
3555 @end itemize |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3556 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3557 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
|
3558 @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
|
3559 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3560 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3561 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda views |
58792 | 3562 @section Commands in the agenda buffer |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3563 @cindex commands, in agenda buffer |
58792 | 3564 |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
3565 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
|
3566 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
|
3567 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
|
3568 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
|
3569 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
|
3570 removing the risk that your agenda and note files may diverge. |
58792 | 3571 |
3572 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
|
3573 the other commands, the cursor needs to be in the desired line. |
58792 | 3574 |
3575 @table @kbd | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
3576 @tsubheading{Motion} |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3577 @cindex motion commands in agenda |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
3578 @kindex n |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
3579 @item n |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
3580 Next line (same as @key{up}). |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
3581 @kindex p |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
3582 @item p |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
3583 Previous line (same as @key{down}). |
58792 | 3584 @tsubheading{View/GoTo org file} |
3585 @kindex mouse-3 | |
3586 @kindex @key{SPC} | |
3587 @item mouse-3 | |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
3588 @itemx @key{SPC} |
58792 | 3589 Display the original location of the item in another window. |
3590 | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3591 @kindex L |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3592 @item L |
58792 | 3593 Display original location and recenter that window. |
3594 | |
3595 @kindex mouse-2 | |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
3596 @kindex mouse-1 |
58792 | 3597 @kindex @key{TAB} |
3598 @item mouse-2 | |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
3599 @itemx mouse-1 |
58792 | 3600 @itemx @key{TAB} |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
3601 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
|
3602 22, @kbd{mouse-1} will also works for this. |
58792 | 3603 |
3604 @kindex @key{RET} | |
3605 @itemx @key{RET} | |
3606 Go to the original location of the item and delete other windows. | |
3607 | |
3608 @kindex f | |
3609 @item f | |
67537
f0c77dab544c
(Progress Logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
67382
diff
changeset
|
3610 Toggle Follow mode. In Follow mode, as you move the cursor through |
58792 | 3611 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
|
3612 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
|
3613 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
|
3614 @code{org-agenda-start-with-follow-mode}. |
58792 | 3615 |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3616 @kindex l |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3617 @item l |
67537
f0c77dab544c
(Progress Logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
67382
diff
changeset
|
3618 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
|
3619 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
|
3620 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
|
3621 |
58792 | 3622 @tsubheading{Change display} |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3623 @cindex display changing, in agenda |
58792 | 3624 @kindex o |
3625 @item o | |
3626 Delete other windows. | |
3627 | |
3628 @kindex w | |
3629 @item w | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3630 Switch to weekly view (7 days displayed together). |
58792 | 3631 |
3632 @kindex d | |
3633 @item d | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3634 Switch to daily view (just one day displayed). |
63833 | 3635 |
3636 @kindex D | |
3637 @item D | |
58792 | 3638 Toggle the inclusion of diary entries. See @ref{Calendar/Diary integration}. |
3639 | |
62548 | 3640 @kindex g |
3641 @item g | |
3642 Toggle the time grid on and off. See also the variables | |
3643 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}. | |
3644 | |
58792 | 3645 @kindex r |
3646 @item r | |
3647 Recreate the agenda buffer, for example to reflect the changes | |
3648 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
|
3649 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
|
3650 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
|
3651 keyword. |
58792 | 3652 |
71564
947e64a6bc0e
(Agenda commands): Document `s' key to save all
Carsten Dominik <dominik@science.uva.nl>
parents:
71525
diff
changeset
|
3653 @kindex s |
947e64a6bc0e
(Agenda commands): Document `s' key to save all
Carsten Dominik <dominik@science.uva.nl>
parents:
71525
diff
changeset
|
3654 @item s |
947e64a6bc0e
(Agenda commands): Document `s' key to save all
Carsten Dominik <dominik@science.uva.nl>
parents:
71525
diff
changeset
|
3655 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
|
3656 |
58792 | 3657 @kindex @key{right} |
3658 @item @key{right} | |
3659 Display the following @code{org-agenda-ndays} days. For example, if | |
3660 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
|
3661 arg, go forward that many times @code{org-agenda-ndays} days. |
58792 | 3662 |
3663 @kindex @key{left} | |
3664 @item @key{left} | |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
3665 Display the previous dates. |
58792 | 3666 |
3667 @kindex . | |
3668 @item . | |
3669 Goto today. | |
3670 | |
3671 @tsubheading{Remote editing} | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3672 @cindex remote editing, from agenda |
58792 | 3673 |
3674 @item 0-9 | |
3675 Digit argument. | |
3676 | |
3677 @kindex t | |
3678 @item t | |
3679 Change the TODO state of the item, both in the agenda and in the | |
3680 original org file. | |
3681 | |
74030 | 3682 @kindex C-k |
3683 @item C-k | |
3684 Delete the current agenda item along with the entire subtree belonging | |
3685 to it in the original Org-mode file. If the text to be deleted remotely | |
3686 is longer than one line, the kill needs to be confirmed by the user. See | |
3687 variable @code{org-agenda-confirm-kill}. | |
3688 | |
68173
73b14864a9b7
(Agenda commands): Document tags command.
Carsten Dominik <dominik@science.uva.nl>
parents:
68060
diff
changeset
|
3689 @kindex T |
73b14864a9b7
(Agenda commands): Document tags command.
Carsten Dominik <dominik@science.uva.nl>
parents:
68060
diff
changeset
|
3690 @item T |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3691 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
|
3692 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
|
3693 |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
3694 @kindex : |
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
3695 @item : |
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
3696 Set tags for the current headline. |
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
3697 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
3698 @kindex a |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
3699 @item a |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
3700 Toggle the ARCHIVE tag for the current headline. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
3701 |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
3702 @kindex , |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
3703 @item , |
58792 | 3704 Set the priority for the current item. Org-mode prompts for the |
3705 priority character. If you reply with @key{SPC}, the priority cookie | |
3706 is removed from the entry. | |
3707 | |
3708 @kindex P | |
3709 @item p | |
3710 Display weighted priority of current item. | |
3711 | |
3712 @kindex + | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
3713 @kindex S-@key{up} |
58792 | 3714 @item + |
63833 | 3715 @itemx S-@key{up} |
58792 | 3716 Increase the priority of the current item. The priority is changed in |
3717 the original buffer, but the agenda is not resorted. Use the @kbd{r} | |
3718 key for this. | |
3719 | |
3720 @kindex - | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
3721 @kindex S-@key{down} |
58792 | 3722 @item - |
63833 | 3723 @itemx S-@key{down} |
58792 | 3724 Decrease the priority of the current item. |
3725 | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3726 @kindex C-c C-s |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3727 @item C-c C-s |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3728 Schedule this item |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3729 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3730 @kindex C-c C-d |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3731 @item C-c C-d |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3732 Set a deadline for this item. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3733 |
58792 | 3734 @kindex S-@key{right} |
3735 @item S-@key{right} | |
3736 Change the time stamp associated with the current line by one day into | |
3737 the future. With prefix argument, change it by that many days. For | |
3738 example, @kbd{3 6 5 S-@key{right}} will change it by a year. The | |
3739 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
|
3740 directly reflected in the agenda buffer. Use the |
58792 | 3741 @kbd{r} key to update the buffer. |
3742 | |
3743 @kindex S-@key{left} | |
3744 @item S-@key{left} | |
3745 Change the time stamp associated with the current line by one day | |
3746 into the past. | |
3747 | |
3748 @kindex > | |
3749 @item > | |
3750 Change the time stamp associated with the current line to today. | |
3751 The key @kbd{>} has been chosen, because it is the same as @kbd{S-.} | |
3752 on my keyboard. | |
3753 | |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3754 @kindex I |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3755 @item I |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3756 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
|
3757 is stopped first. |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3758 @kindex O |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3759 @item O |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3760 Stop the previously started clock. |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3761 @kindex X |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3762 @item X |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3763 Cancel the currently running clock. |
58792 | 3764 |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
3765 @tsubheading{Calendar commands} |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3766 @cindex calendar commands, from agenda |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
3767 @kindex c |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
3768 @item c |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
3769 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
|
3770 |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
3771 @item c |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
3772 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
|
3773 date at the cursor. |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
3774 |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3775 @cindex diary entries, creating from agenda |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3776 @kindex i |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3777 @item i |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3778 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
|
3779 (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
|
3780 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
|
3781 The date is taken from the cursor position. |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3782 |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
3783 @kindex M |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
3784 @item M |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3785 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
|
3786 |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
3787 @kindex S |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
3788 @item S |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
3789 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
|
3790 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
|
3791 |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
3792 @kindex C |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
3793 @item C |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
3794 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
|
3795 calendars. |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
3796 |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
3797 @kindex H |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
3798 @item H |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
3799 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
|
3800 |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
3801 @c FIXME: This should be a different key. |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
3802 @kindex C-c C-x C-c |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
3803 @item C-c C-x C-c |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
3804 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
|
3805 |
58792 | 3806 @tsubheading{Quit and Exit} |
3807 @kindex q | |
3808 @item q | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
3809 Quit agenda, remove the agenda buffer. |
58792 | 3810 |
3811 @kindex x | |
3812 @cindex agenda files, removing buffers | |
3813 @item x | |
3814 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs | |
3815 for the compilation of the agenda. Buffers created by the user to | |
3816 visit org files will not be removed. | |
3817 | |
3818 @end table | |
3819 | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3820 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3821 @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
|
3822 @section Custom agenda views |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3823 @cindex custom agenda views |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3824 @cindex agenda views, custom |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3825 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3826 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
|
3827 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
|
3828 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
|
3829 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
|
3830 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3831 @menu |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3832 * 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
|
3833 * 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
|
3834 * 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
|
3835 * 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
|
3836 @end menu |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3837 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3838 @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
|
3839 @subsection Storing searches |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3840 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3841 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
|
3842 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
|
3843 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
|
3844 buffer). |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3845 @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
|
3846 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
|
3847 @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
|
3848 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
|
3849 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
|
3850 search types: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3851 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3852 @lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3853 @group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3854 (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
|
3855 '(("w" todo "WAITING") |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3856 ("W" todo-tree "WAITING") |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3857 ("u" tags "+BOSS-URGENT") |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3858 ("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
|
3859 ("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
|
3860 ("f" occur-tree "\\<FIXME\\>"))) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3861 @end group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3862 @end lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3863 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3864 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3865 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
|
3866 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
|
3867 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
|
3868 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
|
3869 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
|
3870 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3871 @table @kbd |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3872 @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
|
3873 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
|
3874 keyword |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3875 @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
|
3876 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
|
3877 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
|
3878 @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
|
3879 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
|
3880 @samp{:URGENT:} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3881 @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
|
3882 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
|
3883 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
|
3884 @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
|
3885 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
|
3886 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
|
3887 @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
|
3888 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
|
3889 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
|
3890 @end table |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3891 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3892 @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
|
3893 @subsection Block agenda |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3894 @cindex block agenda |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3895 @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
|
3896 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3897 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
|
3898 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
|
3899 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
|
3900 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
|
3901 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
|
3902 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
|
3903 @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
|
3904 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3905 @lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3906 @group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3907 (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
|
3908 '(("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
|
3909 ((agenda) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3910 (tags-todo "HOME") |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3911 (tags "GARDEN"))) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3912 ("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
|
3913 ((agenda) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3914 (tags-todo "WORK") |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3915 (tags "OFFICE"))))) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3916 @end group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3917 @end lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3918 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3919 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3920 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
|
3921 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
|
3922 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
|
3923 @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
|
3924 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
|
3925 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3926 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3927 @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
|
3928 @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
|
3929 @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
|
3930 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3931 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
|
3932 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
|
3933 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
|
3934 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
|
3935 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
|
3936 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
|
3937 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3938 @lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3939 @group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3940 (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
|
3941 '(("w" todo "WAITING" |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3942 ((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
|
3943 (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
|
3944 ("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
|
3945 ((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
|
3946 (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
|
3947 @end group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3948 @end lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3949 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3950 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3951 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
|
3952 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
|
3953 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
|
3954 @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
|
3955 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
|
3956 will be shown. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3957 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3958 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
|
3959 @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
|
3960 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
|
3961 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
|
3962 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
|
3963 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
|
3964 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
|
3965 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
|
3966 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
|
3967 @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
|
3968 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3969 @lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3970 @group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3971 (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
|
3972 '(("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
|
3973 ((agenda) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3974 (tags-todo "HOME") |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3975 (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
|
3976 ((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
|
3977 ("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
|
3978 ((agenda) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3979 (tags-todo "WORK") |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3980 (tags "OFFICE"))))) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3981 @end group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3982 @end lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3983 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3984 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
|
3985 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
|
3986 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
|
3987 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
|
3988 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
|
3989 yourself. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3990 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3991 @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
|
3992 @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
|
3993 @cindex agenda, batch production |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3994 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3995 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
|
3996 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
|
3997 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
|
3998 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
|
3999 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
|
4000 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4001 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4002 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
|
4003 @end example |
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 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4006 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
|
4007 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4008 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4009 emacs -batch -l ~/.emacs \ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4010 -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
|
4011 org-agenda-ndays 300 \ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4012 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
|
4013 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
|
4014 | lpr |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4015 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4016 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4017 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4018 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
|
4019 @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
|
4020 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4021 @node Embedded LaTeX, Exporting, Agenda views, Top |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4022 @chapter Embedded LaTeX |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4023 @cindex @TeX{} interpretation |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4024 @cindex La@TeX{} interpretation |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4025 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4026 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
|
4027 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
|
4028 contain mathematical symbols and the occasional formula. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4029 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
|
4030 @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
|
4031 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
|
4032 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
|
4033 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
|
4034 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
|
4035 into images for HTML production. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4036 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4037 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
|
4038 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
|
4039 to do with it. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4040 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4041 @menu |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4042 * Math symbols:: TeX macros for symbols and Greek letters |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4043 * Subscripts and Superscripts:: Simple syntax for raising/lowering text |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4044 * LaTeX fragments:: Complex formulas made easy |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4045 * Processing LaTeX fragments:: Previewing LaTeX processing |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4046 * CDLaTeX mode:: Speed up entering of formulas |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4047 @end menu |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4048 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4049 @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
|
4050 @section Math symbols |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4051 @cindex math symbols |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4052 @cindex TeX macros |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4053 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4054 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
|
4055 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
|
4056 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
|
4057 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
|
4058 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
|
4059 without surrounding math delimiters, for example: |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4060 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4061 @example |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4062 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
|
4063 @end example |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4064 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4065 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
|
4066 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
|
4067 @samp{α} and @samp{→}, respectively. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4068 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4069 @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
|
4070 @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
|
4071 @cindex subscript |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4072 @cindex superscript |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4073 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4074 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
|
4075 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
|
4076 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
|
4077 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
|
4078 with curly braces. For example |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4079 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4080 @example |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
4081 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
|
4082 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
|
4083 @end example |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4084 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4085 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
|
4086 @samp{^} and @samp{_} with a backslash: @samp{\_} and @samp{\^}. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4087 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4088 During HTML export (@pxref{HTML export}), subscript and superscripts |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4089 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
|
4090 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4091 @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
|
4092 @section LaTeX fragments |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4093 @cindex LaTeX fragments |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4094 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4095 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
|
4096 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
|
4097 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
|
4098 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
|
4099 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
|
4100 images seems the way to go.}. More complex |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4101 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
|
4102 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
|
4103 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
|
4104 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
|
4105 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
|
4106 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
|
4107 available at @url{http://sourceforge.net/projects/dvipng/}. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4108 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4109 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
|
4110 snippets will be identified as LaTeX source code: |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4111 @itemize @bullet |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4112 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4113 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
|
4114 @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
|
4115 whitespace. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4116 @item |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
4117 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
|
4118 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
|
4119 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
|
4120 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
|
4121 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
|
4122 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
|
4123 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
|
4124 @end itemize |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4125 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4126 @noindent For example: |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4127 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4128 @example |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4129 \begin@{equation@} % arbitrary environments, |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4130 x=\sqrt@{b@} % even tables, figures |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4131 \end@{equation@} % etc |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4132 |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
4133 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
|
4134 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \]. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4135 @end example |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4136 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4137 @noindent |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4138 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
|
4139 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
|
4140 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
|
4141 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4142 @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
|
4143 @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
|
4144 @cindex LaTeX fragments, preview |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4145 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4146 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
|
4147 typeset expressions: |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4148 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4149 @table @kbd |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4150 @kindex C-c C-x C-l |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4151 @item C-c C-x C-l |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4152 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
|
4153 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
|
4154 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
|
4155 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
|
4156 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
|
4157 process the entire buffer. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4158 @kindex C-c C-c |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4159 @item C-c C-c |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4160 Remove the overlay preview images. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4161 @end table |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4162 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4163 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
|
4164 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
|
4165 setting is active: |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4166 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4167 @lisp |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4168 (setq org-export-with-LaTeX-fragments t) |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4169 @end lisp |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4170 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4171 @node CDLaTeX mode, , Processing LaTeX fragments, Embedded LaTeX |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4172 @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
|
4173 @cindex CDLaTeX |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4174 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4175 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
|
4176 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
|
4177 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
|
4178 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
|
4179 @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
|
4180 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
|
4181 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
|
4182 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
|
4183 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
|
4184 Org-mode files with |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4185 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4186 @lisp |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4187 (add-hook 'org-mode-hook 'turn-on-org-cdlatex) |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4188 @end lisp |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4189 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4190 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
|
4191 details see the documentation of cdlatex-mode): |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4192 @itemize @bullet |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4193 @kindex C-c @{ |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4194 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4195 Environment templates can be inserted with @kbd{C-c @{}. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4196 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4197 @kindex @key{TAB} |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4198 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
|
4199 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
|
4200 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
|
4201 @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
|
4202 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
|
4203 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
|
4204 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
|
4205 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
|
4206 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
|
4207 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
|
4208 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
|
4209 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4210 @kindex _ |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4211 @kindex ^ |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4212 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
|
4213 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
|
4214 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
|
4215 macro, they are removed again (depending on the variable |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4216 @code{cdlatex-simplify-sub-super-scripts}). |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4217 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4218 @kindex ` |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4219 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
|
4220 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
|
4221 after the backquote, a help window will pop up. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4222 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4223 @kindex ' |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4224 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
|
4225 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
|
4226 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
|
4227 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
|
4228 is normal. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4229 @end itemize |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4230 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4231 @node Exporting, Publishing, Embedded LaTeX, Top |
58792 | 4232 @chapter Exporting |
4233 @cindex exporting | |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4234 |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4235 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
|
4236 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
|
4237 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
|
4238 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
|
4239 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
|
4240 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
|
4241 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
|
4242 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
|
4243 import of these different formats. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4244 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4245 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
|
4246 produced. @xref{Text interpretation}, for more details. |
58792 | 4247 |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4248 @table @kbd |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4249 @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
|
4250 @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
|
4251 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
|
4252 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
|
4253 command. |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4254 @end table |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4255 |
58792 | 4256 @menu |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4257 * ASCII export:: Exporting to plain ASCII |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4258 * HTML export:: Exporting to HTML |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4259 * XOXO export:: Exporting to XOXO |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4260 * iCalendar export:: Exporting in iCalendar format |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4261 * Text interpretation:: How the exporter looks at the file |
58792 | 4262 @end menu |
4263 | |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4264 @node ASCII export, HTML export, Exporting, Exporting |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4265 @section ASCII export |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4266 @cindex ASCII export |
58792 | 4267 |
71098
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
4268 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
|
4269 file. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4270 |
58792 | 4271 @cindex region, active |
4272 @cindex active region | |
4273 @cindex transient-mark-mode | |
4274 @table @kbd | |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4275 @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
|
4276 @item C-c C-e a |
58792 | 4277 Export as ASCII file. If there is an active region, only the region |
4278 will be exported. For an org file @file{myfile.org}, the ASCII file | |
4279 will be @file{myfile.txt}. The file will be overwritten without | |
4280 warning. | |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4281 @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
|
4282 @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
|
4283 Export only the visible part of the document. |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4284 @end table |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4285 |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4286 @cindex headline levels, for exporting |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4287 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
|
4288 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
|
4289 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
|
4290 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
|
4291 |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4292 @example |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4293 @kbd{C-1 C-c C-e a} |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4294 @end example |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4295 |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4296 @noindent |
71246
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
4297 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
|
4298 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
|
4299 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
|
4300 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
|
4301 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
|
4302 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
|
4303 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
|
4304 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4305 @node HTML export, XOXO export, ASCII export, Exporting |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4306 @section HTML export |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4307 @cindex HTML export |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4308 |
71098
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
4309 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
|
4310 HTML formatting, in ways similar to John Grubers @emph{markdown} |
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
4311 language, but with additional support for tables. |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4312 |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4313 @cindex region, active |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4314 @cindex active region |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4315 @cindex transient-mark-mode |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4316 @table @kbd |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4317 @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
|
4318 @item C-c C-e h |
58792 | 4319 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
|
4320 @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
|
4321 @item C-c C-e b |
58792 | 4322 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
|
4323 @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
|
4324 @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
|
4325 @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
|
4326 @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
|
4327 Export only the visible part of the document. |
58792 | 4328 @end table |
4329 | |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4330 @cindex headline levels, for exporting |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4331 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
|
4332 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
|
4333 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
|
4334 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
|
4335 |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4336 @example |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4337 @kbd{C-2 C-c C-e b} |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4338 @end example |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4339 |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4340 @noindent |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4341 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
|
4342 |
58792 | 4343 If you want to include HTML tags which should be interpreted as such, |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4344 mark them with @samp{@@} as in @samp{@@<b>bold text@@</b>}. |
58792 | 4345 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and |
4346 @samp{>} in HTML export. | |
4347 | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4348 @cindex links, in HTML export |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4349 @cindex internal links, in HTML export |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4350 @cindex external links, in HTML export |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4351 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
|
4352 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
|
4353 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
|
4354 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
|
4355 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
|
4356 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
|
4357 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
|
4358 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
|
4359 @ref{Publishing links}. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4360 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4361 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
|
4362 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
|
4363 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
|
4364 @example |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4365 .todo @r{TODO keywords} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4366 .done @r{the DONE keyword} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4367 .timestamp @r{time stamp} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4368 .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
|
4369 .tag @r{tag in a headline} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4370 .target @r{target for links} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4371 @end example |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4372 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4373 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
|
4374 @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
|
4375 you may use file variables, best wrapped into a COMMENT section at the |
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
4376 end of the outline tree. For example: |
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
4377 |
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
4378 @example |
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
4379 * COMMENT HTML style specifications |
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
4380 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4381 # Local Variables: |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
4382 # 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
|
4383 # p @{font-weight: normal; color: gray; @} |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
4384 # h1 @{color: black; @} |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
4385 # </style>" |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
4386 # End: |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
4387 @end example |
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
4388 |
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
4389 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
|
4390 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
|
4391 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
|
4392 section in the buffer. |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
4393 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
4394 @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
|
4395 @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
|
4396 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4397 @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
|
4398 @section XOXO export |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4399 @cindex XOXO export |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4400 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4401 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
|
4402 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
|
4403 does not interpret any additional Org-mode features. |
58792 | 4404 |
4405 @table @kbd | |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4406 @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
|
4407 @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
|
4408 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
|
4409 @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
|
4410 @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
|
4411 Export only the visible part of the document. |
58792 | 4412 @end table |
4413 | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4414 @node iCalendar export, Text interpretation, XOXO export, Exporting |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4415 @section iCalendar export |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4416 @cindex iCalendar export |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4417 |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4418 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
|
4419 still prefer a standard calendar application for anniversaries and |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4420 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
|
4421 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
|
4422 application. Org-mode can export calendar information in the standard |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4423 iCalendar format. |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4424 |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4425 @table @kbd |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4426 @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
|
4427 @item C-c C-e i |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4428 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
|
4429 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
|
4430 @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
|
4431 @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
|
4432 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
|
4433 @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
|
4434 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
|
4435 @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
|
4436 @item C-c C-e c |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4437 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
|
4438 @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
|
4439 @code{org-combined-agenda-icalendar-file}. |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4440 @end table |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4441 |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
4442 How this calendar is best read and updated, depends on the application |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
4443 you are using. For example, when using iCal under Apple MacOS X, you |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
4444 could create a new calendar @samp{OrgMode} (the default name for the |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4445 calendar created by @kbd{C-c C-e c}, see the variables |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4446 @code{org-icalendar-combined-name} and |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4447 @code{org-combined-agenda-icalendar-file}). Then set Org-mode to |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4448 overwrite the corresponding file |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4449 @file{~/Library/Calendars/OrgMode.ics}. You may even use AppleScript |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4450 to make iCal re-read the calendar files each time a new version of |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4451 @file{OrgMode.ics} is produced. Here is the setup needed for this: |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4452 |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4453 @cindex applescript, for calendar update |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4454 @lisp |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4455 (setq org-combined-agenda-icalendar-file |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4456 "~/Library/Calendars/OrgMode.ics") |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4457 (add-hook 'org-after-save-iCalendar-file-hook |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4458 (lambda () |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4459 (shell-command |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4460 "osascript -e 'tell application \"iCal\" to reload calendars'"))) |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4461 @end lisp |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4462 |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4463 @node Text interpretation, , iCalendar export, Exporting |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4464 @section Text interpretation by the exporter |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4465 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4466 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
|
4467 in order to produce better output. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4468 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4469 @menu |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4470 * 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
|
4471 * Enhancing text:: Subscripts, symbols and more |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4472 * 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
|
4473 @end menu |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4474 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4475 @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
|
4476 @subsection Comment lines |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4477 @cindex comment lines |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4478 @cindex exporting, not |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4479 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4480 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
|
4481 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
|
4482 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
|
4483 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
|
4484 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4485 @table @kbd |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4486 @kindex C-c ; |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4487 @item C-c ; |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4488 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
|
4489 @end table |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4490 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4491 @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
|
4492 @subsection Enhancing text for export |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4493 @cindex enhancing text |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4494 @cindex richer text |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4495 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4496 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
|
4497 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
|
4498 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
|
4499 formatted output. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4500 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4501 @itemize @bullet |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4502 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4503 @cindex hand-formatted lists |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4504 @cindex lists, hand-formatted |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4505 @item |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4506 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
|
4507 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
|
4508 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
|
4509 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4510 @cindex underlined text |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4511 @cindex bold text |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4512 @cindex italic text |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4513 @item |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4514 You can make words @b{*bold*}, @i{/italic/}, _underlined_, |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4515 @code{=code=}, and @samp{+strikethrough+}. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4516 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4517 @cindex LaTeX fragments, export |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4518 @cindex TeX macros, export |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4519 @item |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4520 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
|
4521 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
|
4522 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4523 @cindex tables, export |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4524 @item |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4525 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
|
4526 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
|
4527 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
|
4528 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4529 @cindex fixed width |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4530 @item |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4531 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
|
4532 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
|
4533 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
|
4534 fixed-width font. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4535 @table @kbd |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4536 @kindex C-c : |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4537 @item C-c : |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4538 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
|
4539 @end table |
71246
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
4540 |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
4541 @cindex linebreak, forced |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
4542 @item |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
4543 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
|
4544 this position. |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4545 @end itemize |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4546 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4547 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
|
4548 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
|
4549 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
|
4550 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
|
4551 buffer. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4552 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4553 |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4554 @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
|
4555 @subsection Export options |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4556 @cindex options, for export |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4557 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4558 @cindex completion, of option keywords |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4559 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
|
4560 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
|
4561 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
|
4562 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
|
4563 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
|
4564 (@pxref{Completion}). |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4565 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4566 @table @kbd |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4567 @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
|
4568 @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
|
4569 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
|
4570 @end table |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4571 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4572 @example |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4573 #+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
|
4574 #+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
|
4575 #+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
|
4576 #+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
|
4577 #+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
|
4578 #+TEXT: Several lines may be given. |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4579 #+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
|
4580 @end example |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4581 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4582 @noindent |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4583 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
|
4584 you can: |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4585 @cindex headline levels |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4586 @cindex section-numbers |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4587 @cindex table of contents |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4588 @cindex linebreak preservation |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4589 @cindex quoted HTML tags |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4590 @cindex fixed-width sections |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4591 @cindex tables |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4592 @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
|
4593 @cindex emphasized text |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4594 @cindex @TeX{} macros |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4595 @cindex La@TeX{} fragments |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4596 @example |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4597 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
|
4598 num: @r{turn on/off section-numbers} |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4599 toc: @r{turn on/off table of contents} |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4600 \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
|
4601 @@: @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
|
4602 :: @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
|
4603 |: @r{turn on/off tables} |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4604 ^: @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
|
4605 *: @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
|
4606 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
|
4607 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
|
4608 @end example |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
4609 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4610 @node Publishing, Miscellaneous, Exporting, Top |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4611 @chapter Publishing |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4612 @cindex publishing |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4613 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4614 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
|
4615 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
|
4616 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
|
4617 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
|
4618 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
|
4619 @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
|
4620 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
|
4621 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
|
4622 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
|
4623 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
|
4624 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4625 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
|
4626 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4627 @menu |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4628 * Configuration:: Defining projects |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4629 * Sample configuration:: Example projects |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4630 * Triggering publication:: Publication commands |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4631 @end menu |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4632 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4633 @node Configuration, Sample configuration, Publishing, Publishing |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4634 @section Configuration |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4635 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4636 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
|
4637 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
|
4638 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4639 @menu |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4640 * Project alist:: The central configuration variable |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4641 * 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
|
4642 * 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
|
4643 * 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
|
4644 * Publishing options:: Tweaking HTML export |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4645 * 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
|
4646 * 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
|
4647 @end menu |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4648 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4649 @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
|
4650 @subsection The variable @code{org-publish-project-alist} |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4651 @cindex org-publish-project-alist |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4652 @cindex projects, for publishing |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4653 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4654 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
|
4655 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
|
4656 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
|
4657 the two following forms: |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4658 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4659 @lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4660 ("project-name" :property value :property value ...) |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4661 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4662 @r{or} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4663 |
71098
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
4664 ("project-name" :components ("project-name" "project-name" ...)) |
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
4665 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4666 @end lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4667 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4668 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
|
4669 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
|
4670 the publishing configuration to use when publishing those files. When |
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
4671 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
|
4672 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
|
4673 project, which group together files requiring different publishing |
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
4674 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
|
4675 will also publish. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4676 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4677 @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
|
4678 @subsection Sources and destinations for files |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4679 @cindex directories, for publishing |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4680 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4681 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
|
4682 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
|
4683 and where to put published files. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4684 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4685 @multitable @columnfractions 0.3 0.7 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4686 @item @code{:base-directory} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4687 @tab Directory containing publishing source files |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4688 @item @code{:publishing-directory} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4689 @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
|
4690 @item @code{:preparation-function} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4691 @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
|
4692 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
|
4693 @end multitable |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4694 @noindent |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4695 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4696 @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
|
4697 @subsection Selecting files |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4698 @cindex files, selecting for publishing |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4699 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4700 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
|
4701 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
|
4702 properties |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4703 @multitable @columnfractions 0.25 0.75 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4704 @item @code{:base-extension} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4705 @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
|
4706 regular expression. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4707 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4708 @item @code{:exclude} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4709 @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
|
4710 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
|
4711 extension. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4712 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4713 @item @code{:include} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4714 @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
|
4715 and @code{:exclude}. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4716 @end multitable |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4717 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4718 @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
|
4719 @subsection Publishing Action |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4720 @cindex action, for publishing |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4721 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4722 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
|
4723 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
|
4724 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
|
4725 @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
|
4726 (@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
|
4727 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
|
4728 specify the publishing function. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4729 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4730 @multitable @columnfractions 0.3 0.7 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4731 @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
|
4732 @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
|
4733 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
|
4734 @end multitable |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4735 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4736 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
|
4737 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
|
4738 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
|
4739 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
|
4740 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
|
4741 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
|
4742 @code{org-publish-attachment}. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4743 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4744 @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
|
4745 @subsection Options for the HTML exporter |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4746 @cindex options, for publishing |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4747 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4748 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
|
4749 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
|
4750 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
|
4751 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
|
4752 respective variable for details. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4753 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4754 @multitable @columnfractions 0.3 0.7 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4755 @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
|
4756 @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
|
4757 @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
|
4758 @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
|
4759 @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
|
4760 @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
|
4761 @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
|
4762 @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
|
4763 @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
|
4764 @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
|
4765 @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
|
4766 @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
|
4767 @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
|
4768 @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
|
4769 @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
|
4770 @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
|
4771 @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
|
4772 @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
|
4773 @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
|
4774 @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
|
4775 @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
|
4776 @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
|
4777 @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
|
4778 @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
|
4779 @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
|
4780 @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
|
4781 @end multitable |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4782 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4783 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
|
4784 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
|
4785 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
|
4786 options}), however, override everything. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4787 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4788 @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
|
4789 @subsection Links between published files |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4790 @cindex links, publishing |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4791 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4792 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
|
4793 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
|
4794 @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
|
4795 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
|
4796 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
|
4797 you publish them to HTML. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4798 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4799 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
|
4800 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
|
4801 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
|
4802 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
|
4803 |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
4804 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
|
4805 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
|
4806 location. In this case, use the property |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
4807 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
4808 @multitable @columnfractions 0.4 0.6 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
4809 @item @code{:link-validation-function} |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
4810 @tab Function to validate links |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
4811 @end multitable |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
4812 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
4813 @noindent |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
4814 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
|
4815 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
|
4816 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
|
4817 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
|
4818 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
|
4819 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
|
4820 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
|
4821 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4822 @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
|
4823 @subsection Project page index |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4824 @cindex index, of published pages |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4825 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4826 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
|
4827 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
|
4828 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4829 @multitable @columnfractions 0.25 0.75 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4830 @item @code{:auto-index} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4831 @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
|
4832 org-publish-all. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4833 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4834 @item @code{:index-filename} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4835 @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
|
4836 becomes @file{index.html}). |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4837 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4838 @item @code{:index-title} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4839 @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
|
4840 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4841 @item @code{:index-function} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4842 @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
|
4843 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
|
4844 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
|
4845 @end multitable |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4846 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4847 @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
|
4848 @section Sample configuration |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4849 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4850 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
|
4851 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
|
4852 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
|
4853 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4854 @menu |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4855 * Simple example:: One-component publishing |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4856 * 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
|
4857 @end menu |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4858 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4859 @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
|
4860 @subsection Example: simple publishing configuration |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4861 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4862 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
|
4863 directory on the local machine. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4864 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4865 @lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4866 (setq org-publish-project-alist |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4867 '(("org" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4868 :base-directory "~/org/" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4869 :publishing-directory "~/public_html" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4870 :section-numbers nil |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4871 :table-of-contents nil |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4872 :style "<link rel=stylesheet |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4873 href=\"../other/mystyle.css\" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4874 type=\"text/css\">"))) |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4875 @end lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4876 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4877 @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
|
4878 @subsection Example: complex publishing configuration |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4879 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4880 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
|
4881 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
|
4882 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
|
4883 excluded. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4884 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4885 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
|
4886 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
|
4887 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
|
4888 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
|
4889 @c |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4890 @example |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4891 file:../images/myimage.png |
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 @c |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4894 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
|
4895 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
|
4896 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
|
4897 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4898 @lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4899 (setq org-publish-project-alist |
71098
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
4900 '(("orgfiles" |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4901 :base-directory "~/org/" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4902 :base-extension "org" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4903 :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
|
4904 :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
|
4905 :exclude "PrivatePage.org" ;; regexp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4906 :headline-levels 3 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4907 :section-numbers nil |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4908 :table-of-contents nil |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4909 :style "<link rel=stylesheet |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4910 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
|
4911 :auto-preamble t |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4912 :auto-postamble nil) |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4913 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4914 ("images" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4915 :base-directory "~/images/" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4916 :base-extension "jpg\\|gif\\|png" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4917 :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
|
4918 :publishing-function org-publish-attachment) |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4919 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4920 ("other" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4921 :base-directory "~/other/" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4922 :base-extension "css\\|el" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4923 :publishing-directory "/ssh:user@@host:~/html/other/" |
71098
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
4924 :publishing-function org-publish-attachment) |
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
4925 ("website" :components ("orgfiles" "images" "other")))) |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4926 @end lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4927 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4928 @node Triggering publication, , Sample configuration, Publishing |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4929 @section Triggering publication |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4930 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4931 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
|
4932 following functions: |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4933 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4934 @table @kbd |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4935 @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
|
4936 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
|
4937 @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
|
4938 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
|
4939 @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
|
4940 Publish only the current file. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4941 @item C-c C-e a |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4942 Publish all projects. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4943 @end table |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4944 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4945 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
|
4946 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
|
4947 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
|
4948 |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
4949 @node Miscellaneous, Extensions and Hacking, Publishing, Top |
58792 | 4950 @chapter Miscellaneous |
4951 | |
4952 @menu | |
4953 * Completion:: M-TAB knows what you need | |
4954 * Customization:: Adapting Org-mode to your taste | |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4955 * 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
|
4956 * 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
|
4957 * 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
|
4958 * TTY keys:: Using Org-mode on a tty |
58792 | 4959 * Interaction:: Other Emacs packages |
63362 | 4960 * Bugs:: Things which do not work perfectly |
58792 | 4961 @end menu |
4962 | |
4963 @node Completion, Customization, Miscellaneous, Miscellaneous | |
4964 @section Completion | |
63833 | 4965 @cindex completion, of @TeX{} symbols |
4966 @cindex completion, of TODO keywords | |
4967 @cindex completion, of dictionary words | |
4968 @cindex completion, of option keywords | |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
4969 @cindex completion, of CamelCase links |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4970 @cindex completion, of tags |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4971 @cindex @TeX{} symbol completion |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4972 @cindex TODO keywords completion |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4973 @cindex dictionary word completion |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4974 @cindex option keyword completion |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4975 @cindex CamelCase link completion |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4976 @cindex tag completion |
58792 | 4977 |
4978 Org-mode supports in-buffer completion. This type of completion does | |
4979 not make use of the minibuffer. You simply type a few letters into | |
4980 the buffer and use the key to complete text right there. | |
4981 | |
4982 @table @kbd | |
4983 @kindex M-@key{TAB} | |
4984 @item M-@key{TAB} | |
4985 Complete word at point | |
4986 @itemize @bullet | |
4987 @item | |
4988 At the beginning of a headline, complete TODO keywords. | |
4989 @item | |
4990 After @samp{\}, complete @TeX{} symbols supported by the exporter. | |
4991 @item | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4992 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
|
4993 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
|
4994 @item |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4995 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
|
4996 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
|
4997 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
|
4998 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
|
4999 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5000 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}). |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
5001 @item |
58792 | 5002 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or |
5003 @samp{OPTIONS} which set file-specific options for Org-mode. When the | |
5004 option keyword is already complete, pressing @kbd{M-@key{TAB}} again | |
5005 will insert example settings for this keyword. | |
5006 @item | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5007 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
|
5008 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
|
5009 @item |
58792 | 5010 Elsewhere, complete dictionary words using ispell. |
5011 @end itemize | |
5012 @end table | |
5013 | |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5014 @node Customization, In-buffer settings, Completion, Miscellaneous |
58792 | 5015 @section Customization |
5016 @cindex customization | |
5017 @cindex options, for customization | |
5018 @cindex variables, for customization | |
5019 | |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
5020 There are more than 100 variables that can be used to customize |
58792 | 5021 Org-mode. For the sake of compactness of the manual, we are not |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
5022 describing the variables here. A structured overview of customization |
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
5023 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
|
5024 @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
|
5025 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
|
5026 lines into the buffer (@pxref{In-buffer settings}). |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5027 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5028 @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
|
5029 @section Summary of in-buffer settings |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5030 @cindex in-buffer settings |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5031 @cindex special keywords |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5032 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5033 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
|
5034 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
|
5035 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
|
5036 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
|
5037 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
|
5038 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
|
5039 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
|
5040 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
|
5041 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
|
5042 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5043 @table @kbd |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5044 @item #+STARTUP: |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5045 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
|
5046 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
|
5047 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
|
5048 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
|
5049 value @code{t}, which means @code{overview}. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5050 @example |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5051 overview @r{top-level headlines only} |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5052 content @r{all headlines} |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5053 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
|
5054 @end example |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5055 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
|
5056 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
|
5057 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
|
5058 @code{nil}. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5059 @example |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5060 align @r{align all tables} |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
5061 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
|
5062 @end example |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5063 Logging when a TODO item is marked DONE (variable @code{org-log-done}) |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5064 can be configured using these options. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5065 @example |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5066 logging @r{record a timestamp when an item is marked DONE} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5067 nologging @r{don't record when items are marked DONE} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5068 @end example |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5069 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
|
5070 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
|
5071 @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
|
5072 (meaning @code{showstars} and @code{oddeven}). |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5073 @example |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5074 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
|
5075 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
|
5076 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
|
5077 oddeven @r{allow all outline levels} |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5078 @end example |
74030 | 5079 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
|
5080 @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
|
5081 @code{org-time-stamp-overlay-formats}), use |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5082 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5083 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
|
5084 @end example |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5085 @item #+SEQ_TODO: #+TYP_TODO: |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5086 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
|
5087 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
|
5088 and @code{org-todo-interpretation}. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5089 @item #+TAGS: TAG1(c1) TAG2(c2) |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5090 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
|
5091 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
|
5092 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
|
5093 @item #+LINK: linkword replace |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5094 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
|
5095 @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
|
5096 @code{org-link-abbrev-alist}. |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5097 @item #+CATEGORY: |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5098 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
|
5099 for all subsequent lines until the next @samp{#+CATEGORY} line, or the |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5100 end of the file. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5101 @item #+TBLFM: |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5102 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
|
5103 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS: |
71098
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
5104 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
|
5105 @ref{Export options}. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5106 @end table |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5107 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5108 @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
|
5109 @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
|
5110 @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
|
5111 @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
|
5112 |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5113 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
|
5114 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
|
5115 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
|
5116 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
|
5117 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
|
5118 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
|
5119 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5120 @itemize @minus |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5121 @item |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
5122 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
|
5123 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
|
5124 @item |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5125 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
|
5126 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
|
5127 information. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5128 @item |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5129 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
|
5130 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
|
5131 @item |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5132 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
|
5133 the entire table. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5134 @item |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5135 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
|
5136 activate that table. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5137 @item |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5138 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
|
5139 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
|
5140 default location. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5141 @item |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5142 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
|
5143 corresponding links in this buffer. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5144 @item |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5145 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
|
5146 of the checkbox. |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5147 @item |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5148 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
|
5149 ordered list. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5150 @end itemize |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5151 |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5152 @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
|
5153 @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
|
5154 @cindex hiding leading stars |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5155 @cindex clean outline view |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5156 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5157 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
|
5158 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
|
5159 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
|
5160 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5161 @example |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5162 * Top level headline |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5163 ** Second level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5164 *** 3rd level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5165 some text |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5166 *** 3rd level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5167 more text |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5168 * Another top level headline |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5169 @end example |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5170 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5171 @noindent |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5172 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
|
5173 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
|
5174 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
|
5175 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
|
5176 @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
|
5177 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5178 @lisp |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5179 (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
|
5180 @end lisp |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5181 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5182 @noindent |
69456
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5183 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
|
5184 the buffer) |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5185 |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5186 @example |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5187 #+STARTUP: showstars |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5188 #+STARTUP: hidestars |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5189 @end example |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5190 |
69456
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5191 @noindent |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5192 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
|
5193 the modifications. |
69456
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5194 |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5195 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
|
5196 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5197 @example |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5198 * Top level headline |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5199 * Second level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5200 * 3rd level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5201 some text |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5202 * 3rd level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5203 more text |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5204 * Another top level headline |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5205 @end example |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5206 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5207 @noindent |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5208 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
|
5209 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
|
5210 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
|
5211 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
|
5212 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
|
5213 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
|
5214 @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
|
5215 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5216 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
|
5217 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
|
5218 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
|
5219 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5220 @example |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5221 * Top level headline |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5222 * Second level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5223 * 3rd level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5224 some text |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5225 * 3rd level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5226 more text |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5227 * Another top level headline |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5228 @end example |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5229 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5230 @noindent |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5231 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
|
5232 convention correctly, use |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5233 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5234 @lisp |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5235 (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
|
5236 @end lisp |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5237 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5238 @noindent |
69456
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5239 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
|
5240 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
|
5241 activate changes immediately). |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5242 |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5243 @example |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5244 #+STARTUP: odd |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5245 #+STARTUP: oddeven |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5246 @end example |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5247 |
69999
bd591cbbcdec
(Updating settings): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
69929
diff
changeset
|
5248 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
|
5249 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
|
5250 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
|
5251 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
|
5252 |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5253 @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
|
5254 @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
|
5255 @cindex tty keybindings |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5256 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5257 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
|
5258 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
|
5259 @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
|
5260 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
|
5261 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
|
5262 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
|
5263 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
|
5264 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
|
5265 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
|
5266 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
|
5267 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
|
5268 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
|
5269 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5270 @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
|
5271 @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
|
5272 @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
|
5273 @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
|
5274 @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
|
5275 @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
|
5276 @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
|
5277 @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
|
5278 @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
|
5279 @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
|
5280 @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
|
5281 @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
|
5282 @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
|
5283 @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
|
5284 @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
|
5285 @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
|
5286 @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
|
5287 @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
|
5288 @end multitable |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
5289 |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5290 @node Interaction, Bugs, TTY keys, Miscellaneous |
58792 | 5291 @section Interaction with other packages |
5292 @cindex packages, interaction with other | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5293 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
|
5294 with other code out there. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5295 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5296 @menu |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5297 * Cooperation:: Packages Org-mode cooperates with |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5298 * Conflicts:: Packages that lead to conflicts |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5299 @end menu |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5300 |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5301 @node Cooperation, Conflicts, Interaction, Interaction |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5302 @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
|
5303 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5304 @table @asis |
63833 | 5305 @cindex @file{calc.el} |
5306 @item @file{calc.el} by Dave Gillespie | |
5307 Org-mode uses the calc package for implementing spreadsheet | |
5308 functionality in its tables (@pxref{Table calculations}). Org-modes | |
5309 checks for the availability of calc by looking for the function | |
5310 @code{calc-eval} which should be autoloaded in your setup if calc has | |
5311 been installed properly. As of Emacs 22, calc is part of the Emacs | |
5312 distribution. Another possibility for interaction between the two | |
5313 packages is using calc for embedded calculations. @xref{Embedded Mode, | |
64517 | 5314 , Embedded Mode, calc, GNU Emacs Calc Manual}. |
63833 | 5315 @cindex @file{constants.el} |
5316 @item @file{constants.el} by Carsten Dominik | |
5317 In a table formula (@pxref{Table calculations}), 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
|
5318 names for natural constants or units. Instead of defining your own |
63833 | 5319 constants in the variable @code{org-table-formula-constants}, install |
5320 the @file{constants} package which defines a large number of constants | |
5321 and units, and lets you use unit prefixes like @samp{M} for | |
5322 @samp{Mega} etc. You will need version 2.0 of this package, available | |
5323 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org-mode checks for | |
5324 the function @code{constants-get}, which has to be autoloaded in your | |
5325 setup. See the installation instructions in the file | |
5326 @file{constants.el}. | |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5327 @item @file{cdlatex.el} by Carsten Dominik |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5328 @cindex @file{cdlatex.el} |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5329 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
|
5330 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
|
5331 @item @file{remember.el} by John Wiegley |
63833 | 5332 @cindex @file{remember.el} |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5333 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
|
5334 @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
|
5335 @cindex @file{table.el} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5336 @item @file{table.el} by Takaaki Ota |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5337 Org mode cooperates with table.el, see @ref{table.el}. @file{table.el} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5338 is part of Emacs 22. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5339 @end table |
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 @node Conflicts, , Cooperation, Interaction |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5342 @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
|
5343 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5344 @table @asis |
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 @cindex @file{allout.el} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5347 @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
|
5348 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
|
5349 @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
|
5350 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
|
5351 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
|
5352 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
|
5353 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
|
5354 @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
|
5355 |
63362 | 5356 @cindex @file{CUA.el} |
5357 @item @file{CUA.el} by Kim. F. Storm | |
5358 Keybindings in Org-mode conflict with the @kbd{S-<cursor>} keys | |
5359 used by CUA-mode (as well as pc-select-mode and s-region-mode) to | |
5360 select and extend the region. If you want to use one of these | |
5361 packages along with Org-mode, configure the variable | |
63833 | 5362 @code{org-CUA-compatible}. When set, Org-mode will move the following |
63362 | 5363 keybindings in org-mode files, and in the agenda buffer (but not |
5364 during date selection). | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5365 |
63362 | 5366 @example |
5367 S-UP -> M-p S-DOWN -> M-n | |
5368 S-LEFT -> M-- S-RIGHT -> M-+ | |
5369 S-RET -> C-S-RET | |
5370 @end example | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5371 |
63362 | 5372 Yes, these are unfortunately more difficult to remember. If you want |
5373 to have other replacement keys, look at the variable | |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
5374 @code{org-disputed-keys}. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5375 @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
|
5376 @cindex @file{windmove.el} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5377 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
|
5378 in the paragraph above about CUA mode also applies here. |
58792 | 5379 @end table |
5380 | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5381 |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5382 @node Bugs, , Interaction, Miscellaneous |
63362 | 5383 @section Bugs |
5384 @cindex bugs | |
5385 | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5386 Here is a list of things that should work differently, but which I |
63362 | 5387 have found too hard to fix. |
58792 | 5388 |
63362 | 5389 @itemize @bullet |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
5390 @item |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5391 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
|
5392 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
|
5393 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
|
5394 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
|
5395 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
|
5396 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
|
5397 @item |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5398 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
|
5399 @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
|
5400 @item |
65656 | 5401 Text in an entry protected with the @samp{QUOTE} keyword should not |
5402 autowrap. | |
5403 @item | |
63362 | 5404 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
|
5405 (for example because the application does not exist or refuses to open |
63362 | 5406 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
|
5407 @item |
65656 | 5408 The remote-editing commands in the agenda buffer cannot be undone with |
5409 @code{undo} called from within the agenda buffer. But you can go to | |
5410 the corresponding buffer (using @key{TAB} or @key{RET} and execute | |
5411 @code{undo} there. | |
5412 @item | |
63833 | 5413 Recalculating a table line applies the formulas from left to right. |
65656 | 5414 If a formula uses @emph{calculated} fields further down the row, |
5415 multiple recalculation may be needed to get all fields consistent. | |
63833 | 5416 @item |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5417 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
|
5418 @item |
63362 | 5419 The exporters work well, but could be made more efficient. |
5420 @end itemize | |
5421 | |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5422 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5423 @node Extensions and Hacking, History and Acknowledgments, Miscellaneous, Top |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5424 @appendix Extensions, Hooks and Hacking |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5425 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5426 This appendix lists extensions for Org-mode written by other authors. |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5427 It also covers some aspects where users can easily extend the |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5428 functionality of Org-mode. |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5429 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5430 @menu |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5431 * Extensions:: Existing 3rd-part extensions |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5432 * Dynamic blocks:: Automatically filled blocks |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5433 @end menu |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5434 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5435 @node Extensions, Dynamic blocks, Extensions and Hacking, Extensions and Hacking |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5436 @section Third-party extensions for Org-mode |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5437 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5438 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
|
5439 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5440 @table @asis |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5441 @cindex @file{org-publish.el} |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5442 @item @file{org-publish.el} by David O'Toole |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5443 This package provides facilities for publishing related sets of Org-mode |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5444 files together with linked files like images as a webpages. It is |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5445 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
|
5446 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
|
5447 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
|
5448 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
|
5449 @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
|
5450 @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
|
5451 @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
|
5452 @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
|
5453 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
|
5454 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
|
5455 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
|
5456 @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
|
5457 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
|
5458 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
|
5459 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
|
5460 @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
|
5461 @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
|
5462 @cindex @file{org-blog.el} |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5463 @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
|
5464 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
|
5465 @url{http://dto.freeshell.org/notebook/OrgMode.html}. |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5466 @cindex @file{org-blogging.el} |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5467 @item @file{org-blogging.el} by Bastien Guerry |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5468 Publish Org-mode files as |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5469 blogs. @url{http://www.cognition.ens.fr/~guerry/org-blogging.html}. |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5470 @end table |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5471 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5472 @node Dynamic blocks, , Extensions, Extensions and Hacking |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5473 @section Dynamic blocks |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5474 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5475 Org-mode documents can contain @emph{dynamic blocks}. These are |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
5476 specially marked regions that are updated by some user-written |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5477 function. A good example for such a block is the clock table inserted |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5478 by the command @kbd{C-c C-x C-r} (@pxref{Clocking work time}). |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5479 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5480 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
|
5481 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
|
5482 the content of the block. |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5483 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5484 @example |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
5485 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ... |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5486 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5487 #+END: |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5488 @end example |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5489 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5490 Dynamic blocks are updated with the following commands |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5491 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5492 @table @kbd |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5493 @kindex C-c C-x C-u |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5494 @item C-c C-x C-u |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5495 Update dynamic block at point. |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5496 @kindex C-u C-c C-x C-u |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5497 @item C-u C-c C-x C-u |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5498 Update all dynamic blocks in the current file. |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5499 @end table |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5500 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5501 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
|
5502 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
|
5503 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
|
5504 with name @code{myblock}, the writer function is |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5505 @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
|
5506 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
|
5507 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
|
5508 run: |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5509 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5510 @example |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5511 #+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
|
5512 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5513 #+END: |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5514 @end example |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5515 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5516 @noindent |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5517 The corresponding block writer function could look like this: |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5518 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5519 @lisp |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
5520 (defun org-dblock-write:block-update-time (params) |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5521 (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
|
5522 (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
|
5523 (format-time-string fmt (current-time))))) |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5524 @end lisp |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5525 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5526 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
|
5527 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
|
5528 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
|
5529 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
|
5530 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5531 @node History and Acknowledgments, Index, Extensions and Hacking, Top |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5532 @appendix History and Acknowledgments |
58792 | 5533 @cindex acknowledgments |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5534 @cindex history |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
5535 @cindex thanks |
58792 | 5536 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5537 Org-mode was borne in 2003, out of frustration over the user interface |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5538 of the Emacs outline-mode. All I wanted was to make working with an |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5539 outline tree possible without having to remember more than 10 commands |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5540 just for hiding and unhiding parts of the outline tree, and to allow to |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5541 restructure a tree easily. Visibility cycling and structure editing |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5542 were originally implemented in the package @file{outline-magic.el}, but |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5543 quickly moved to the more general @file{org.el}. TODO entries, basic |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5544 time stamps, and table support were added next, and highlight the two |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5545 main goals that Org-mode still has today: To create a new, |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5546 outline-based, plain text mode with innovative and intuitive editing |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5547 features, and to incorporate project planning functionality directly |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5548 into a notes file. |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5549 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5550 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
|
5551 @code{emacs-orgmode@@gnu.org} have provided a constant stream of bug |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5552 reports, feedback, new ideas, and sometimes even patches and add-on |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5553 code. Many thanks to everyone who has helped to improve this package. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5554 I am trying to keep here a list of the people who had significant |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5555 influence in shaping one or more aspects of Org-mode. The list may not |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5556 be complete, if I have forgotten someone, please accept my apologies and |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5557 let me know. |
58792 | 5558 |
5559 @itemize @bullet | |
73967
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
5560 |
58792 | 5561 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5562 @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
|
5563 system. |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
5564 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5565 @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
|
5566 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5567 @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
|
5568 for Remember. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5569 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5570 @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
|
5571 specified time. |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
5572 @item |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5573 @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
|
5574 calculations and improved XEmacs compatibility, in particular by porting |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5575 @file{nouline.el} to XEmacs. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5576 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5577 @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
|
5578 @item |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5579 @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
|
5580 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5581 @i{Kees Dullemond} inspired the use of narrowed tabled columns. |
70065
4804517d7073
(Formula syntax): Fixed link to Calc Manual.
Carsten Dominik <dominik@science.uva.nl>
parents:
70011
diff
changeset
|
5582 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5583 @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
|
5584 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
|
5585 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5586 @i{Nic Ferrier} contributed mailcap and XOXO support. |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
5587 @item |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5588 @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
|
5589 @item |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5590 @i{Bastien Guerry} provided extensive feedback. |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5591 @item |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5592 @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
|
5593 @item |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
5594 @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
|
5595 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5596 @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
|
5597 happy. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5598 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5599 @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
|
5600 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5601 @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
|
5602 file links, and TAGS. |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
5603 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5604 @i{Oliver Oppitz} suggested multi-state TODO items. |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5605 @item |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5606 @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
|
5607 links, among other things. |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
5608 @item |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5609 @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
|
5610 provided frequent feedback. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5611 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5612 @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
|
5613 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5614 @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
|
5615 control. |
58792 | 5616 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5617 @i{Kevin Rogers} contributed code to access VM files on remote hosts. |
58792 | 5618 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5619 @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
|
5620 conflict with @file{allout.el}. |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
5621 @item |
74030 | 5622 @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
|
5623 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5624 @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
|
5625 of feedback. |
58792 | 5626 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5627 @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
|
5628 other things. |
63362 | 5629 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5630 Linking to VM/BBDB/GNUS was inspired by @i{Tom Shannon}'s |
58792 | 5631 @file{organizer-mode.el}. |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5632 @item |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
5633 @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
|
5634 subtrees. |
58792 | 5635 @item |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5636 @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
|
5637 @item |
71246
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
5638 @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
|
5639 chapter about publishing. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5640 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5641 @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
|
5642 in HTML output. |
58792 | 5643 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5644 @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
|
5645 keyword. |
69456
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
5646 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5647 @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
|
5648 system. |
58792 | 5649 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5650 @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
|
5651 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
|
5652 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
|
5653 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
|
5654 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
|
5655 description is shown, and (ii) popping up a calendar to select a date. |
58792 | 5656 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5657 @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
|
5658 linking to GNUS. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5659 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5660 @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
|
5661 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
|
5662 @item |
74030 | 5663 @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
|
5664 and contributed various ideas and code snippets. |
58792 | 5665 @end itemize |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5666 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5667 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5668 @node Index, Key Index, History and Acknowledgments, Top |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
5669 @unnumbered Index |
58792 | 5670 |
5671 @printindex cp | |
5672 | |
5673 @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
|
5674 @unnumbered Key Index |
58792 | 5675 |
5676 @printindex ky | |
5677 | |
5678 @bye | |
64070 | 5679 |
5680 @ignore | |
5681 arch-tag: 7893d1fe-cc57-4d13-b5e5-f494a1bcc7ac | |
5682 @end ignore |