Mercurial > emacs
annotate man/org.texi @ 82845:652a69b79238
(Finvisible_p): New function.
(syms_of_xdisp): defsubr it.
author | Stefan Monnier <monnier@iro.umontreal.ca> |
---|---|
date | Sat, 25 Aug 2007 20:11:09 +0000 |
parents | fdded9c0e328 |
children | 4d423ff270e2 |
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 |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6 @set VERSION 5.05 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7 @set DATE August 2007 |
58792 | 8 |
9 @dircategory Emacs | |
10 @direntry | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
11 * Org Mode: (org). Outline-based notes management and organizer |
58792 | 12 @end direntry |
13 | |
14 @c Version and Contact Info | |
15 @set MAINTAINERSITE @uref{http://www.astro.uva.nl/~dominik/Tools/org/,maintainers webpage} | |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
16 @set AUTHOR Carsten Dominik |
58792 | 17 @set MAINTAINER Carsten Dominik |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
18 @set MAINTAINEREMAIL @email{dominik at science dot uva dot nl} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
19 @set MAINTAINERCONTACT @uref{mailto:dominik at science dot uva dot nl,contact the maintainer} |
58792 | 20 @c %**end of header |
21 @finalout | |
22 | |
23 @c Macro definitions | |
24 | |
69999
bd591cbbcdec
(Updating settings): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
69929
diff
changeset
|
25 @c Subheadings inside a table. |
58792 | 26 @macro tsubheading{text} |
27 @ifinfo | |
28 @subsubheading \text\ | |
29 @end ifinfo | |
30 @ifnotinfo | |
31 @item @b{\text\} | |
32 @end ifnotinfo | |
33 @end macro | |
34 | |
35 @copying | |
36 This manual is for Org-mode (version @value{VERSION}). | |
37 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
38 Copyright @copyright{} 2004, 2005, 2006, 2007 Free Software Foundation |
58792 | 39 |
40 @quotation | |
41 Permission is granted to copy, distribute and/or modify this document | |
65656 | 42 under the terms of the GNU Free Documentation License, Version 1.1 or |
58792 | 43 any later version published by the Free Software Foundation; with no |
44 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' | |
45 and with the Back-Cover Texts as in (a) below. A copy of the | |
46 license is included in the section entitled ``GNU Free Documentation | |
47 License.'' | |
48 | |
49 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify | |
50 this GNU Manual, like GNU software. Copies published by the Free | |
51 Software Foundation raise funds for GNU development.'' | |
52 @end quotation | |
53 @end copying | |
54 | |
55 @titlepage | |
56 @title Org Mode Manual | |
57 | |
58 @subtitle Release @value{VERSION} | |
59 @author by Carsten Dominik | |
60 | |
61 @c The following two commands start the copyright page. | |
62 @page | |
63 @vskip 0pt plus 1filll | |
64 @insertcopying | |
65 @end titlepage | |
66 | |
67 @c Output the table of contents at the beginning. | |
68 @contents | |
69 | |
70 @ifnottex | |
71 @node Top, Introduction, (dir), (dir) | |
72 @top Org Mode Manual | |
73 | |
74 @insertcopying | |
75 @end ifnottex | |
76 | |
77 @menu | |
78 * Introduction:: Getting started | |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
79 * Document structure:: A tree works like your brain |
58792 | 80 * Tables:: Pure magic for quick formatting |
81 * Hyperlinks:: Notes in context | |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
82 * TODO items:: Every tree branch can be a TODO item |
81465
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
83 * Tags:: Tagging headlines and matching sets of tags |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
84 * Properties and columns:: |
58792 | 85 * Timestamps:: Assign date and time to items |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
86 * Agenda views:: Collecting information into views |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
87 * Embedded LaTeX:: LaTeX fragments and formulas |
58792 | 88 * 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
|
89 * Publishing:: Create a web site of linked Org-mode files |
58792 | 90 * 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
|
91 * 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
|
92 * History and Acknowledgments:: How Org-mode came into being |
58792 | 93 * Index:: The fast road to specific information |
94 * Key Index:: Key bindings and where they are described | |
95 | |
96 @detailmenu | |
97 --- The Detailed Node Listing --- | |
98 | |
99 Introduction | |
100 | |
101 * Summary:: Brief summary of what Org-mode does | |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
102 * Installation:: How to install a downloaded version of Org-mode |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
103 * Activation:: How to activate Org-mode for certain buffers. |
64517 | 104 * Feedback:: Bug reports, ideas, patches etc. |
58792 | 105 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
106 Document Structure |
58792 | 107 |
108 * Outlines:: Org-mode is based on outline-mode | |
109 * Headlines:: How to typeset org-tree headlines | |
65656 | 110 * Visibility cycling:: Show and hide, much simplified |
58792 | 111 * Motion:: Jumping to other headlines |
112 * Structure editing:: Changing sequence and level of headlines | |
63362 | 113 * Archiving:: Move done task trees to a different place |
58792 | 114 * Sparse trees:: Matches embedded in context |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
115 * Plain lists:: Additional structure within an entry |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
116 * Drawers:: Tucking stuff away |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
117 * orgstruct-mode:: Structure editing outside Org-mode |
58792 | 118 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
119 Archiving |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
120 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
121 * ARCHIVE tag:: Marking a tree as inactive |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
122 * Moving subtrees:: Moving a tree to an archive file |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
123 |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
124 Tables |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
125 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
126 * 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
|
127 * Narrow columns:: Stop wasting space in tables |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
128 * Column groups:: Grouping to trigger vertical lines |
63833 | 129 * orgtbl-mode:: The table editor as minor mode |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
130 * The spreadsheet:: The table editor has spreadsheet capabilities. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
131 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
132 The spreadsheet |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
133 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
134 * References:: How to refer to another field or range |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
135 * Formula syntax for Calc:: Using Calc to compute stuff |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
136 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
137 * Field formulas:: Formulas valid for a single field |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
138 * Column formulas:: Formulas valid for an entire column |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
139 * Editing and debugging formulas:: Fixing formulas |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
140 * Updating the table:: Recomputing all dependent fields |
64517 | 141 * Advanced features:: Field names, parameters and automatic recalc |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
142 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
143 Hyperlinks |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
144 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
145 * 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
|
146 * 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
|
147 * External links:: URL-like links to the world |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
148 * Handling links:: Creating, inserting and following |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
149 * Using links outside Org-mode:: Linking from my C source code? |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
150 * 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
|
151 * 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
|
152 * Custom searches:: When the default search is not enough |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
153 * Remember:: Org-trees store quick notes |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
154 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
155 Internal links |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
156 |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
157 * Radio targets:: Make targets trigger links in plain text. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
158 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
159 Remember |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
160 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
161 * Setting up remember:: Some code for .emacs to get things going |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
162 * Remember templates:: Define the outline of different note types |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
163 * Storing notes:: Directly get the note to where it belongs |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
164 |
58792 | 165 TODO items |
166 | |
167 * TODO basics:: Marking and displaying TODO entries | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
168 * TODO extensions:: Workflow and assignments |
58792 | 169 * Priorities:: Some things are more important than others |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
170 * Breaking down tasks:: Splitting a task into manageable pieces |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
171 * Checkboxes:: Tick-off lists |
58792 | 172 |
173 Extended use of TODO keywords | |
174 | |
175 * Workflow states:: From TODO to DONE in steps | |
176 * TODO types:: I do this, Fred the rest | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
177 * Multiple sets in one file:: Mixing it all, and still finding your way |
58792 | 178 * Per file keywords:: Different files, different requirements |
179 | |
81465
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
180 Tags |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
181 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
182 * Tag inheritance:: Tags use the tree structure of the outline |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
183 * Setting tags:: How to assign tags to a headline |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
184 * Tag searches:: Searching for combinations of tags |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
185 |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
186 Properties and Columns |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
187 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
188 * Property syntax:: How properties are spelled out |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
189 * Special properties:: Access to other Org-mode features |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
190 * Property searches:: Matching property values |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
191 * Column view:: Tabular viewing and editing |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
192 * Property API:: Properties for Lisp programmers |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
193 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
194 Column View |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
195 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
196 * Defining columns:: The COLUMNS format property |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
197 * Using column view:: How to create and use column view |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
198 |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
199 Defining Columns |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
200 |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
201 * Scope of column definitions:: Where defined, where valid? |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
202 * Column attributes:: Appearance and content of a column |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
203 |
58792 | 204 Timestamps |
205 | |
206 * Time stamps:: Assigning a time to a tree entry | |
207 * Creating timestamps:: Commands which insert timestamps | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
208 * Deadlines and scheduling:: Planning your work |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
209 * Progress logging:: Documenting when what work was done. |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
210 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
211 Creating timestamps |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
212 |
74030 | 213 * The date/time prompt:: How org-mode helps you entering date and time |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
214 * Custom time format:: Making dates look differently |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
215 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
216 Deadlines and Scheduling |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
217 |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
218 * Inserting deadline/schedule:: Planning items |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
219 * Repeated tasks:: Items that show up again and again |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
220 |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
221 Progress Logging |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
222 |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
223 * Closing items:: When was this entry marked DONE? |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
224 * Tracking TODO state changes:: When did the status change? |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
225 * Clocking work time:: When exactly did you work on this item? |
58792 | 226 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
227 Agenda Views |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
228 |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
229 * Agenda files:: Files being searched for agenda information |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
230 * Agenda dispatcher:: Keyboard access to agenda views |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
231 * Built-in agenda views:: What is available out of the box? |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
232 * Presentation and sorting:: How agenda items are prepared for display |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
233 * Agenda commands:: Remote editing of org trees |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
234 * Custom agenda views:: Defining special searches and views |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
235 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
236 The built-in agenda views |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
237 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
238 * 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
|
239 * Global TODO list:: All unfinished action items |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
240 * Matching tags and properties:: Structured information with fine-tuned search |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
241 * Timeline:: Time-sorted view for single file |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
242 * Stuck projects:: Find projects you need to review |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
243 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
244 Presentation and sorting |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
245 |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
246 * Categories:: Not all tasks are equal |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
247 * 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
|
248 * Sorting of agenda items:: The order of things |
58792 | 249 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
250 Custom agenda views |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
251 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
252 * 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
|
253 * 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
|
254 * Setting Options:: Changing the rules |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
255 * Exporting Agenda Views:: Writing agendas to files. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
256 * Extracting Agenda Information for other programs:: |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
257 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
258 Embedded LaTeX |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
259 |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
260 * 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
|
261 * Subscripts and Superscripts:: Simple syntax for raising/lowering text |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
262 * LaTeX fragments:: Complex formulas made easy |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
263 * Processing LaTeX fragments:: Previewing LaTeX processing |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
264 * CDLaTeX mode:: Speed up entering of formulas |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
265 |
58792 | 266 Exporting |
267 | |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
268 * ASCII export:: Exporting to plain ASCII |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
269 * HTML export:: Exporting to HTML |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
270 * LaTeX export:: Exporting to LaTeX |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
271 * XOXO export:: Exporting to XOXO |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
272 * iCalendar export:: Exporting in iCalendar format |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
273 * 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
|
274 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
275 HTML export |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
276 |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
277 * HTML Export commands:: How to invoke LaTeX export |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
278 * Quoting HTML tags:: Using direct HTML in Org-mode |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
279 * Links:: Transformation of links for HTML |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
280 * Images:: How to include images |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
281 * CSS support:: Changing the appearence of the output |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
282 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
283 LaTeX export |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
284 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
285 * LaTeX export commands:: How to invoke LaTeX export |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
286 * Quoting LaTeX code:: Incorporating literal LaTeX code |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
287 |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
288 Text interpretation by the exporter |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
289 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
290 * Comment lines:: Some lines will not be exported |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
291 * Initial text:: Text before the first headline |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
292 * Footnotes:: Numbers like [1] |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
293 * Enhancing text:: Subscripts, symbols and more |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
294 * Export options:: How to influence the export settings |
58792 | 295 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
296 Publishing |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
297 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
298 * Configuration:: Defining projects |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
299 * Sample configuration:: Example projects |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
300 * Triggering publication:: Publication commands |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
301 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
302 Configuration |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
303 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
304 * Project alist:: The central configuration variable |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
305 * 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
|
306 * 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
|
307 * 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
|
308 * Publishing options:: Tweaking HTML export |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
309 * 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
|
310 * 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
|
311 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
312 Sample configuration |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
313 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
314 * Simple example:: One-component publishing |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
315 * 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
|
316 |
58792 | 317 Miscellaneous |
318 | |
319 * Completion:: M-TAB knows what you need | |
320 * Customization:: Adapting Org-mode to your taste | |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
321 * 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
|
322 * 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
|
323 * 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
|
324 * TTY keys:: Using Org-mode on a tty |
58792 | 325 * Interaction:: Other Emacs packages |
63362 | 326 * Bugs:: Things which do not work perfectly |
58792 | 327 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
328 Interaction with other packages |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
329 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
330 * Cooperation:: Packages Org-mode cooperates with |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
331 * Conflicts:: Packages that lead to conflicts |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
332 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
333 Extensions, Hooks and Hacking |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
334 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
335 * Extensions:: Existing 3rd-part extensions |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
336 * Adding hyperlink types:: New custom link types |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
337 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
338 * Dynamic blocks:: Automatically filled blocks |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
339 * Special agenda views:: Customized views |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
340 * Using the property API:: Writing programs that use entry properties |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
341 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
342 Tables in arbitrary syntax |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
343 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
344 * Radio tables:: Sending and receiving |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
345 * A LaTeX example:: Step by step, almost a tutorial |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
346 * Translator functions:: Copy and modify |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
347 |
58792 | 348 @end detailmenu |
349 @end menu | |
350 | |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
351 @node Introduction, Document structure, Top, Top |
58792 | 352 @chapter Introduction |
353 @cindex introduction | |
354 | |
355 @menu | |
356 * 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
|
357 * 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
|
358 * Activation:: How to activate Org-mode for certain buffers. |
64517 | 359 * Feedback:: Bug reports, ideas, patches etc. |
58792 | 360 @end menu |
361 | |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
362 @node Summary, Installation, Introduction, Introduction |
58792 | 363 @section Summary |
364 @cindex summary | |
365 | |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
366 Org-mode is a mode for keeping notes, maintaining TODO lists, and doing |
58792 | 367 project planning with a fast and effective plain-text system. |
368 | |
369 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
|
370 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
|
371 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
|
372 content of large files well structured. Visibility cycling and |
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
373 structure editing help to work with the tree. Tables are easily created |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
374 with a built-in table editor. Org-mode supports TODO items, deadlines, |
73967
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
375 time stamps, and scheduling. It dynamically compiles entries into an |
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
376 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
|
377 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
|
378 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
|
379 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
|
380 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
|
381 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
|
382 linked webpages. |
58792 | 383 |
73967
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
384 An important design aspect that distinguishes Org-mode from for example |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
385 Planner/Muse is that it encourages to store every piece of information |
73967
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
386 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
|
387 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
|
388 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
|
389 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
|
390 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
|
391 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
|
392 |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
393 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
|
394 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
|
395 imposed, but a large amount of functionality is available when you need |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
396 it. Org-mode is a toolbox and can be used in different ways, for |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
397 example as: |
58792 | 398 |
399 @example | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
400 @r{@bullet{} outline extension with visibility cycling and structure editing} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
401 @r{@bullet{} ASCII system and table editor for taking structured notes} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
402 @r{@bullet{} ASCII table editor with spreadsheet-like capabilities} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
403 @r{@bullet{} TODO list editor} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
404 @r{@bullet{} full agenda and planner with deadlines and work scheduling} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
405 @r{@bullet{} environment to implement David Allen's GTD system} |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
406 @r{@bullet{} a basic database application} |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
407 @r{@bullet{} simple hypertext system, with HTML export} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
408 @r{@bullet{} publishing tool to create a set of interlinked webpages} |
58792 | 409 @end example |
410 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
411 Org-mode's automatic, context sensitive table editor with spreadsheet |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
412 capabilities can be integrated into any major mode by activating the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
413 minor Orgtbl-mode. Using a translation step, it can be used to maintain |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
414 tables in arbitrary file types, for example in La@TeX{}. The structure |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
415 editing and list creation capabilities can be used outside Org-mode with |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
416 the minor Orgstruct-mode. |
59541 | 417 |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
418 @cindex FAQ |
59541 | 419 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
|
420 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
|
421 questions (FAQ), links to tutorials etc. This page is located at |
59541 | 422 @uref{http://www.astro.uva.nl/~dominik/Tools/org/}. |
423 | |
424 @page | |
425 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
426 |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
427 @node Installation, Activation, Summary, Introduction |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
428 @section Installation |
58792 | 429 @cindex installation |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
430 @cindex XEmacs |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
431 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
432 @b{Important:} @i{If Org-mode is part of the Emacs distribution or an |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
433 XEmacs package, please skip this section and go directly to |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
434 @ref{Activation}.} |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
435 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
436 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
|
437 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
|
438 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
|
439 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
|
440 @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
|
441 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
|
442 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
|
443 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
|
444 the following line to @file{.emacs}: |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
445 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
446 @example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
447 (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
|
448 @end example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
449 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
450 @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
|
451 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
|
452 command:} |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
453 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
454 @example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
455 @b{make install-noutline} |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
456 @end example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
457 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
458 @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
|
459 commands: |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
460 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
461 @example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
462 make |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
463 make install |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
464 @end example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
465 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
466 @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
|
467 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
468 @example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
469 make install-info |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
470 @end example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
471 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
472 @noindent Then add to @file{.emacs}: |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
473 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
474 @lisp |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
475 ;; 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
|
476 (require 'org-install) |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
477 @end lisp |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
478 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
479 @node Activation, Feedback, Installation, Introduction |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
480 @section Activation |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
481 @cindex activation |
58792 | 482 @cindex autoload |
483 @cindex global keybindings | |
484 @cindex keybindings, global | |
485 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
486 @iftex |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
487 @b{Important:} @i{If you use copy-and-paste to copy lisp code from the |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
488 PDF documentation as viewed by Acrobat reader to your .emacs file, the |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
489 single quote character comes out incorrectly and the code will not work. |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
490 You need to fix the single quotes by hand, or copy from Info |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
491 documentation.} |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
492 @end iftex |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
493 |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
494 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
|
495 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
|
496 @command{org-agenda} - please choose suitable keys yourself. |
58792 | 497 |
62548 | 498 @lisp |
499 ;; The following lines are always needed. Choose your own keys. | |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
500 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode)) |
62548 | 501 (define-key global-map "\C-cl" 'org-store-link) |
502 (define-key global-map "\C-ca" 'org-agenda) | |
503 @end lisp | |
58792 | 504 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
505 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
|
506 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
|
507 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
|
508 (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
|
509 @lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
510 (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
|
511 (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
|
512 @end lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
513 |
58792 | 514 @cindex org-mode, turning on |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
515 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
|
516 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
|
517 like this: |
58792 | 518 |
519 @example | |
520 MY PROJECTS -*- mode: org; -*- | |
521 @end example | |
522 | |
523 @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
|
524 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
|
525 @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
|
526 |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
527 @node Feedback, , Activation, Introduction |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
528 @section Feedback |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
529 @cindex feedback |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
530 @cindex bug reports |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
531 @cindex maintainer |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
532 @cindex author |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
533 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
534 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
|
535 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
|
536 @value{MAINTAINEREMAIL}. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
537 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
538 For bug reports, please provide as much information as possible, |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
539 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
|
540 @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
|
541 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
|
542 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
|
543 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
|
544 |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
545 @enumerate |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
546 @item What exactly did you do? |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
547 @item What did you expect to happen? |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
548 @item What happened instead? |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
549 @end enumerate |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
550 @noindent Thank you for helping to improve this mode. |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
551 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
552 @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
|
553 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
554 @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
|
555 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
|
556 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
|
557 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
|
558 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
|
559 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
|
560 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
561 @enumerate |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
562 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
563 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
|
564 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
|
565 @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
|
566 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
|
567 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
|
568 @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
|
569 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
570 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
|
571 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
572 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
573 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
|
574 (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
|
575 @item |
73967
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
576 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
|
577 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
|
578 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
579 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
|
580 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
|
581 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
|
582 @end enumerate |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
583 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
584 @node Document structure, Tables, Introduction, Top |
58792 | 585 @chapter Document Structure |
586 @cindex document structure | |
587 @cindex structure of document | |
588 | |
589 Org-mode is based on outline mode and provides flexible commands to | |
590 edit the structure of the document. | |
591 | |
592 @menu | |
593 * Outlines:: Org-mode is based on outline-mode | |
594 * Headlines:: How to typeset org-tree headlines | |
65656 | 595 * Visibility cycling:: Show and hide, much simplified |
58792 | 596 * Motion:: Jumping to other headlines |
597 * Structure editing:: Changing sequence and level of headlines | |
63362 | 598 * Archiving:: Move done task trees to a different place |
58792 | 599 * 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
|
600 * Plain lists:: Additional structure within an entry |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
601 * Drawers:: Tucking stuff away |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
602 * orgstruct-mode:: Structure editing outside Org-mode |
58792 | 603 @end menu |
604 | |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
605 @node Outlines, Headlines, Document structure, Document structure |
58792 | 606 @section Outlines |
607 @cindex outlines | |
608 @cindex outline-mode | |
609 | |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
610 Org-mode is implemented on top of outline-mode. Outlines allow a |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
611 document to be organized in a hierarchical structure, which (at least |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
612 for me) is the best representation of notes and thoughts. An overview |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
613 of this structure is achieved by folding (hiding) large parts of the |
58792 | 614 document to show only the general document structure and the parts |
615 currently being worked on. Org-mode greatly simplifies the use of | |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
616 outlines by compressing the entire show/hide functionality into a single |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
617 command @command{org-cycle}, which is bound to the @key{TAB} key. |
58792 | 618 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
619 @node Headlines, Visibility cycling, Outlines, Document structure |
58792 | 620 @section Headlines |
621 @cindex headlines | |
622 @cindex outline tree | |
623 | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
624 Headlines define the structure of an outline tree. The headlines in |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
625 Org-mode start with one or more stars, on the left margin@footnote{See |
81838
09c82a1bcb6f
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81789
diff
changeset
|
626 the variable @code{org-special-ctrl-a/e} to configure special behavior |
09c82a1bcb6f
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81789
diff
changeset
|
627 of @kbd{C-a} and @kbd{C-e} in headlines.}. For example: |
58792 | 628 |
629 @example | |
630 * Top level headline | |
631 ** Second level | |
632 *** 3rd level | |
633 some text | |
634 *** 3rd level | |
635 more text | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
636 |
58792 | 637 * Another top level headline |
638 @end example | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
639 |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
640 @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
|
641 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
|
642 starters. @ref{Clean view} describes a setup to realize this. |
58792 | 643 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
644 An empty line after the end of a subtree is considered part of it and |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
645 will be hidden when the subtree is folded. However, if you leave at |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
646 least two empty lines, one empty line will remain visible after folding |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
647 the subtree, in order to structure the collapsed view. See the |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
648 variable @code{org-cycle-separator-lines} to modify this behavior. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
649 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
650 @node Visibility cycling, Motion, Headlines, Document structure |
58792 | 651 @section Visibility cycling |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
652 @cindex cycling, visibility |
58792 | 653 @cindex visibility cycling |
654 @cindex trees, visibility | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
655 @cindex show hidden text |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
656 @cindex hide text |
58792 | 657 |
658 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
|
659 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
|
660 @kbd{S-@key{TAB}} to change the visibility in the buffer. |
58792 | 661 |
662 @cindex subtree visibility states | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
663 @cindex subtree cycling |
58792 | 664 @cindex folded, subtree visibility state |
665 @cindex children, subtree visibility state | |
666 @cindex subtree, subtree visibility state | |
667 @table @kbd | |
668 @kindex @key{TAB} | |
669 @item @key{TAB} | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
670 @emph{Subtree cycling}: Rotate current subtree among the states |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
671 |
58792 | 672 @example |
673 ,-> FOLDED -> CHILDREN -> SUBTREE --. | |
674 '-----------------------------------' | |
675 @end example | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
676 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
677 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
|
678 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
|
679 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
|
680 @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
|
681 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
|
682 argument (@kbd{C-u @key{TAB}}), global cycling is invoked. |
58792 | 683 |
684 @cindex global visibility states | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
685 @cindex global cycling |
58792 | 686 @cindex overview, global visibility state |
687 @cindex contents, global visibility state | |
688 @cindex show all, global visibility state | |
689 @kindex S-@key{TAB} | |
690 @item S-@key{TAB} | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
691 @itemx C-u @key{TAB} |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
692 @emph{Global cycling}: Rotate the entire buffer among the states |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
693 |
58792 | 694 @example |
695 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --. | |
696 '--------------------------------------' | |
697 @end example | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
698 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
699 When @kbd{S-@key{TAB}} is called with a numerical prefix N, the CONTENTS |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
700 view up to headlines of level N will be shown. |
58792 | 701 Note that inside tables, @kbd{S-@key{TAB}} jumps to the previous field. |
702 | |
703 @cindex show all, command | |
704 @kindex C-c C-a | |
705 @item C-c C-a | |
706 Show all. | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
707 @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
|
708 @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
|
709 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
|
710 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
|
711 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
712 command (@pxref{Agenda commands}). With prefix arg show, on each |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
713 level, all sibling headings. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
714 @kindex C-c C-x b |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
715 @item C-c C-x b |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
716 Show the current subtree in an indirect buffer@footnote{The indirect |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
717 buffer |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
718 @ifinfo |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
719 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual}) |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
720 @end ifinfo |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
721 @ifnotinfo |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
722 (see the Emacs manual for more information about indirect buffers) |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
723 @end ifnotinfo |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
724 will contain the entire buffer, but will be narrowed to the current |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
725 tree. Editing the indirect buffer will also change the original buffer, |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
726 but without affecting visibility in that buffer.}. With numerical |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
727 prefix ARG, go up to this level and then take that tree. If ARG is |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
728 negative, go up that many levels. With @kbd{C-u} prefix, do not remove |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
729 the previously used indirect buffer. |
58792 | 730 @end table |
731 | |
63833 | 732 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
|
733 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
|
734 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
|
735 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
|
736 buffer: |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
737 |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
738 @example |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
739 #+STARTUP: overview |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
740 #+STARTUP: content |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
741 #+STARTUP: showall |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
742 @end example |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
743 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
744 @node Motion, Structure editing, Visibility cycling, Document structure |
58792 | 745 @section Motion |
746 @cindex motion, between headlines | |
747 @cindex jumping, to headlines | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
748 @cindex headline navigation |
58792 | 749 The following commands jump to other headlines in the buffer. |
750 | |
751 @table @kbd | |
752 @kindex C-c C-n | |
753 @item C-c C-n | |
754 Next heading. | |
755 @kindex C-c C-p | |
756 @item C-c C-p | |
757 Previous heading. | |
758 @kindex C-c C-f | |
759 @item C-c C-f | |
760 Next heading same level. | |
761 @kindex C-c C-b | |
762 @item C-c C-b | |
763 Previous heading same level. | |
764 @kindex C-c C-u | |
765 @item C-c C-u | |
766 Backward to higher level heading. | |
767 @kindex C-c C-j | |
768 @item C-c C-j | |
769 Jump to a different place without changing the current outline | |
770 visibility. Shows the document structure in a temporary buffer, where | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
771 you can use the following keys to find your destination: |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
772 @example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
773 @key{TAB} @r{Cycle visibility.} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
774 @key{down} / @key{up} @r{Next/previous visible headline.} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
775 n / p @r{Next/previous visible headline.} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
776 f / b @r{Next/previous headline same level.} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
777 u @r{One level up.} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
778 0-9 @r{Digit argument.} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
779 @key{RET} @r{Select this location.} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
780 @end example |
58792 | 781 @end table |
782 | |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
783 @node Structure editing, Archiving, Motion, Document structure |
58792 | 784 @section Structure editing |
785 @cindex structure editing | |
786 @cindex headline, promotion and demotion | |
787 @cindex promotion, of subtrees | |
788 @cindex demotion, of subtrees | |
789 @cindex subtree, cut and paste | |
63833 | 790 @cindex pasting, of subtrees |
791 @cindex cutting, of subtrees | |
792 @cindex copying, of subtrees | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
793 @cindex subtrees, cut and paste |
58792 | 794 |
795 @table @kbd | |
796 @kindex M-@key{RET} | |
797 @item M-@key{RET} | |
67382
62adeda8b0dd
Structure editing): DOcument new fucntionality of
Carsten Dominik <dominik@science.uva.nl>
parents:
67353
diff
changeset
|
798 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
|
799 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
|
800 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
|
801 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
|
802 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
|
803 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
|
804 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
|
805 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
|
806 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
|
807 (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
|
808 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
|
809 @kindex M-S-@key{RET} |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
810 @item M-S-@key{RET} |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
811 Insert new TODO entry with same level as current heading. |
58792 | 812 @kindex M-@key{left} |
813 @item M-@key{left} | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
814 Promote current heading by one level. |
58792 | 815 @kindex M-@key{right} |
816 @item M-@key{right} | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
817 Demote current heading by one level. |
58792 | 818 @kindex M-S-@key{left} |
819 @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
|
820 Promote the current subtree by one level. |
58792 | 821 @kindex M-S-@key{right} |
822 @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
|
823 Demote the current subtree by one level. |
58792 | 824 @kindex M-S-@key{up} |
825 @item M-S-@key{up} | |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
826 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
|
827 level). |
58792 | 828 @kindex M-S-@key{down} |
829 @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
|
830 Move subtree down (swap with next subtree of same level). |
65656 | 831 @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
|
832 @kindex C-c C-x C-k |
65656 | 833 @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
|
834 @itemx C-c C-x C-k |
58792 | 835 Kill subtree, i.e. remove it from buffer but save in kill ring. |
65656 | 836 @kindex C-c C-x M-w |
837 @item C-c C-x M-w | |
58792 | 838 Copy subtree to kill ring. |
65656 | 839 @kindex C-c C-x C-y |
840 @item C-c C-x C-y | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
841 Yank subtree from kill ring. This does modify the level of the subtree to |
58792 | 842 make sure the tree fits in nicely at the yank position. The yank |
843 level can also be specified with a prefix arg, or by yanking after a | |
844 headline marker like @samp{****}. | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
845 @kindex C-c ^ |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
846 @item C-c ^ |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
847 Sort same-level entries. When there is an active region, all entries in |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
848 the region will be sorted. Otherwise the children of the current |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
849 headline are sorted. The command prompts for the sorting method, which |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
850 can be alphabetically, numerically, by time (using the first time stamp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
851 in each entry), and each of these in reverse order. With a @kbd{C-u} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
852 prefix, sorting will be case-sensitive. With two @kbd{C-u C-u} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
853 prefixes, duplicate entries will also be removed. |
58792 | 854 @end table |
855 | |
856 @cindex region, active | |
857 @cindex active region | |
858 @cindex transient-mark-mode | |
859 When there is an active region (transient-mark-mode), promotion and | |
860 demotion work on all headlines in the region. To select a region of | |
861 headlines, it is best to place both point and mark at the beginning of a | |
862 line, mark at the beginning of the first headline, and point at the line | |
863 just after the last headline to change. Note that when the cursor is | |
864 inside a table (@pxref{Tables}), the Meta-Cursor keys have different | |
865 functionality. | |
866 | |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
867 @node Archiving, Sparse trees, Structure editing, Document structure |
63362 | 868 @section Archiving |
869 @cindex archiving | |
870 | |
63833 | 871 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
|
872 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
|
873 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
|
874 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
|
875 location. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
876 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
877 @menu |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
878 * ARCHIVE tag:: Marking a tree as inactive |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
879 * Moving subtrees:: Moving a tree to an archive file |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
880 @end menu |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
881 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
882 @node ARCHIVE tag, Moving subtrees, Archiving, Archiving |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
883 @subsection The ARCHIVE tag |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
884 @cindex internal archiving |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
885 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
886 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
|
887 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
|
888 @itemize @minus |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
889 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
890 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
|
891 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
|
892 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
|
893 @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
|
894 @code{show-all} will open archived subtrees. |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
895 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
896 During sparse tree construction (@pxref{Sparse trees}), matches in |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
897 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
|
898 @code{org-sparse-tree-open-archived-trees}. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
899 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
900 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
|
901 archived trees is ignored unless you configure the option |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
902 @code{org-agenda-skip-archived-trees}. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
903 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
904 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
|
905 is. Configure the details using the variable |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
906 @code{org-export-with-archived-trees}. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
907 @end itemize |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
908 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
909 The following commands help managing the ARCHIVE tag: |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
910 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
911 @table @kbd |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
912 @kindex C-c C-x C-a |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
913 @item C-c C-x C-a |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
914 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
|
915 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
|
916 hidden. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
917 @kindex C-u C-c C-x C-a |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
918 @item C-u C-c C-x C-a |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
919 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
|
920 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
|
921 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
|
922 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
|
923 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
|
924 @kindex C-@kbd{TAB} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
925 @item C-@kbd{TAB} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
926 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
|
927 @end table |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
928 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
929 @node Moving subtrees, , ARCHIVE tag, Archiving |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
930 @subsection Moving subtrees |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
931 @cindex external archiving |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
932 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
933 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
|
934 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
|
935 file, the archive file. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
936 |
63362 | 937 @table @kbd |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
938 @kindex C-c C-x C-s |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
939 @item C-c C-x C-s |
63362 | 940 Archive the subtree starting at the cursor position to the location |
941 given by @code{org-archive-location}. | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
942 @kindex C-u C-c C-x C-s |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
943 @item C-u C-c C-x C-s |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
944 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
|
945 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
|
946 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
|
947 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
|
948 is invoked, the level 1 trees will be checked. |
63362 | 949 @end table |
950 | |
951 @cindex archive locations | |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
952 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
|
953 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
|
954 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
|
955 see the documentation string of the variable |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
956 @code{org-archive-location}. There is also an in-buffer option for |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
957 setting this variable, for example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
958 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
959 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
960 #+ARCHIVE: %s_done:: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
961 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
962 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
963 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
964 You may have several such lines in the buffer, they will then be valid |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
965 for the entries following the line (the first will also apply to any |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
966 text before it). |
63362 | 967 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
968 @node Sparse trees, Plain lists, Archiving, Document structure |
58792 | 969 @section Sparse trees |
970 @cindex sparse trees | |
971 @cindex trees, sparse | |
972 @cindex folding, sparse trees | |
973 @cindex occur, command | |
974 | |
975 An important feature of Org-mode is the ability to construct | |
976 @emph{sparse trees} for selected information in an outline tree. A | |
977 sparse tree means that the entire document is folded as much as | |
978 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
|
979 headline structure above it@footnote{See also the variables |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
980 @code{org-show-hierarchy-above}, @code{org-show-following-heading}, and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
981 @code{org-show-siblings} for detailed control on how much context is |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
982 shown around each match.}. Just try it out and you will see immediately |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
983 how it works. |
58792 | 984 |
985 Org-mode contains several commands creating such trees. The most | |
986 basic one is @command{org-occur}: | |
987 | |
988 @table @kbd | |
989 @kindex C-c / | |
990 @item C-c / | |
991 Occur. Prompts for a regexp and shows a sparse tree with all matches. | |
992 If the match is in a headline, the headline is made visible. If the | |
993 match is in the body of an entry, headline and body are made visible. | |
994 In order to provide minimal context, also the full hierarchy of | |
995 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
|
996 the match. Each match is also highlighted; the highlights disappear |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
997 when the buffer is changed an editing command, or by pressing @kbd{C-c |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
998 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
|
999 are kept, so several calls to this command can be stacked. |
58792 | 1000 @end table |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
1001 @noindent |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
1002 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
|
1003 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
|
1004 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
|
1005 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
|
1006 For example: |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1007 |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
1008 @lisp |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
1009 (setq org-agenda-custom-commands |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
1010 '(("f" occur-tree "FIXME"))) |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
1011 @end lisp |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1012 |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
1013 @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
|
1014 a sparse tree matching the string @samp{FIXME}. |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
1015 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1016 Other commands use sparse trees as well. For example @kbd{C-c |
58792 | 1017 C-v} creates a sparse TODO tree (@pxref{TODO basics}). |
1018 | |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
1019 @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
|
1020 @cindex printing sparse trees |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
1021 @cindex visible text, printing |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
1022 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
|
1023 @code{ps-print-buffer-with-faces} which does not print invisible parts |
63833 | 1024 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
|
1025 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
|
1026 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
|
1027 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
|
1028 |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1029 @node Plain lists, Drawers, 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
|
1030 @section Plain lists |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1031 @cindex plain lists |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1032 @cindex lists, plain |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1033 @cindex lists, ordered |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1034 @cindex ordered lists |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1035 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1036 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
|
1037 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
|
1038 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
|
1039 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
|
1040 |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
1041 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
|
1042 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
|
1043 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
|
1044 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
|
1045 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
|
1046 indistinguishable from true headlines. In short: even though @samp{*} |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1047 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
|
1048 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
|
1049 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
|
1050 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
|
1051 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
|
1052 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
|
1053 ends before the next line that is indented like the bullet/number, or |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1054 less. Empty lines are part of the previous item, so you can have |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1055 several paragraphs in one item. If you would like an empty line to |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1056 terminate all currently open plain lists, configure the variable |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1057 @code{org-empty-line-terminates-plain-lists}. Here is an example: |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1058 |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1059 @example |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
1060 @group |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1061 ** 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
|
1062 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
|
1063 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
|
1064 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
|
1065 + 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
|
1066 + 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
|
1067 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
|
1068 - on DVD only |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1069 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
|
1070 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
|
1071 @end group |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1072 @end example |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1073 |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
1074 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
|
1075 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
|
1076 settings for Emacs. For XEmacs, you should use Kyle E. Jones' |
74030 | 1077 @file{filladapt.el}. To turn this on, put into @file{.emacs}: |
81465
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
1078 @code{(require 'filladapt)}}. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1079 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1080 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
|
1081 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
|
1082 |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1083 @table @kbd |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1084 @kindex @key{TAB} |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1085 @item @key{TAB} |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
1086 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
|
1087 @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
|
1088 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
|
1089 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
|
1090 completely separated. |
81465
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
1091 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
1092 If @code{org-cycle-include-plain-lists} has not been set, @key{TAB} |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
1093 fixes the indentation of the curent line in a heuristic way. |
67382
62adeda8b0dd
Structure editing): DOcument new fucntionality of
Carsten Dominik <dominik@science.uva.nl>
parents:
67353
diff
changeset
|
1094 @kindex M-@key{RET} |
62adeda8b0dd
Structure editing): DOcument new fucntionality of
Carsten Dominik <dominik@science.uva.nl>
parents:
67353
diff
changeset
|
1095 @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
|
1096 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
|
1097 (@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
|
1098 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
|
1099 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
|
1100 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
|
1101 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
|
1102 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
|
1103 current line. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1104 @kindex M-S-@key{RET} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1105 @item M-S-@key{RET} |
71525
f3876738c127
(Checkboxes): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71508
diff
changeset
|
1106 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
|
1107 @kindex S-@key{up} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1108 @kindex S-@key{down} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1109 @item S-@key{up} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1110 @itemx S-@key{down} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1111 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
|
1112 @kindex M-S-@key{up} |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1113 @kindex M-S-@key{down} |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1114 @item M-S-@key{up} |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1115 @itemx M-S-@key{down} |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1116 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
|
1117 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
|
1118 automatic. |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1119 @kindex M-S-@key{left} |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1120 @kindex M-S-@key{right} |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1121 @item M-S-@key{left} |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1122 @itemx M-S-@key{right} |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1123 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
|
1124 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
|
1125 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
|
1126 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
|
1127 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
|
1128 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
|
1129 @kindex C-c C-c |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1130 @item C-c C-c |
71525
f3876738c127
(Checkboxes): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71508
diff
changeset
|
1131 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the |
81465
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
1132 state of the checkbox. If not, make this command makes sure that all |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
1133 the items on this list level use the same bullet. Furthermore, if this |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
1134 is an ordered list, make sure the numbering is ok. |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1135 @kindex C-c - |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1136 @item C-c - |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1137 Cycle the entire list level through the different itemize/enumerate |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1138 bullets (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}). |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1139 With prefix arg, select the nth bullet from this list. |
67107
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1140 @end table |
a0a8d49729fd
(Structure editing): New item moving commands added.
Carsten Dominik <dominik@science.uva.nl>
parents:
66988
diff
changeset
|
1141 |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1142 @node Drawers, orgstruct-mode, Plain lists, Document structure |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1143 @section Drawers |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1144 @cindex drawers |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1145 @cindex visibility cycling, drawers |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1146 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1147 Sometimes you want to keep information associated with an entry, but you |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1148 normally don't want to see it. For this, Org-mode has @emph{drawers}. |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1149 Drawers need to be configured with the variable @code{org-drawers}, and |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1150 look like this: |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1151 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1152 @example |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1153 ** This is a headline |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1154 Still outside the drawer |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1155 :DRAWERNAME: |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1156 This is inside the drawer. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1157 :END: |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1158 After the drawer. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1159 @end example |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1160 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1161 Visibility cycling (@pxref{Visibility cycling}) on the headline will |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1162 hide and show the entry, but keep the drawer collapsed to a single line. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1163 In order to look inside the drawer, you need to move the cursor to the |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1164 drawer line and press @key{TAB} there. Org-mode uses a drawer for |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1165 storing properties (@pxref{Properties and columns}). |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1166 |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1167 @node orgstruct-mode, , Drawers, Document structure |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1168 @section The Orgstruct minor mode |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1169 @cindex orgstruct-mode |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1170 @cindex minor mode for structure editing |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1171 |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1172 If you like the intuitive way the Org-mode structure editing and list |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1173 formatting works, you might want to use these commands in other modes |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1174 like text-mode or mail-mode as well. The minor mode Orgstruct-mode |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1175 makes this possible. You can always toggle the mode with @kbd{M-x |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1176 orgstruct-mode}. To turn it on by default, for example in mail mode, |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1177 use |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1178 |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1179 @lisp |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1180 (add-hook 'mail-mode-hook 'turn-on-orgstruct) |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1181 @end lisp |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1182 |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1183 When this mode is active and the cursor is on a line that looks to |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1184 Org-mode like a headline of the first line of a list item, most |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1185 structure editing commands will work, even if the same keys normally |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1186 have different functionality in the major mode you are using. If the |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1187 cursor is not in one of those special lines, Orgstruct-mode lurks |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1188 silently in the shadow. |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1189 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
1190 @node Tables, Hyperlinks, Document structure, Top |
58792 | 1191 @chapter Tables |
1192 @cindex tables | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1193 @cindex editing tables |
58792 | 1194 |
63833 | 1195 Org-mode has a very fast and intuitive table editor built-in. |
1196 Spreadsheet-like calculations are supported in connection with the | |
1197 Emacs @file{calc} package. | |
58792 | 1198 |
1199 @menu | |
1200 * 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
|
1201 * Narrow columns:: Stop wasting space in tables |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1202 * Column groups:: Grouping to trigger vertical lines |
63833 | 1203 * orgtbl-mode:: The table editor as minor mode |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1204 * The spreadsheet:: The table editor has spreadsheet capabilities. |
58792 | 1205 @end menu |
1206 | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1207 @node Built-in table editor, Narrow columns, Tables, Tables |
58792 | 1208 @section The built-in table editor |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1209 @cindex table editor, built-in |
58792 | 1210 |
1211 Org-mode makes it easy to format tables in plain ASCII. Any line with | |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
1212 @samp{|} as the first non-whitespace character is considered part of a |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
1213 table. @samp{|} is also the column separator. A table might look like |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
1214 this: |
58792 | 1215 |
1216 @example | |
1217 | Name | Phone | Age | | |
1218 |-------+-------+-----| | |
1219 | Peter | 1234 | 17 | | |
1220 | Anna | 4321 | 25 | | |
1221 @end example | |
1222 | |
1223 A table is re-aligned automatically each time you press @key{TAB} or | |
63833 | 1224 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to |
1225 the next field (@key{RET} to the next row) and creates new table rows | |
1226 at the end of the table or before horizontal lines. The indentation | |
1227 of the table is set by the first line. Any line starting with | |
1228 @samp{|-} is considered as a horizontal separator line and will be | |
1229 expanded on the next re-align to span the whole table width. So, to | |
1230 create the above table, you would only type | |
58792 | 1231 |
1232 @example | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
1233 |Name|Phone|Age| |
58792 | 1234 |- |
1235 @end example | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1236 |
58792 | 1237 @noindent and then press @key{TAB} to align the table and start filling in |
1238 fields. | |
1239 | |
65656 | 1240 When typing text into a field, Org-mode treats @key{DEL}, |
1241 @key{Backspace}, and all character keys in a special way, so that | |
1242 inserting and deleting avoids shifting other fields. Also, when | |
1243 typing @emph{immediately after the cursor was moved into a new field | |
1244 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the | |
1245 field is automatically made blank. If this behavior is too | |
1246 unpredictable for you, configure the variables | |
1247 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}. | |
1248 | |
58792 | 1249 @table @kbd |
1250 @tsubheading{Creation and conversion} | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1251 @kindex C-c | |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1252 @item C-c | |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1253 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
|
1254 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
|
1255 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
|
1256 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
|
1257 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
|
1258 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
|
1259 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
|
1260 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}. |
58792 | 1261 |
1262 @tsubheading{Re-aligning and field motion} | |
1263 @kindex C-c C-c | |
1264 @item C-c C-c | |
1265 Re-align the table without moving the cursor. | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1266 @c |
58792 | 1267 @kindex @key{TAB} |
1268 @item @key{TAB} | |
1269 Re-align the table, move to the next field. Creates a new row if | |
1270 necessary. | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1271 @c |
58792 | 1272 @kindex S-@key{TAB} |
1273 @item S-@key{TAB} | |
63833 | 1274 Re-align, move to previous field. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1275 @c |
58792 | 1276 @kindex @key{RET} |
1277 @item @key{RET} | |
1278 Re-align the table and move down to next row. Creates a new row if | |
1279 necessary. At the beginning or end of a line, @key{RET} still does | |
1280 NEWLINE, so it can be used to split a table. | |
1281 | |
1282 @tsubheading{Column and row editing} | |
1283 @kindex M-@key{left} | |
1284 @kindex M-@key{right} | |
1285 @item M-@key{left} | |
1286 @itemx M-@key{right} | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1287 Move the current column left/right. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1288 @c |
58792 | 1289 @kindex M-S-@key{left} |
1290 @item M-S-@key{left} | |
1291 Kill the current column. | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1292 @c |
58792 | 1293 @kindex M-S-@key{right} |
1294 @item M-S-@key{right} | |
1295 Insert a new column to the left of the cursor position. | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1296 @c |
58792 | 1297 @kindex M-@key{up} |
1298 @kindex M-@key{down} | |
1299 @item M-@key{up} | |
1300 @itemx M-@key{down} | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1301 Move the current row up/down. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1302 @c |
58792 | 1303 @kindex M-S-@key{up} |
1304 @item M-S-@key{up} | |
1305 Kill the current row or horizontal line. | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1306 @c |
58792 | 1307 @kindex M-S-@key{down} |
1308 @item M-S-@key{down} | |
1309 Insert a new row above (with arg: below) the current row. | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1310 @c |
58792 | 1311 @kindex C-c - |
1312 @item C-c - | |
63833 | 1313 Insert a horizontal line below current row. With prefix arg, the line |
1314 is created above the current line. | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1315 @c |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
1316 @kindex C-c ^ |
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
1317 @item C-c ^ |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1318 Sort the table lines in the region. The position of point indicates the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1319 column to be used for sorting, and the range of lines is the range |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1320 between the nearest horizontal separator lines, or the entire table. If |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1321 point is before the first column, you will be prompted for the sorting |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1322 column. If there is an active region, the mark specifies the first line |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1323 and the sorting column, while point should be in the last line to be |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1324 included into the sorting. The command prompts for the sorting type |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1325 (alphabetically, numerically, or by time). When called with a prefix |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1326 argument, alphabetic sorting will be case-sensitive. |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
1327 |
58792 | 1328 @tsubheading{Regions} |
65656 | 1329 @kindex C-c C-x M-w |
1330 @item C-c C-x M-w | |
63833 | 1331 Copy a rectangular region from a table to a special clipboard. Point |
58792 | 1332 and mark determine edge fields of the rectangle. The process ignores |
1333 horizontal separator lines. | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1334 @c |
65656 | 1335 @kindex C-c C-x C-w |
1336 @item C-c C-x C-w | |
63833 | 1337 Copy a rectangular region from a table to a special clipboard, and |
1338 blank all fields in the rectangle. So this is the ``cut'' operation. | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1339 @c |
65656 | 1340 @kindex C-c C-x C-y |
1341 @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
|
1342 Paste a rectangular region into a table. |
58792 | 1343 The upper right corner ends up in the current field. All involved fields |
1344 will be overwritten. If the rectangle does not fit into the present table, | |
1345 the table is enlarged as needed. The process ignores horizontal separator | |
1346 lines. | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1347 @c |
58792 | 1348 @kindex C-c C-q |
1349 @item C-c C-q | |
1350 Wrap several fields in a column like a paragraph. If there is an active | |
1351 region, and both point and mark are in the same column, the text in the | |
1352 column is wrapped to minimum width for the given number of lines. A | |
1353 prefix ARG may be used to change the number of desired lines. If there | |
1354 is no region, the current field is split at the cursor position and the | |
1355 text fragment to the right of the cursor is prepended to the field one | |
1356 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
|
1357 current field is made blank, and the content is appended to the field |
58792 | 1358 above. |
1359 | |
1360 @tsubheading{Calculations} | |
63833 | 1361 @cindex formula, in tables |
1362 @cindex calculations, in tables | |
58792 | 1363 @cindex region, active |
1364 @cindex active region | |
1365 @cindex transient-mark-mode | |
1366 @kindex C-c + | |
1367 @item C-c + | |
1368 Sum the numbers in the current column, or in the rectangle defined by | |
63833 | 1369 the active region. The result is shown in the echo area and can |
58792 | 1370 be inserted with @kbd{C-y}. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1371 @c |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
1372 @kindex S-@key{RET} |
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
1373 @item S-@key{RET} |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
1374 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
|
1375 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
|
1376 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
|
1377 @code{org-table-copy-increment}, integer field values will be |
63362 | 1378 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
|
1379 (@pxref{Cooperation}). |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
1380 |
58792 | 1381 @tsubheading{Miscellaneous} |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1382 @kindex C-c ` |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1383 @item C-c ` |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1384 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
|
1385 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
|
1386 @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
|
1387 edited in place. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1388 @c |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1389 @kindex C-c @key{TAB} |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1390 @item C-c @key{TAB} |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1391 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
|
1392 visible. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1393 @c |
58792 | 1394 @item M-x org-table-import |
1395 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
|
1396 separated. Useful, for example, to import an Excel table or data from a |
58792 | 1397 database, because these programs generally can write TAB-separated text |
1398 files. This command works by inserting the file into the buffer and | |
1399 then converting the region to a table. Any prefix argument is passed on | |
1400 to the converter, which uses it to determine the separator. | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1401 @item C-c | |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1402 Tables can also be imported by pasting tabular text into the org-mode |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1403 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1404 @kbd{C-c |} command (see above under @i{Creation and conversion}. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1405 @c |
58792 | 1406 @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
|
1407 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
|
1408 for example, Excel or database programs. |
58792 | 1409 @end table |
1410 | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1411 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
|
1412 way on lines which you would like to start with @samp{|}, you can turn |
58792 | 1413 it off with |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1414 |
58792 | 1415 @lisp |
1416 (setq org-enable-table-editor nil) | |
1417 @end lisp | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1418 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1419 @noindent Then the only table command that still works is |
58792 | 1420 @kbd{C-c C-c} to do a manual re-align. |
1421 | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1422 @node Narrow columns, Column groups, Built-in table editor, Tables |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1423 @section Narrow columns |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1424 @cindex narrow columns in tables |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1425 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1426 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
|
1427 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
|
1428 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
|
1429 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
|
1430 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
|
1431 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
|
1432 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
|
1433 value. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1434 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1435 @example |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1436 @group |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1437 |---+------------------------------| |---+--------| |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1438 | | | | | <6> | |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1439 | 1 | one | | 1 | one | |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1440 | 2 | two | ----\ | 2 | two | |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1441 | 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
|
1442 | 4 | four | | 4 | four | |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1443 |---+------------------------------| |---+--------| |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1444 @end group |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1445 @end example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1446 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1447 @noindent |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1448 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
|
1449 Note that the full text is still in the buffer, it is only invisible. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1450 To see the full text, hold the mouse over the field - a tool-tip window |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1451 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
|
1452 @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
|
1453 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
|
1454 C-c}. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1455 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1456 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
|
1457 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
|
1458 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
|
1459 @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
|
1460 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
|
1461 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
|
1462 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1463 @example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1464 #+STARTUP: align |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1465 #+STARTUP: noalign |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1466 @end example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1467 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1468 @node Column groups, orgtbl-mode, Narrow columns, Tables |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1469 @section Column groups |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1470 @cindex grouping columns in tables |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1471 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1472 When Org-mode exports tables, it does so by default without vertical |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1473 lines because that is visually more satisfying in general. Occasionally |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1474 however, vertical lines can be useful to structure a table into groups |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1475 of columns, much like horizontal lines can do for groups of rows. In |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1476 order to specify column groups, you can use a special row where the |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1477 first field contains only @samp{/}. The further fields can either |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1478 contain @samp{<} to indicate that this column should start a group, |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1479 @samp{>} to indicate the end of a column, or @samp{<>} to make a column |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1480 a group of its own. Boundaries between colum groups will upon export be |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1481 marked with vertical lines. Here is an example: |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1482 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1483 @example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1484 | | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) | |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1485 |---+----+-----+-----+-----+---------+------------| |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1486 | / | <> | < | | > | < | > | |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1487 | # | 1 | 1 | 1 | 1 | 1 | 1 | |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1488 | # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 | |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1489 | # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 | |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1490 |---+----+-----+-----+-----+---------+------------| |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1491 #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2)) |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1492 @end example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1493 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1494 It is also sufficient to just insert the colum group starters after |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1495 every vertical line you'd like to have: |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1496 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1497 @example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1498 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) | |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1499 |----+-----+-----+-----+---------+------------| |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1500 | / | < | | | < | | |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1501 @end example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1502 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1503 @node orgtbl-mode, The spreadsheet, Column groups, Tables |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1504 @section The Orgtbl minor mode |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1505 @cindex orgtbl-mode |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1506 @cindex minor mode for tables |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1507 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1508 If you like the intuitive way the Org-mode table editor works, you |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1509 might also want to use it in other modes like text-mode or mail-mode. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1510 The minor mode Orgtbl-mode makes this possible. You can always toggle |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1511 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1512 example in mail mode, use |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1513 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1514 @lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1515 (add-hook 'mail-mode-hook 'turn-on-orgtbl) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1516 @end lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1517 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1518 Furthermore, with some special setup, it is possible to maintain tables |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1519 in arbitrary syntax with Orgtbl-mode. For example, it is possible to |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
1520 construct La@TeX{} tables with the underlying ease and power of |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1521 Orgtbl-mode, including spreadsheet capabilities. For details, see |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1522 @ref{Tables in arbitrary syntax}. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1523 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1524 @node The spreadsheet, , orgtbl-mode, Tables |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1525 @section The spreadsheet |
63833 | 1526 @cindex calculations, in tables |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1527 @cindex spreadsheet capabilities |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1528 @cindex @file{calc} package |
63833 | 1529 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1530 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
|
1531 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1532 derive fields from other fields. While fully featured, Org-mode's |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1533 implementation is not identical to other spreadsheets. For example, |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1534 Org-mode knows the concept of a @emph{column formula} that will be |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1535 applied to all non-header fields in a column without having to copy the |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1536 formula to each relevant field. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1537 |
63833 | 1538 @menu |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1539 * References:: How to refer to another field or range |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1540 * Formula syntax for Calc:: Using Calc to compute stuff |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1541 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1542 * Field formulas:: Formulas valid for a single field |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1543 * Column formulas:: Formulas valid for an entire column |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1544 * Editing and debugging formulas:: Fixing formulas |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1545 * Updating the table:: Recomputing all dependent fields |
64517 | 1546 * Advanced features:: Field names, parameters and automatic recalc |
63833 | 1547 @end menu |
1548 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1549 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1550 @subsection References |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1551 @cindex references |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1552 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1553 To compute fields in the table from other fields, formulas must |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1554 reference other fields or ranges. In Org-mode, fields can be referenced |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1555 by name, by absolute coordinates, and by relative coordinates. To find |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1556 out what the coordinates of a field are, press @kbd{C-c ?} in that |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1557 field, or press @kbd{C-c @}} to toggle the display of a grid. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1558 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1559 @subsubheading Field references |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1560 @cindex field references |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1561 @cindex references, to fields |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1562 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1563 Formulas can reference the value of another field in two ways. Like in |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1564 any other spreadsheet, you may reference fields with a letter/number |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1565 combination like @code{B3}, meaning the 2nd field in the 3rd row. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1566 @c Such references are always fixed to that field, they don't change |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1567 @c when you copy and paste a formula to a different field. So |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1568 @c Org-mode's @code{B3} behaves like @code{$B$3} in other spreadsheets. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1569 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1570 @noindent |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1571 Org-mode also uses another, more general operator that looks like this: |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1572 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1573 @@row$column |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1574 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1575 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1576 @noindent |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1577 Column references can be absolute like @samp{1}, @samp{2},...@samp{N}, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1578 or relative to the current column like @samp{+1} or @samp{-2}. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1579 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1580 The row specification only counts data lines and ignores horizontal |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1581 separator lines (hlines). You can use absolute row numbers |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1582 @samp{1}...@samp{N}, and row numbers relative to the current row like |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1583 @samp{+3} or @samp{-1}. Or specify the row relative to one of the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1584 hlines: @samp{I} refers to the first hline, @samp{II} to the second etc. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1585 @samp{-I} refers to the first such line above the current line, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1586 @samp{+I} to the first such line below the current line. You can also |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1587 write @samp{III+2} which is the second data line after the third hline |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1588 in the table. Relative row numbers like @samp{-3} will not cross hlines |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1589 if the current line is too close to the hline. Instead, the value |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1590 directly at the hline is used. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1591 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1592 @samp{0} refers to the current row and column. Also, if you omit |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1593 either the column or the row part of the reference, the current |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1594 row/column is implied. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1595 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1596 Org-mode's references with @emph{unsigned} numbers are fixed references |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1597 in the sense that if you use the same reference in the formula for two |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1598 different fields, the same field will be referenced each time. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1599 Org-mode's references with @emph{signed} numbers are floating |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1600 references because the same reference operator can reference different |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1601 fields depending on the field being calculated by the formula. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1602 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1603 Here are a few examples: |
64517 | 1604 |
1605 @example | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1606 @@2$3 @r{2nd row, 3rd column} |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1607 C2 @r{same as previous} |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1608 $5 @r{column 5 in the current row} |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1609 E& @r{same as previous} |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1610 @@2 @r{current column, row 2} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1611 @@-1$-3 @r{the field one row up, three columns to the left} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1612 @@-I$2 @r{field just under hline above current row, column 2} |
64517 | 1613 @end example |
1614 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1615 @subsubheading Range references |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1616 @cindex range references |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1617 @cindex references, to ranges |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1618 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1619 You may reference a rectangular range of fields by specifying two field |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1620 references connected by two dots @samp{..}. If both fields are in the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1621 current row, you may simply use @samp{$2..$7}, but if at least one field |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1622 is in a different row, you need to use the general @code{@@row$column} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1623 format at least for the first field (i.e the reference must start with |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1624 @samp{@@} in order to be interpreted correctly). Examples: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1625 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1626 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1627 $1..$3 @r{First three fields in the current row.} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1628 $P..$Q @r{Range, using column names (see under Advanced)} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1629 @@2$1..@@4$3 @r{6 fields between these two fields.} |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1630 A2..C4 @r{Same as above.} |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1631 @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1632 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1633 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1634 @noindent Range references return a vector of values that can be fed |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1635 into Calc vector functions. Empty fields in ranges are normally |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1636 suppressed, so that the vector contains only the non-empty fields (but |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1637 see the @samp{E} mode switch below). If there are no non-empty fields, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1638 @samp{[0]} is returned to avoid syntax errors in formulas. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1639 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1640 @subsubheading Named references |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1641 @cindex named references |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1642 @cindex references, named |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1643 @cindex name, of column or field |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1644 @cindex constants, in calculations |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1645 |
64517 | 1646 @samp{$name} is interpreted as the name of a column, parameter or |
1647 constant. Constants are defined globally through the variable | |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1648 @code{org-table-formula-constants}, and locally (for the file) through a |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1649 line like |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1650 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1651 @example |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1652 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1653 @end example |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1654 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
1655 @noindent |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1656 Also properties (@pxref{Properties and columns}) can be used as |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1657 constants in table formulas: For a property @samp{:XYZ:} use the name |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1658 @samp{$PROP_XYZ}, and the property will be searched in the current |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1659 outline entry and in the hierarchy above it. If you have the |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1660 @file{constants.el} package, it will also be used to resolve constants, |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1661 including natural constants like @samp{$h} for Planck's constant, and |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1662 units like @samp{$km} for kilometers@footnote{@file{Constant.el} can |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1663 supply the values of constants in two different unit systems, @code{SI} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
1664 and @code{cgs}. Which one is used depends on the value of the variable |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1665 @code{constants-unit-system}. You can use the @code{#+STARTUP} options |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1666 @code{constSI} and @code{constcgs} to set this value for the current |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1667 buffer.}. Column names and parameters can be specified in special table |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1668 lines. These are described below, see @ref{Advanced features}. All |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1669 names must start with a letter, and further consist of letters and |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1670 numbers. |
63833 | 1671 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1672 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1673 @subsection Formula syntax for Calc |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1674 @cindex formula syntax, Calc |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1675 @cindex syntax, of formulas |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1676 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1677 A formula can be any algebraic expression understood by the Emacs |
77203
bcc16ff22a34
(Formula syntax for Calc): Emphasize the operator precedence in Calc.
Carsten Dominik <dominik@science.uva.nl>
parents:
76138
diff
changeset
|
1678 @file{Calc} package. @b{Note that @file{calc} has the |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1679 non-standard convention that @samp{/} has lower precedence than |
77203
bcc16ff22a34
(Formula syntax for Calc): Emphasize the operator precedence in Calc.
Carsten Dominik <dominik@science.uva.nl>
parents:
76138
diff
changeset
|
1680 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1681 evaluation by @code{calc-eval} (@pxref{Calling Calc from |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1682 Your Programs,calc-eval,Calling calc from Your Lisp Programs,calc,GNU |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1683 Emacs Calc Manual}), |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1684 @c FIXME: The link to the calc manual in HTML does not work. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1685 variable substitution takes place according to the rules described above. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1686 @cindex vectors, in table calculations |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1687 The range vectors can be directly fed into the calc vector functions |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1688 like @samp{vmean} and @samp{vsum}. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1689 |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1690 @cindex format specifier |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1691 @cindex mode, for @file{calc} |
63833 | 1692 A formula can contain an optional mode string after a semicolon. This |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1693 string consists of flags to influence Calc and other modes during |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1694 execution. By default, Org-mode uses the standard calc modes (precision |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1695 12, angular units degrees, fraction and symbolic modes off. The display |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1696 format, however, has been changed to @code{(float 5)} to keep tables |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1697 compact. The default settings can be configured using the variable |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1698 @code{org-calc-default-modes}. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1699 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1700 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1701 p20 @r{switch the internal precision to 20 digits} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1702 n3 s3 e2 f4 @r{normal, scientific, engineering, or fixed display format} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1703 D R @r{angle modes: degrees, radians} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1704 F S @r{fraction and symbolic modes} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1705 N @r{interpret all fields as numbers, use 0 for non-numbers} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1706 T @r{force text interpretation} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1707 E @r{keep empty fields in ranges} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1708 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1709 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1710 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1711 In addition, you may provide a @code{printf} format specifier to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1712 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
|
1713 |
63833 | 1714 @example |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1715 $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
|
1716 $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
|
1717 exp($2)+exp($1) @r{Math functions can be used} |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1718 $0;%.1f @r{Reformat current cell to 1 decimal} |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1719 ($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
|
1720 $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
|
1721 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
|
1722 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
|
1723 vmean($2..$7) @r{Compute column range mean, using vector function} |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1724 vmean($2..$7);EN @r{Same, but treat empty fields as 0} |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1725 taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree} |
63833 | 1726 @end example |
1727 | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1728 Calc also contains a complete set of logical operations. For example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1729 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1730 @example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1731 if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1732 @end example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1733 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1734 @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1735 @subsection Emacs Lisp forms as formulas |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1736 @cindex Lisp forms, as table formulas |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1737 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1738 It is also possible to write a formula in Emacs Lisp; this can be useful |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1739 for string manipulation and control structures, if the Calc's |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1740 functionality is not enough. If a formula starts with a single quote |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1741 followed by an opening parenthesis, then it is evaluated as a lisp form. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1742 The evaluation should return either a string or a number. Just as with |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1743 @file{calc} formulas, you can specify modes and a printf format after a |
81465
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
1744 semicolon. With Emacs Lisp forms, you need to be concious about the way |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
1745 field references are interpolated into the form. By default, a |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
1746 reference will be interpolated as a Lisp string (in double quotes) |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
1747 containing the field. If you provide the @samp{N} mode switch, all |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
1748 referenced elements will be numbers (non-number fields will be zero) and |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
1749 interpolated as Lisp numbers, without quotes. If you provide the |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
1750 @samp{L} flag, all fields will be interpolated literally, without quotes. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
1751 I.e., if you want a reference to be interpreted as a string by the Lisp |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
1752 form, enclode the reference operator itself in double quotes, like |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
1753 @code{"$3"}. Ranges are inserted as space-separated fields, so you can |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
1754 embed them in list or vector syntax. A few examples, note how the |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
1755 @samp{N} mode is used when we do computations in lisp. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1756 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1757 @example |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1758 @r{Swap the first two characters of the content of column 1} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1759 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2)) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1760 @r{Add columns 1 and 2, equivalent to the Calc's @code{$1+$2}} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1761 '(+ $1 $2);N |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1762 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1763 '(apply '+ '($1..$4));N |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1764 @end example |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
1765 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1766 @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1767 @subsection Field formulas |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1768 @cindex field formula |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1769 @cindex formula, for individual table field |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1770 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1771 To assign a formula to a particular field, type it directly into the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1772 field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1773 press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1774 the field, the formula will be stored as the formula for this field, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1775 evaluated, and the current field replaced with the result. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1776 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1777 Formulas are stored in a special line starting with @samp{#+TBLFM:} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1778 directly below the table. If you typed the equation in the 4th field of |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1779 the 3rd data line in the table, the formula will look like |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1780 @samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1781 with the appropriate commands, @i{absolute references} (but not relative |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1782 ones) in stored formulas are modified in order to still reference the |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1783 same field. Of cause this is not true if you edit the table structure |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1784 with normal editing commands - then you must fix the equations yourself. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1785 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1786 Instead of typing an equation into the field, you may also use the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1787 following command |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1788 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1789 @table @kbd |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1790 @kindex C-u C-c = |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1791 @item C-u C-c = |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1792 Install a new formula for the current field. The command prompts for a |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1793 formula, with default taken from the @samp{#+TBLFM:} line, applies |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1794 it to the current field and stores it. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1795 @end table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1796 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1797 @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet |
64517 | 1798 @subsection Column formulas |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1799 @cindex column formula |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1800 @cindex formula, for table column |
63833 | 1801 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1802 Often in a table, the same formula should be used for all fields in a |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1803 particular column. Instead of having to copy the formula to all fields |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1804 in that column, org-mode allows to assign a single formula to an entire |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1805 column. If the table contains horizontal separator hlines, everything |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1806 before the first such line is considered part of the table @emph{header} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1807 and will not be modified by column formulas. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1808 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1809 To assign a formula to a column, type it directly into any field in the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1810 column, preceded by an equal sign, like @samp{=$1+$2}. When you press |
63833 | 1811 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1812 field, the formula will be stored as the formula for the current column, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1813 evaluated and the current field replaced with the result. If the field |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1814 contains only @samp{=}, the previously stored formula for this column is |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1815 used. For each column, Org-mode will only remember the most recently |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1816 used formula. In the @samp{TBLFM:} line, column formulas will look like |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1817 @samp{$4=$1+$2}. |
63833 | 1818 |
1819 Instead of typing an equation into the field, you may also use the | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1820 following command: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1821 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1822 @table @kbd |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1823 @kindex C-c = |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1824 @item C-c = |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1825 Install a new formula for the current column and replace current field |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1826 with the result of the formula. The command prompts for a formula, with |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1827 default taken from the @samp{#+TBLFM} line, applies it to the current |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1828 field and stores it. With a numerical prefix (e.g. @kbd{C-5 C-c =}) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1829 will apply it to that many consecutive fields in the current column. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1830 @end table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1831 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1832 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1833 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1834 @subsection Editing and Debugging formulas |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1835 @cindex formula editing |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1836 @cindex editing, of table formulas |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1837 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1838 You can edit individual formulas in the minibuffer or directly in the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1839 field. Org-mode can also prepare a special buffer with all active |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1840 formulas of a table. When offering a formula for editing, Org-mode |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1841 converts references to the standard format (like @code{B3} or @code{D&}) |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1842 if possible. If you prefer to only work with the internal format (like |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1843 @code{@@3$2} or @code{$4}), configure the variable |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1844 @code{org-table-use-standard-references}. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1845 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1846 @table @kbd |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1847 @kindex C-c = |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1848 @kindex C-u C-c = |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1849 @item C-c = |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1850 @itemx C-u C-c = |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1851 Edit the formula associated with the current column/field in the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1852 minibuffer. See @ref{Column formulas} and @ref{Field formulas}. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1853 @kindex C-u C-u C-c = |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1854 @item C-u C-u C-c = |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1855 Re-insert the active formula (either a |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1856 field formula, or a column formula) into the current field, so that you |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1857 can edit it directly in the field. The advantage over editing in the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1858 minibuffer is that you can use the command @kbd{C-c ?}. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1859 @kindex C-c ? |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1860 @item C-c ? |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1861 While editing a formula in a table field, highlight the field(s) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1862 referenced by the reference at the cursor position in the formula. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1863 @kindex C-c @} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1864 @item C-c @} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1865 Toggle the display of row and column numbers for a table, using |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1866 overlays. These are updated each time the table is aligned, you can |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1867 force it with @kbd{C-c C-c}. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1868 @kindex C-c @{ |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1869 @item C-c @{ |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1870 Toggle the formula debugger on and off. See below. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1871 @kindex C-c ' |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1872 @item C-c ' |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1873 Edit all formulas for the current table in a special buffer, where the |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1874 formulas will be displayed one per line. If the current field has an |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1875 active formula, the cursor in the formula editor will mark it. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1876 While inside the special buffer, Org-mode will automatically highlight |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1877 any field or range reference at the cursor position. You may edit, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1878 remove and add formulas, and use the following commands: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1879 @table @kbd |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1880 @kindex C-c C-c |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1881 @kindex C-x C-s |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1882 @item C-c C-c |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1883 @itemx C-x C-s |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1884 Exit the formula editor and store the modified formulas. With @kbd{C-u} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1885 prefix, also apply the new formulas to the entire table. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1886 @kindex C-c C-q |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1887 @item C-c C-q |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1888 Exit the formula editor without installing changes. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1889 @kindex C-c C-r |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1890 @item C-c C-r |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1891 Toggle all references in the formula editor between standard (like |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1892 @code{B3}) and internal (like @code{@@3$2}). |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1893 @kindex @key{TAB} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1894 @item @key{TAB} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1895 Pretty-print or indent lisp formula at point. When in a line containing |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1896 a lisp formula, format the formula according to Emacs Lisp rules. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1897 Another @key{TAB} collapses the formula back again. In the open |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1898 formula, @key{TAB} re-indents just like in Emacs-lisp-mode. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1899 @kindex M-@key{TAB} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1900 @item M-@key{TAB} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1901 Complete Lisp symbols, just like in Emacs-lisp-mode. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1902 @kindex S-@key{up} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1903 @kindex S-@key{down} |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1904 @kindex S-@key{left} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1905 @kindex S-@key{right} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1906 @item S-@key{up}/@key{down}/@key{left}/@key{right} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1907 Shift the reference at point. For example, if the reference is |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1908 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1909 This also works for relative references, and for hline references. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1910 @kindex M-S-@key{up} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1911 @kindex M-S-@key{down} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1912 @item M-S-@key{up}/@key{down} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1913 Move the test line for column formulas in the Org-mode buffer up and |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1914 down. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1915 @kindex M-@key{up} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1916 @kindex M-@key{down} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1917 @item M-@key{up}/@key{down} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1918 Scroll the window displaying the table. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1919 @kindex C-c @} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1920 @item C-c @} |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1921 Turn the coordinate grid in the table on and off. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1922 @end table |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1923 @end table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1924 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1925 Making a table field blank does not remove the formula associated with |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1926 the field, because that is stored in a different line (the @samp{TBLFM} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1927 line) - during the next recalculation the field will be filled again. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1928 To remove a formula from a field, you have to give an empty reply when |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1929 prompted for the formula, or to edit the @samp{#+TBLFM} line. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1930 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1931 @kindex C-c C-c |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1932 You may edit the @samp{#+TBLFM} directly and re-apply the changed |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1933 equations with @kbd{C-c C-c} in that line, or with the normal |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1934 recalculation commands in the table. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1935 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1936 @subsubheading Debugging formulas |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1937 @cindex formula debugging |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1938 @cindex debugging, of table formulas |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1939 When the evaluation of a formula leads to an error, the field content |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1940 becomes the string @samp{#ERROR}. If you would like see what is going |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1941 on during variable substitution and calculation in order to find a bug, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1942 turn on formula debugging in the @code{Tbl} menu and repeat the |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1943 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1944 field. Detailed information will be displayed. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1945 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1946 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1947 @subsection Updating the Table |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
1948 @cindex recomputing table fields |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1949 @cindex updating, table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1950 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1951 Recalculation of a table is normally not automatic, but needs to be |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1952 triggered by a command. See @ref{Advanced features} for a way to make |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1953 recalculation at least semi-automatically. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1954 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1955 In order to recalculate a line of a table or the entire table, use the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1956 following commands: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1957 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1958 @table @kbd |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1959 @kindex C-c * |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1960 @item C-c * |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1961 Recalculate the current row by first applying the stored column formulas |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1962 from left to right, and all field formulas in the current row. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1963 @c |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1964 @kindex C-u C-c * |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1965 @item C-u C-c * |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1966 @kindex C-u C-c C-c |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1967 @itemx C-u C-c C-c |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1968 Recompute the entire table, line by line. Any lines before the first |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1969 hline are left alone, assuming that these are part of the table header. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
1970 @c |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1971 @kindex C-u C-u C-c * |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1972 @item C-u C-u C-c * |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1973 Iterate the table by recomputing it until no further changes occur. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1974 This may be necessary if some computed fields use the value of other |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1975 fields that are computed @i{later} in the calculation sequence. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1976 @end table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1977 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1978 @node Advanced features, , Updating the table, The spreadsheet |
64517 | 1979 @subsection Advanced features |
1980 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1981 If you want the recalculation of fields to happen automatically, or if |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1982 you want to be able to assign @i{names} to fields and columns, you need |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1983 to reserve the first column of the table for special marking characters. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1984 @table @kbd |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1985 @kindex C-# |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1986 @item C-# |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1987 Rotate the calculation mark in first column through the states @samp{}, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1988 @samp{#}, @samp{*}, @samp{!}, @samp{$}. The meaning of these characters |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1989 is discussed below. When there is an active region, change all marks in |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1990 the region. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1991 @end table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1992 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1993 Here is an example of a table that collects exam results of students and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
1994 makes use of these features: |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
1995 |
63833 | 1996 @example |
1997 @group | |
1998 |---+---------+--------+--------+--------+-------+------| | |
1999 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note | | |
2000 |---+---------+--------+--------+--------+-------+------| | |
2001 | ! | | P1 | P2 | P3 | Tot | | | |
2002 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 | | |
64069 | 2003 | ^ | | m1 | m2 | m3 | mt | | |
63833 | 2004 |---+---------+--------+--------+--------+-------+------| |
2005 | # | Peter | 10 | 8 | 23 | 41 | 8.2 | | |
64517 | 2006 | # | Sara | 6 | 14 | 19 | 39 | 7.8 | |
63833 | 2007 | # | Sam | 2 | 4 | 3 | 9 | 1.8 | |
2008 |---+---------+--------+--------+--------+-------+------| | |
64517 | 2009 | | Average | | | | 29.7 | | |
2010 | ^ | | | | | at | | | |
63833 | 2011 | $ | max=50 | | | | | | |
2012 |---+---------+--------+--------+--------+-------+------| | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2013 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f |
63833 | 2014 @end group |
2015 @end example | |
64517 | 2016 |
2017 @noindent @b{Important}: Please note that for these special tables, | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2018 recalculating the table with @kbd{C-u C-c *} will only affect rows that |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2019 are marked @samp{#} or @samp{*}, and fields that have a formula assigned |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2020 to the field itself. The column formulas are not applied in rows with |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2021 empty first field. |
64517 | 2022 |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2023 @cindex marking characters, tables |
64517 | 2024 The marking characters have the following meaning: |
2025 @table @samp | |
2026 @item ! | |
2027 The fields in this line define names for the columns, so that you may | |
2028 refer to a column as @samp{$Tot} instead of @samp{$6}. | |
2029 @item ^ | |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
2030 This row defines names for the fields @emph{above} the row. With such |
64517 | 2031 a definition, any formula in the table may use @samp{$m1} to refer to |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2032 the value @samp{10}. Also, if you assign a formula to a names field, it |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2033 will be stored as @samp{$name=...}. |
64517 | 2034 @item _ |
2035 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
|
2036 @emph{below}. |
64517 | 2037 @item $ |
2038 Fields in this row can define @emph{parameters} for formulas. For | |
2039 example, if a field in a @samp{$} row contains @samp{max=50}, then | |
2040 formulas in this table can refer to the value 50 using @samp{$max}. | |
2041 Parameters work exactly like constants, only that they can be defined on | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2042 a per-table basis. |
64517 | 2043 @item # |
2044 Fields in this row are automatically recalculated when pressing | |
2045 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row | |
2046 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked | |
2047 lines will be left alone by this command. | |
2048 @item * | |
2049 Selects this line for global recalculation with @kbd{C-u C-c *}, but | |
2050 not for automatic recalculation. Use this when automatic | |
2051 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
|
2052 @item |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2053 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}. |
64517 | 2054 All lines that should be recalculated should be marked with @samp{#} |
2055 or @samp{*}. | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2056 @item / |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2057 Do not export this line. Useful for lines that contain the narrowing |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2058 @samp{<N>} markers. |
64517 | 2059 @end table |
2060 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2061 Finally, just to whet your appetite on what can be done with the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2062 fantastic @file{calc} package, here is a table that computes the Taylor |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2063 series of degree @code{n} at location @code{x} for a couple of functions |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2064 (homework: try that with Excel :-) |
63833 | 2065 |
2066 @example | |
2067 @group | |
2068 |---+-------------+---+-----+--------------------------------------| | |
2069 | | Func | n | x | Result | | |
2070 |---+-------------+---+-----+--------------------------------------| | |
2071 | # | exp(x) | 1 | x | 1 + x | | |
2072 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 | | |
2073 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 | | |
2074 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 | | |
2075 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 | | |
2076 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 | | |
2077 |---+-------------+---+-----+--------------------------------------| | |
2078 #+TBLFM: $5=taylor($2,$4,$3);n3 | |
2079 @end group | |
2080 @end example | |
2081 | |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2082 @node Hyperlinks, TODO items, Tables, Top |
58792 | 2083 @chapter Hyperlinks |
2084 @cindex hyperlinks | |
2085 | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2086 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
|
2087 links to other files, Usenet articles, emails, and much more. |
58792 | 2088 |
2089 @menu | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2090 * 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
|
2091 * 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
|
2092 * External links:: URL-like links to the world |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
2093 * Handling links:: Creating, inserting and following |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
2094 * Using links outside Org-mode:: Linking from my C source code? |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2095 * 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
|
2096 * 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
|
2097 * Custom searches:: When the default search is not enough |
58792 | 2098 * Remember:: Org-trees store quick notes |
2099 @end menu | |
2100 | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2101 @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
|
2102 @section Link format |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2103 @cindex link format |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2104 @cindex format, of links |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2105 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2106 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
|
2107 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
|
2108 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2109 @example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2110 [[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
|
2111 @end example |
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 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
|
2114 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
|
2115 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
|
2116 @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
|
2117 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
|
2118 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
|
2119 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
|
2120 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
|
2121 cursor on the link. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2122 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2123 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
|
2124 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
|
2125 (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
|
2126 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
|
2127 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
|
2128 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
|
2129 @code{Org->Hyperlinks->Literal links}. |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2130 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2131 @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
|
2132 @section Internal links |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2133 @cindex internal links |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2134 @cindex links, internal |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2135 @cindex targets, for links |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2136 |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
2137 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
|
2138 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
|
2139 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
|
2140 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
|
2141 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
|
2142 match for such a link is a dedicated target: the same string in double |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2143 angular brackets. Targets may be located anywhere; sometimes it is |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2144 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
|
2145 |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2146 @example |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2147 # <<My Target>> |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2148 @end example |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2149 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
2150 @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
|
2151 named anchors for direct access through @samp{http} links@footnote{Note |
81465
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
2152 that text before the first headline is usually not exported, so the |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
2153 first such target should 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
|
2154 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2155 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
|
2156 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
|
2157 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
|
2158 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
|
2159 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
|
2160 @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
|
2161 |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2162 @example |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2163 ** My targets |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2164 ** TODO my targets are bright |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2165 ** my 20 targets are |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2166 @end example |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2167 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2168 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
|
2169 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
|
2170 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
|
2171 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
|
2172 creating links. |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2173 |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2174 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
|
2175 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
|
2176 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
|
2177 earlier. |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2178 |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2179 @menu |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2180 * 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
|
2181 @end menu |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2182 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2183 @node Radio targets, , Internal links, Internal links |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2184 @subsection Radio targets |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2185 @cindex radio targets |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2186 @cindex targets, radio |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2187 @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
|
2188 |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2189 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
|
2190 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
|
2191 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
|
2192 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
|
2193 @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
|
2194 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
|
2195 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
|
2196 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
|
2197 @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
|
2198 |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
2199 @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
|
2200 @section External links |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2201 @cindex links, external |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2202 @cindex external links |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2203 @cindex links, external |
58792 | 2204 @cindex GNUS links |
2205 @cindex BBDB links | |
63833 | 2206 @cindex URL links |
2207 @cindex file links | |
58792 | 2208 @cindex VM links |
2209 @cindex RMAIL links | |
2210 @cindex WANDERLUST links | |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2211 @cindex MH-E links |
58792 | 2212 @cindex USENET links |
2213 @cindex SHELL links | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2214 @cindex Info links |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2215 @cindex elisp links |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2216 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2217 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
|
2218 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
|
2219 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
|
2220 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
|
2221 link type. |
58792 | 2222 |
2223 @example | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2224 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
|
2225 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
|
2226 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
|
2227 news:comp.emacs @r{Usenet link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2228 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
|
2229 vm:folder @r{VM folder link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2230 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
|
2231 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
|
2232 wl:folder @r{WANDERLUST folder link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2233 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
|
2234 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
|
2235 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
|
2236 rmail:folder @r{RMAIL folder link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2237 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
|
2238 gnus:group @r{GNUS group link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2239 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
|
2240 bbdb:Richard Stallman @r{BBDB link} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2241 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
|
2242 elisp:(find-file-other-frame "Elisp.org") @r{An elisp form to evaluate} |
58792 | 2243 @end example |
2244 | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2245 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
|
2246 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
|
2247 format}), for example: |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2248 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2249 @example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2250 [[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
|
2251 @end example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2252 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2253 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2254 If the description is a file name or URL that points to an image, HTML |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2255 export (@pxref{HTML export}) will inline the image as a clickable |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2256 button. If there is no description at all and the link points to an |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2257 image, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2258 that image will be inlined into the exported HTML file. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2259 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2260 @cindex angular brackets, around links |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2261 @cindex plain text external links |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2262 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
|
2263 as links. If spaces must be part of the link (for example in |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2264 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2265 about the end of the link, enclose them in angular brackets. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2266 |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
2267 @node Handling links, Using links outside Org-mode, External links, Hyperlinks |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
2268 @section Handling links |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2269 @cindex links, handling |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2270 |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2271 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
|
2272 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
|
2273 |
58792 | 2274 @table @kbd |
2275 @kindex C-c l | |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2276 @cindex storing links |
58792 | 2277 @item C-c l |
2278 Store a link to the current location. This is a @emph{global} command | |
2279 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
|
2280 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
|
2281 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
|
2282 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
|
2283 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
|
2284 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
|
2285 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
|
2286 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
|
2287 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
|
2288 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
|
2289 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
|
2290 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
|
2291 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
|
2292 The key binding @kbd{C-c l} is only a suggestion - see @ref{Installation}. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2293 @c |
58792 | 2294 @kindex C-c C-l |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2295 @cindex link completion |
63833 | 2296 @cindex completion, of links |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2297 @cindex inserting links |
58792 | 2298 @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
|
2299 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
|
2300 You can just type a link, using text for an internal link, or one of the |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2301 link type prefixes mentioned in the examples above. All links stored |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2302 during the current session are part of the history for this prompt, so |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2303 you can access them with @key{up} and @key{down}. Completion, on the |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2304 other hand, will help you to insert valid link prefixes like |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2305 @samp{http:} or @samp{ftp:}, including the prefixes defined through link |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2306 abbreviations (@pxref{Link abbreviations}). The link will be inserted |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2307 into the buffer@footnote{After insertion of a stored link, the link will |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2308 be removed from the list of stored links. To keep it in the list later |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
2309 use, use a triple @kbd{C-u} prefix to @kbd{C-c C-l}, or configure the |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2310 option @code{org-keep-stored-link-after-insertion}.}, along with a |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2311 descriptive text. If some text was selected when this command is |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2312 called, the selected text becomes the default description.@* Note that |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2313 you don't have to use this command to insert a link. Links in Org-mode |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2314 are plain text, and you can type or paste them straight into the buffer. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2315 By using this command, the links are automatically enclosed in double |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2316 brackets, and you will be asked for the optional descriptive text. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2317 @c |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2318 @c If the link is a @samp{file:} link and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2319 @c the linked file is located in the same directory as the current file or |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2320 @c a subdirectory of it, the path of the file will be inserted relative to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2321 @c the current directory. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2322 @c |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2323 @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
|
2324 @cindex file name completion |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2325 @cindex completion, of file names |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2326 @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
|
2327 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
|
2328 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
|
2329 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
|
2330 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
|
2331 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
|
2332 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
|
2333 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
|
2334 force an absolute path with two @kbd{C-u} prefixes. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2335 @c |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2336 @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
|
2337 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
|
2338 link and description parts of the link. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2339 @c |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2340 @cindex following links |
58792 | 2341 @kindex C-c C-o |
2342 @item C-c C-o | |
2343 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
|
2344 @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
|
2345 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
|
2346 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
|
2347 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
|
2348 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
|
2349 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
|
2350 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
|
2351 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
|
2352 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
|
2353 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
|
2354 Emacs, use a @kbd{C-u} prefix. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2355 @c |
58792 | 2356 @kindex mouse-2 |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
2357 @kindex mouse-1 |
58792 | 2358 @item mouse-2 |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
2359 @itemx mouse-1 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2360 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
|
2361 would. Under Emacs 22, also @kbd{mouse-1} will follow a link. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2362 @c |
58792 | 2363 @kindex mouse-3 |
2364 @item mouse-3 | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2365 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
|
2366 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
|
2367 variable @code{org-display-internal-link-with-indirect-buffer}}. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2368 @c |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2369 @cindex mark ring |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2370 @kindex C-c % |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2371 @item C-c % |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2372 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
|
2373 easily. Commands following an internal link do this automatically. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2374 @c |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2375 @cindex links, returning to |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2376 @kindex C-c & |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2377 @item C-c & |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2378 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
|
2379 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
|
2380 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
|
2381 previously recorded positions. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2382 @c |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2383 @kindex C-c C-x C-n |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2384 @kindex C-c C-x C-p |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2385 @cindex links, finding next/previous |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2386 @item C-c C-x C-n |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2387 @itemx C-c C-x C-p |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2388 Move forward/backward to the next link in the buffer. At the limit of |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2389 the buffer, the search fails once, and then wraps around. The key |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2390 bindings for this are really too long, you might want to bind this also |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2391 to @kbd{C-n} and @kbd{C-p} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2392 @lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2393 (add-hook 'org-load-hook |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2394 (lambda () |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2395 (define-key 'org-mode-map "\C-n" 'org-next-link) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2396 (define-key 'org-mode-map "\C-p" 'org-previous-link))) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2397 @end lisp |
58792 | 2398 @end table |
2399 | |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
2400 @node Using links outside Org-mode, Link abbreviations, Handling links, Hyperlinks |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
2401 @section Using links outside Org-mode |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
2402 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
2403 You can insert and follow links that have Org-mode syntax not only in |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
2404 Org-mode, but in any Emacs buffer. For this, you should create two |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
2405 global commands, like this (please select suitable global keys |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
2406 yourself): |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
2407 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
2408 @lisp |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
2409 (define-key global-map 'org-insert-link-global "\\C-c L") |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
2410 (define-key global-map 'org-open-at-point-global "\\C-c o") |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
2411 @end lisp |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
2412 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
2413 @node Link abbreviations, Search options, Using links outside Org-mode, Hyperlinks |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2414 @section Link abbreviations |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2415 @cindex link abbreviations |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2416 @cindex abbreviation, links |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2417 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2418 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
|
2419 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
|
2420 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
|
2421 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2422 @example |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2423 [[linkword:tag][description]] |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2424 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2425 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2426 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2427 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
|
2428 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
|
2429 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
|
2430 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2431 @lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2432 @group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2433 (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
|
2434 '(("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
|
2435 ("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
|
2436 ("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
|
2437 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
|
2438 @end group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2439 @end lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2440 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2441 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
|
2442 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
|
2443 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
|
2444 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
|
2445 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2446 With the above setting, you could link to a specific bug with |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2447 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2448 @code{[[google:OrgMode]]} and find out what the Org-mode author is |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2449 doing besides Emacs hacking with @code{[[ads:Dominik,C]]}. |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2450 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2451 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
|
2452 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
|
2453 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2454 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2455 #+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
|
2456 #+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
|
2457 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2458 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2459 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2460 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
|
2461 complete link abbreviations. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2462 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2463 @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
|
2464 @section Search options in file links |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2465 @cindex search option in file links |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2466 @cindex file links, searching |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2467 |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2468 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
|
2469 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
|
2470 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
|
2471 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
|
2472 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
|
2473 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
|
2474 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
|
2475 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
|
2476 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2477 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
|
2478 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
|
2479 |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2480 @example |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2481 [[file:~/code/main.c::255]] |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2482 [[file:~/xx.org::My Target]] |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2483 [[file:~/xx.org::*My Target]] |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2484 [[file:~/xx.org::/regexp/]] |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2485 @end example |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2486 |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2487 @table @code |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2488 @item 255 |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2489 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
|
2490 @item My Target |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2491 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
|
2492 @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
|
2493 @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
|
2494 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
|
2495 the linked file. |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2496 @item *My Target |
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2497 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
|
2498 @item /regexp/ |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2499 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
|
2500 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
|
2501 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
|
2502 sparse tree with the matches. |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2503 @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
|
2504 @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
|
2505 @end table |
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2506 |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
2507 As a degenerate case, a file link with an empty file name can be used |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2508 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
|
2509 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
|
2510 @samp{[[find me]]} would. |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2511 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2512 @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
|
2513 @section Custom Searches |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2514 @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
|
2515 @cindex search strings, custom |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2516 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2517 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
|
2518 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
|
2519 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
|
2520 @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
|
2521 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
|
2522 citation key. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2523 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2524 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
|
2525 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
|
2526 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
|
2527 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
|
2528 @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
|
2529 @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
|
2530 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
|
2531 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
|
2532 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
|
2533 file. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2534 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2535 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2536 @node Remember, , Custom searches, Hyperlinks |
58792 | 2537 @section Remember |
2538 @cindex @file{remember.el} | |
2539 | |
2540 Another way to create org entries with links to other files is through | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2541 the @i{remember} package by John Wiegley. @i{Remember} lets you store |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2542 quick notes with little interruption of your work flow. See |
58792 | 2543 @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2544 information. The notes produced by @i{Remember} can be stored in |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2545 different ways, and Org-mode files are a good target. Org-mode |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2546 significantly expands the possibilities of @i{remember}: You may define |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2547 templates for different note types, and to associate target files and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2548 headlines with specific templates. It also allows you to select the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2549 location where a note should be stored interactively, on the fly. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2550 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2551 @menu |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2552 * Setting up remember:: Some code for .emacs to get things going |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2553 * Remember templates:: Define the outline of different note types |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2554 * Storing notes:: Directly get the note to where it belongs |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2555 @end menu |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2556 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2557 @node Setting up remember, Remember templates, Remember, Remember |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2558 @subsection Setting up remember |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2559 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2560 The following customization will tell @i{remember} to use org files as |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2561 target, and to create annotations compatible with Org-mode links. |
64517 | 2562 |
58792 | 2563 @example |
2564 (setq org-directory "~/path/to/my/orgfiles/") | |
2565 (setq org-default-notes-file "~/.notes") | |
2566 (setq remember-annotation-functions '(org-remember-annotation)) | |
2567 (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
|
2568 (add-hook 'remember-mode-hook 'org-remember-apply-template) |
58792 | 2569 @end example |
2570 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2571 @node Remember templates, Storing notes, Setting up remember, Remember |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2572 @subsection Remember templates |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2573 @cindex templates, for remember |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2574 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2575 In combination with Org-mode, you can use templates to generate |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2576 different types of @i{remember} notes. For example, if you would like |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2577 to use one template to create general TODO entries, another one for |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2578 journal entries, and a third one for collecting random ideas, you could |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2579 use: |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2580 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2581 @example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2582 (setq org-remember-templates |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2583 '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org") |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2584 (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org") |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2585 (?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas"))) |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2586 @end example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2587 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2588 @noindent In these entries, the character specifies how to select the |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2589 template. The first string specifies the template. Two more (optional) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2590 strings give the file in which, and the headline under which the new |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2591 note should be stored. The file defaults (if not present or @code{nil}) |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2592 to @code{org-default-notes-file}, the heading to |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2593 @code{org-remember-default-headline}. Both defaults help to get to the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2594 storing location quickly, but you can change the location interactively |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2595 while storing the note. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2596 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2597 When you call @kbd{M-x remember} (or @kbd{M-x org-remember}) to remember |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2598 something, org will prompt for a key to select the template (if you have |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2599 more than one template) and then prepare the buffer like |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2600 @example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2601 * TODO |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2602 [[file:link to where you called remember]] |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2603 @end example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2604 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2605 @noindent or |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2606 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2607 @example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2608 * [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
|
2609 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2610 [[file:link to where you called remember]] |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2611 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2612 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2613 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2614 During expansion of the template, special @kbd{%}-escapes allow dynamic |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2615 insertion of content: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2616 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2617 %^@{prompt@} @r{prompt the user for a string and replace this sequence with it.} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2618 %t @r{time stamp, date only} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2619 %T @r{time stamp with date and time} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2620 %u, %U @r{like the above, but inactive time stamps} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2621 %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2622 @r{You may define a prompt like @code{%^@{Birthday@}t}} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2623 %n @r{user name (taken from @code{user-full-name})} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2624 %a @r{annotation, normally the link created with @code{org-store-link}} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2625 %i @r{initial content, the region when remember is called with C-u.} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2626 @r{The entire text will be indented like @code{%i} itself.} |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
2627 %^g @r{prompt for tags, with completion on tags in target file.} |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
2628 %^G @r{prompt for tags, with completion all tags in all agenda files.} |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2629 %:keyword @r{specific information for certain link types, see below} |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2630 @end example |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2631 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2632 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2633 For specific link types, the following keywords will be defined: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2634 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2635 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2636 Link type | Available keywords |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2637 -------------------+---------------------------------------------- |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2638 bbdb | %:name %:company |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2639 vm, wl, mh, rmail | %:type %:subject %:message-id |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2640 | %:from %:fromname %:fromaddress |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2641 | %:to %:toname %:toaddress |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2642 | %:fromto @r{(either "to NAME" or "from NAME")@footnote{This will always be the other, not the user. See the variable @code{org-from-is-user-regexp}.}} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2643 gnus | %:group, @r{for messages also all email fields} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2644 w3, w3m | %:url |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2645 info | %:file %:node |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2646 calendar | %:date" |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2647 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2648 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2649 @noindent |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2650 To place the cursor after template expansion use: |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2651 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2652 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2653 %? @r{After completing the template, position cursor here.} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2654 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2655 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2656 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2657 If you change you mind about which template to use, call |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2658 @code{org-remember} in the remember buffer. You may then select a new |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2659 template that will be filled with the previous context information. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2660 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2661 @node Storing notes, , Remember templates, Remember |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2662 @subsection Storing notes |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2663 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2664 When you are finished preparing a note with @i{remember}, you have to press |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2665 @kbd{C-c C-c} to file the note away. The handler first prompts for a |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2666 target file - if you press @key{RET}, the value specified for the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2667 template is used. Then the command offers the headings tree of the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2668 selected file, with the cursor position at the default headline (if you |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2669 had specified one in the template). You can either immediately press |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2670 @key{RET} to get the note placed there. Or you can use the following |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2671 keys to find a better location: |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2672 @example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2673 @key{TAB} @r{Cycle visibility.} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2674 @key{down} / @key{up} @r{Next/previous visible headline.} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2675 n / p @r{Next/previous visible headline.} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2676 f / b @r{Next/previous headline same level.} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2677 u @r{One level up.} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2678 @c 0-9 @r{Digit argument.} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2679 @end example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2680 @noindent |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2681 Pressing @key{RET} or @key{left} or @key{right} |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2682 then leads to the following result. |
58792 | 2683 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2684 @multitable @columnfractions 0.2 0.15 0.65 |
58792 | 2685 @item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted} |
2686 @item buffer-start @tab @key{RET} @tab as level 2 heading at end of file | |
2687 @item on headline @tab @key{RET} @tab as sublevel of the heading at cursor | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2688 @item @tab @key{left}/@key{right} @tab as same level, before/after current heading |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
2689 @item not on headline @tab @key{RET} |
58792 | 2690 @tab at cursor position, level taken from context. |
2691 @end multitable | |
2692 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2693 So a fast way to store the note to its default location is to press |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2694 @kbd{C-c C-c @key{RET} @key{RET}}. Even shorter would be @kbd{C-u C-c |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2695 C-c}, which does the same without even asking for a file or showing the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2696 tree. |
58792 | 2697 |
2698 Before inserting the text into a tree, the function ensures that the | |
2699 text has a headline, i.e. a first line that starts with a @samp{*}. | |
2700 If not, a headline is constructed from the current date and some | |
2701 additional data. If the variable @code{org-adapt-indentation} is | |
63833 | 2702 non-nil, the entire text is also indented so that it starts in the |
2703 same column as the headline (after the asterisks). | |
58792 | 2704 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2705 |
81465
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
2706 @node TODO items, Tags, Hyperlinks, Top |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2707 @chapter TODO items |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2708 @cindex TODO items |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2709 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2710 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
|
2711 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
|
2712 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
|
2713 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
|
2714 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
|
2715 item emerged is always present when you check. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2716 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2717 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
|
2718 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
|
2719 things you have to do. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2720 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2721 @menu |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2722 * TODO basics:: Marking and displaying TODO entries |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2723 * TODO extensions:: Workflow and assignments |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2724 * Priorities:: Some things are more important than others |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2725 * Breaking down tasks:: Splitting a task into manageable pieces |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2726 * Checkboxes:: Tick-off lists |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2727 @end menu |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2728 |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2729 @node TODO basics, TODO extensions, TODO items, TODO items |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2730 @section Basic TODO functionality |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2731 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2732 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
|
2733 for example: |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2734 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2735 @example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2736 *** TODO Write letter to Sam Fortune |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2737 @end example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2738 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2739 @noindent |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2740 The most important commands to work with TODO entries are: |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2741 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2742 @table @kbd |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2743 @kindex C-c C-t |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2744 @cindex cycling, of TODO states |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2745 @item C-c C-t |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2746 Rotate the TODO state of the current item among |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2747 |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2748 @example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2749 ,-> (unmarked) -> TODO -> DONE --. |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2750 '--------------------------------' |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2751 @end example |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2752 |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2753 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
|
2754 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
|
2755 @kindex S-@key{right} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2756 @kindex S-@key{left} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2757 @item S-@key{right} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2758 @itemx S-@key{left} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2759 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
|
2760 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
|
2761 @kindex C-c C-v |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2762 @cindex sparse tree, for TODO |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2763 @item C-c C-v |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2764 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
|
2765 the entire buffer, but shows all TODO items and the headings hierarchy |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2766 above them. With prefix arg, search for a specific TODO. You will be |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2767 prompted for the keyword, and you can also give a list of keywords like |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2768 @code{kwd1|kwd2|...}. With numerical prefix N, show the tree for the |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2769 Nth keyword in the variable @code{org-todo-keywords}. With two prefix |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2770 args, find all TODO and DONE entries. |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2771 @kindex C-c a t |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
2772 @item C-c a t |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
2773 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
|
2774 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
|
2775 @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
|
2776 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
|
2777 @xref{Global TODO list}, for more information. |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
2778 @c @item @code{org-agenda-include-all-todo} |
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
2779 @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
|
2780 @c agenda, customize the variable @code{org-agenda-include-all-todo}. |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
2781 @kindex S-M-@key{RET} |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
2782 @item S-M-@key{RET} |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
2783 Insert a new TODO entry below the current one. |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2784 @end table |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2785 |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
2786 @node TODO extensions, Priorities, TODO basics, TODO items |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2787 @section Extended use of TODO keywords |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2788 @cindex extended TODO keywords |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2789 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2790 The default implementation of TODO entries is just two states: TODO and |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2791 DONE. You can use the TODO feature for more complicated things by |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2792 configuring the variable @code{org-todo-keywords}. With special setup, |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2793 the TODO keyword system can work differently in different files. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2794 |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
2795 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
|
2796 TODO items in particular (@pxref{Tags}). |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2797 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2798 @menu |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2799 * Workflow states:: From TODO to DONE in steps |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2800 * TODO types:: I do this, Fred the rest |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2801 * Multiple sets in one file:: Mixing it all, and still finding your way |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2802 * Per file keywords:: Different files, different requirements |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2803 @end menu |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2804 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2805 @node Workflow states, TODO types, TODO extensions, TODO extensions |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2806 @subsection TODO keywords as workflow states |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2807 @cindex TODO workflow |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2808 @cindex workflow states as TODO keywords |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2809 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2810 You can use TODO keywords to indicate different @emph{sequential} states |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2811 in the process of working on an item, for example@footnote{Changing |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2812 this variable only becomes effective after restarting Org-mode in a |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2813 buffer.}: |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2814 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2815 @lisp |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2816 (setq org-todo-keywords |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2817 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED"))) |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2818 @end lisp |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2819 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2820 The vertical bar separates the TODO keywords (states that @emph{need |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2821 action}) from the DONE states (which need @emph{no further action}. If |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2822 you don't provide the separator bar, the last state is used as the DONE |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2823 state. |
63833 | 2824 @cindex completion, of TODO keywords |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2825 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2826 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2827 also use a prefix argument to quickly select a specific state. For |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2828 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY. |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2829 If you define many keywords, you can use in-buffer completion (see |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2830 @ref{Completion}) to insert these words into the buffer. Changing a |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2831 todo state can be logged with a timestamp, see @ref{Tracking TODO state |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2832 changes} for more information. |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2833 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2834 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2835 @subsection TODO keywords as types |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2836 @cindex TODO types |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2837 @cindex names as TODO keywords |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2838 @cindex types as TODO keywords |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2839 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2840 The second possibility is to use TODO keywords to indicate different |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2841 @emph{types} of action items. For example, you might want to indicate |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2842 that items are for ``work'' or ``home''. Or, when you work with several |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2843 people on a single project, you might want to assign action items |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2844 directly to persons, by using their names as TODO keywords. This would |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2845 be set up like this: |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2846 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2847 @lisp |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2848 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE"))) |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2849 @end lisp |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2850 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2851 In this case, different keywords do not indicate a sequence, but rather |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2852 different types. So the normal work flow would be to assign a task to a |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2853 person, and later to mark it DONE. Org-mode supports this style by |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2854 adapting the workings of the command @kbd{C-c C-t}@footnote{This is also |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2855 true for the @kbd{t} command in the timeline and agenda buffers.}. When |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2856 used several times in succession, it will still cycle through all names, |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2857 in order to first select the right type for a task. But when you return |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2858 to the item after some time and execute @kbd{C-c C-t} again, it will |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2859 switch from any name directly to DONE. Use prefix arguments or |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2860 completion to quickly select a specific name. You can also review the |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2861 items of a specific TODO type in a sparse tree by using a numeric prefix |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2862 to @kbd{C-c C-v}. For example, to see all things Lucy has to do, you |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2863 would use @kbd{C-3 C-c C-v}. To collect Lucy's items from all agenda |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2864 files into a single buffer, you would use the prefix arg as well when |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2865 creating the global todo list: @kbd{C-3 C-c t}. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2866 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2867 @node Multiple sets in one file, Per file keywords, TODO types, TODO extensions |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2868 @subsection Multiple keyword sets in one file |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2869 @cindex todo keyword sets |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2870 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2871 Sometimes you may want to use different sets of TODO keywords in |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2872 parallel. For example, you may want to have the basic |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2873 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2874 separate state indicating that an item has been canceled (so it is not |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2875 DONE, but also does not require action). Your setup would then look |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2876 like this: |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2877 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2878 @lisp |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2879 (setq org-todo-keywords |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2880 '((sequence "TODO" "|" "DONE") |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2881 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED") |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2882 (sequence "|" "CANCELED"))) |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2883 @end lisp |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2884 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2885 The keywords should all be different, this helps Org-mode to keep track |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2886 of which subsequence should be used for a given entry. In this setup, |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2887 @kbd{C-c C-t} only operates within a subsequence, so it switches from |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2888 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2889 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2890 select the correct sequence. Besides the obvious ways like typing a |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2891 keyword or using completion, you may also apply the following commands: |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2892 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2893 @table @kbd |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2894 @kindex C-S-@key{right} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2895 @kindex C-S-@key{left} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2896 @item C-S-@key{right} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2897 @itemx C-S-@key{left} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2898 These keys jump from one TODO subset to the next. In the above example, |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2899 @kbd{C-S-@key{right}} would jump from @code{TODO} or @code{DONE} to |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2900 @code{REPORT}, and any of the words in the second row to @code{CANCELED}. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2901 @kindex S-@key{right} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2902 @kindex S-@key{left} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2903 @item S-@key{right} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2904 @itemx S-@key{left} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2905 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2906 @emph{all} keywords from all sets, so for example @kbd{S-@key{<right>}} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2907 would switch from @code{DONE} to @code{REPORT} in the example above. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2908 @end table |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2909 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2910 @node Per file keywords, , Multiple sets in one file, TODO extensions |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2911 @subsection Setting up keywords for individual files |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2912 @cindex keyword options |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2913 @cindex per file keywords |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2914 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2915 It can be very useful to use different aspects of the TODO mechanism in |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2916 different files. For file-local settings, you need to add special lines |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2917 to the file which set the keywords and interpretation for that file |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2918 only. For example, to set one of the two examples discussed above, you |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2919 need one of the following lines, starting in column zero anywhere in the |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2920 file: |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2921 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2922 @example |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2923 #+SEQ_TODO: TODO FEEDBACK VERIFY | DONE CANCELED |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2924 @end example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2925 or |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2926 @example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2927 #+TYP_TODO: Fred Sara Lucy Mike | DONE |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2928 @end example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2929 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2930 A setup for using several sets in parallel would be: |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2931 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2932 @example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2933 #+SEQ_TODO: "TODO" "|" "DONE" |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2934 #+SEQ_TODO: "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED" |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2935 #+SEQ_TODO: "|" "CANCELED" |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2936 @end example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2937 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2938 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
2939 @cindex completion, of option keywords |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2940 @kindex M-@key{TAB} |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2941 @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
|
2942 @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
|
2943 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2944 @cindex DONE, final TODO keyword |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2945 Remember that the keywords after the vertical bar (or the last keyword |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2946 if no bar is there) must always mean that the item is DONE (although you |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2947 may use a different word). After changing one of these lines, use |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2948 @kbd{C-c C-c} with the cursor still in the line to make the changes |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2949 known to Org-mode@footnote{Org-mode parses these lines only when |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2950 Org-mode is activated after visiting a file. @kbd{C-c C-c} with the |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2951 cursor in a line starting with @samp{#+} is simply restarting Org-mode |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2952 for the current buffer.}. |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2953 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
2954 @node Priorities, Breaking down tasks, TODO extensions, TODO items |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2955 @section Priorities |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2956 @cindex priorities |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2957 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2958 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
|
2959 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
|
2960 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
|
2961 headline, like this |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2962 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2963 @example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2964 *** TODO [#A] Write letter to Sam Fortune |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2965 @end example |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2966 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2967 @noindent |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2968 With its standard setup, Org-mode supports priorities @samp{A}, |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2969 @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
|
2970 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
|
2971 difference only in the agenda (@pxref{Weekly/Daily agenda}). |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2972 |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2973 @table @kbd |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2974 @kindex @kbd{C-c ,} |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2975 @item @kbd{C-c ,} |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2976 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
|
2977 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
|
2978 @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
|
2979 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
|
2980 agenda buffer with the @kbd{,} command (@pxref{Agenda commands}). |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2981 @c |
61923
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2982 @kindex S-@key{up} |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2983 @kindex S-@key{down} |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2984 @item S-@key{up} |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2985 @itemx S-@key{down} |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
2986 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
|
2987 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
|
2988 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
|
2989 @end table |
88492f3ccffa
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
61562
diff
changeset
|
2990 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2991 You can change the range of allowed priorities by setting the variables |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2992 @code{org-highest-priority}, @code{org-lowest-priority}, and |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2993 @code{org-default-priority}. For an individual buffer, you may set |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2994 these values (highest, lowest, default) like this (please make sure that |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2995 the highest priority is earlier in the alphabet than the lowest |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2996 priority): |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2997 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2998 @example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
2999 #+PRIORITIES: A C B |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3000 @end example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3001 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3002 @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
|
3003 @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
|
3004 @cindex tasks, breaking down |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3005 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3006 It is often advisable to break down large tasks into smaller, manageable |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3007 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
|
3008 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
|
3009 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
|
3010 @code{org-agenda-todo-list-sublevels}.}. Another possibility is the use |
74030 | 3011 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
|
3012 (@pxref{Checkboxes}). |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3013 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3014 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3015 @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
|
3016 @section Checkboxes |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3017 @cindex checkboxes |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3018 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3019 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
|
3020 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
|
3021 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
|
3022 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
|
3023 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
|
3024 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
|
3025 @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
|
3026 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3027 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3028 * 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
|
3029 - call people [1/3] |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3030 - [ ] Peter |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3031 - [X] Sarah |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3032 - [ ] Sam |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3033 - [X] order food |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3034 - [ ] 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
|
3035 - [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
|
3036 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3037 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3038 @cindex statistics, for checkboxes |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3039 @cindex checkbox statistics |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3040 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
|
3041 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
|
3042 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
|
3043 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
|
3044 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
|
3045 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
|
3046 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
|
3047 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
|
3048 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
|
3049 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
|
3050 @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
|
3051 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3052 @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
|
3053 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3054 @table @kbd |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3055 @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
|
3056 @item C-c C-c |
81838
09c82a1bcb6f
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81789
diff
changeset
|
3057 Toggle checkbox at point. With prefix argument, set it to @samp{[-]}, |
09c82a1bcb6f
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81789
diff
changeset
|
3058 which is considered to be an intermediate state. |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3059 @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
|
3060 @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
|
3061 Toggle checkbox at point. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3062 @itemize @minus |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3063 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3064 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
|
3065 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
|
3066 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
|
3067 argument. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3068 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3069 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
|
3070 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
|
3071 @item |
74030 | 3072 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
|
3073 @end itemize |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3074 @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
|
3075 @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
|
3076 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
|
3077 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
|
3078 (@pxref{Plain lists}). |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3079 @kindex C-c # |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3080 @item C-c # |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3081 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
|
3082 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
|
3083 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
|
3084 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
|
3085 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
|
3086 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
|
3087 @end table |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3088 |
81465
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3089 |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3090 @node Tags, Properties and columns, TODO items, Top |
81465
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3091 @chapter Tags |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3092 @cindex tags |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3093 @cindex headline tagging |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3094 @cindex matching, tags |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3095 @cindex sparse tree, tag based |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3096 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3097 If you wish to implement a system of labels and contexts for |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3098 cross-correlating information, an excellent way is to assign @i{tags} to |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3099 headlines. Org-mode has extensive support for using tags. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3100 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3101 Every headline can contain a list of tags, at the end of the headline. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3102 Tags are normal words containing letters, numbers, @samp{_}, and |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3103 @samp{@@}. Tags must be preceded and followed by a single colon; like |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3104 @samp{:WORK:}. Several tags can be specified like @samp{:WORK:URGENT:}. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3105 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3106 @menu |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3107 * Tag inheritance:: Tags use the tree structure of the outline |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3108 * Setting tags:: How to assign tags to a headline |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3109 * Tag searches:: Searching for combinations of tags |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3110 @end menu |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3111 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3112 @node Tag inheritance, Setting tags, Tags, Tags |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3113 @section Tag inheritance |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3114 @cindex inheritance, of tags |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3115 @cindex sublevels, inclusion into tags match |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3116 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3117 @i{Tags} make use of the hierarchical structure of outline trees. If a |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3118 heading has a certain tag, all subheadings will inherit the tag as |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3119 well. For example, in the list |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3120 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3121 @example |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3122 * Meeting with the French group :WORK: |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3123 ** Summary by Frank :BOSS:NOTES: |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3124 *** TODO Prepare slides for him :ACTION: |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3125 @end example |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3126 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3127 @noindent |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3128 the final heading will have the tags @samp{:WORK:}, @samp{:BOSS:}, |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3129 @samp{:NOTES:}, and @samp{:ACTION:}. When executing tag searches and |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3130 Org-mode finds that a certain headline matches the search criterion, it |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3131 will not check any sublevel headline, assuming that these likely also |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3132 match, and that the list of matches can become very long. This may |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3133 not be what you want, however, and you can influence inheritance and |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3134 searching using the variables @code{org-use-tag-inheritance} and |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3135 @code{org-tags-match-list-sublevels}. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3136 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3137 @node Setting tags, Tag searches, Tag inheritance, Tags |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3138 @section Setting tags |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3139 @cindex setting tags |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3140 @cindex tags, setting |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3141 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3142 @kindex M-@key{TAB} |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3143 Tags can simply be typed into the buffer at the end of a headline. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3144 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3145 also a special command for inserting tags: |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3146 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3147 @table @kbd |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3148 @kindex C-c C-c |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3149 @item C-c C-c |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3150 @cindex completion, of tags |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3151 Enter new tags for the current headline. Org-mode will either offer |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3152 completion or a special single-key interface for setting tags, see |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3153 below. After pressing @key{RET}, the tags will be inserted and aligned |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3154 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3155 tags in the current buffer will be aligned to that column, just to make |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3156 things look nice. TAGS are automatically realigned after promotion, |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3157 demotion, and TODO state changes (@pxref{TODO basics}). |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3158 @end table |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3159 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3160 Org will support tag insertion based on a @emph{list of tags}. By |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3161 default this list is constructed dynamically, containing all tags |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3162 currently used in the buffer. You may also globally specify a hard list |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3163 of tags with the variable @code{org-tag-alist}. Finally you can set |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3164 the default tags for a given file with lines like |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3165 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3166 @example |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3167 #+TAGS: @@WORK @@HOME @@TENNISCLUB |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3168 #+TAGS: Laptop Car PC Sailboat |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3169 @end example |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3170 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3171 If you have globally defined your preferred set of tags using the |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3172 variable @code{org-tag-alist}, but would like to use a dynamic tag list |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3173 in a specific file: Just add an empty TAGS option line to that file: |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3174 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3175 @example |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3176 #+TAGS: |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3177 @end example |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3178 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3179 The default support method for entering tags is minibuffer completion. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3180 However, Org-mode also implements a much better method: @emph{fast tag |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3181 selection}. This method allows to select and deselect tags with a |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3182 single key per tag. To function efficiently, you should assign unique |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3183 keys to most tags. This can be done globally with |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3184 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3185 @lisp |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3186 (setq org-tag-alist '(("@@WORK" . ?w) ("@@HOME" . ?h) ("Laptop" . ?l))) |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3187 @end lisp |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3188 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3189 @noindent or on a per-file basis with |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3190 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3191 @example |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3192 #+TAGS: @@WORK(w) @@HOME(h) @@TENNISCLUB(t) Laptop(l) PC(p) |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3193 @end example |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3194 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3195 @noindent |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3196 You can also group together tags that are mutually exclusive. With |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3197 curly braces@footnote{In @code{org-mode-alist} use |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3198 @code{'(:startgroup)} and @code{'(:endgroup)}, respectively. Several |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3199 groups are allowed.} |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3200 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3201 @example |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3202 #+TAGS: @{ @@WORK(w) @@HOME(h) @@TENNISCLUB(t) @} Laptop(l) PC(p) |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3203 @end example |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3204 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3205 @noindent you indicate that at most one of @samp{@@WORK}, @samp{@@HOME}, |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3206 and @samp{@@TENNISCLUB} should be selected. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3207 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3208 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3209 these lines to activate any changes. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3210 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3211 If at least one tag has a selection key, pressing @kbd{C-c C-c} will |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3212 automatically present you with a special interface, listing inherited |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3213 tags, the tags of the current headline, and a list of all legal tags |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3214 with corresponding keys@footnote{Keys will automatically be assigned to |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3215 tags which have no configured keys.}. In this interface, you can use |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3216 the following keys: |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3217 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3218 @table @kbd |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3219 @item a-z... |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3220 Pressing keys assigned to tags will add or remove them from the list of |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3221 tags in the current line. Selecting a tag in a group of mutually |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3222 exclusive tags will turn off any other tags from that group. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3223 @kindex @key{TAB} |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3224 @item @key{TAB} |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3225 Enter a tag in the minibuffer, even if the tag is not in the predefined |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3226 list. You will be able to complete on all tags present in the buffer. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3227 @kindex @key{SPC} |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3228 @item @key{SPC} |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3229 Clear all tags for this line. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3230 @kindex @key{RET} |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3231 @item @key{RET} |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3232 Accept the modified set. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3233 @item C-g |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3234 Abort without installing changes. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3235 @item q |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3236 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3237 @item ! |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3238 Turn off groups of mutually exclusive tags. Use this to (as an |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3239 exception) assign several tags from such a group. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3240 @item C-c |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3241 Toggle auto-exit after the next change (see below). |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3242 If you are using expert mode, the first @kbd{C-c} will display the |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3243 selection window. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3244 @end table |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3245 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3246 @noindent |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3247 This method lets you assign tags to a headline with very few keys. With |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3248 the above setup, you could clear the current tags and set @samp{@@HOME}, |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3249 @samp{Laptop} and @samp{PC} tags with just the following keys: @kbd{C-c |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3250 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@HOME} to |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3251 @samp{@@WORK} would be done with @kbd{C-c C-c w @key{RET}} or |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3252 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3253 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3254 @key{RET} @key{RET}}. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3255 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3256 If you find that most of the time, you need only a single keypress to |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3257 modify your list of tags, set the variable |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3258 @code{org-fast-tag-selection-single-key}. Then you no longer have to |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3259 press @key{RET} to exit fast tag selection - it will immediately exit |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3260 after the first change. If you then occasionally need more keys, press |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3261 @kbd{C-c} to turn off auto-exit for the current tag selection process |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3262 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3263 C-c}). If you set the variable to the value @code{expert}, the special |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3264 window is not even shown for single-key tag selection, it comes up only |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3265 when you press an extra @kbd{C-c}. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3266 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3267 @node Tag searches, , Setting tags, Tags |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3268 @section Tag searches |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3269 @cindex tag searches |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3270 @cindex searching for tags |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3271 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3272 Once a tags system has been set up, it can be used to collect related |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3273 information into special lists. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3274 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3275 @table @kbd |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3276 @kindex C-c \ |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3277 @item C-c \ |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3278 Create a sparse tree with all headlines matching a tags search. With a |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3279 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3280 @kindex C-c a m |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3281 @item C-c a m |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3282 Create a global list of tag matches from all agenda files. |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3283 @xref{Matching tags and properties}. |
81465
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3284 @kindex C-c a M |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3285 @item C-c a M |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3286 Create a global list of tag matches from all agenda files, but check |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3287 only TODO items and force checking subitems (see variable |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3288 @code{org-tags-match-list-sublevels}). |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3289 @end table |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3290 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3291 @cindex Boolean logic, for tag searches |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3292 A @i{tags} search string can use Boolean operators @samp{&} for AND and |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3293 @samp{|} for OR. @samp{&} binds more strongly than @samp{|}. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3294 Parenthesis are currently not implemented. A tag may also be preceded |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3295 by @samp{-}, to select against it, and @samp{+} is syntactic sugar for |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3296 positive selection. The AND operator @samp{&} is optional when @samp{+} |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3297 or @samp{-} is present. Examples: |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3298 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3299 @table @samp |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3300 @item +WORK-BOSS |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3301 Select headlines tagged @samp{:WORK:}, but discard those also tagged |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3302 @samp{:BOSS:}. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3303 @item WORK|LAPTOP |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3304 Selects lines tagged @samp{:WORK:} or @samp{:LAPTOP:}. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3305 @item WORK|LAPTOP&NIGHT |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3306 Like before, but require the @samp{:LAPTOP:} lines to be tagged also |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3307 @samp{NIGHT}. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3308 @end table |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3309 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3310 @cindex TODO keyword matching, with tags search |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3311 If you are using multi-state TODO keywords (@pxref{TODO extensions}), it |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3312 can be useful to also match on the TODO keyword. This can be done by |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3313 adding a condition after a slash to a tags match. The syntax is similar |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3314 to the tag matches, but should be applied with consideration: For |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3315 example, a positive selection on several TODO keywords can not |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3316 meaningfully be combined with boolean AND. However, @emph{negative |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3317 selection} combined with AND can be meaningful. To make sure that only |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3318 lines are checked that actually have any TODO keyword, use @kbd{C-c a |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3319 M}, or equivalently start the todo part after the slash with @samp{!}. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3320 Examples: |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3321 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3322 @table @samp |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3323 @item WORK/WAITING |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3324 Select @samp{:WORK:}-tagged TODO lines with the specific TODO |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3325 keyword @samp{WAITING}. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3326 @item WORK/!-WAITING-NEXT |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3327 Select @samp{:WORK:}-tagged TODO lines that are neither @samp{WAITING} |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3328 nor @samp{NEXT} |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3329 @item WORK/+WAITING|+NEXT |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3330 Select @samp{:WORK:}-tagged TODO lines that are either @samp{WAITING} or |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3331 @samp{NEXT}. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3332 @end table |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3333 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3334 @cindex regular expressions, with tags search |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3335 Any element of the tag/todo match can be a regular expression - in this |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3336 case it must be enclosed in curly braces. For example, |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3337 @samp{WORK+@{^BOSS.*@}} matches headlines that contain the tag |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3338 @samp{WORK} and any tag @i{starting} with @samp{BOSS}. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3339 |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3340 @cindex level, require for tags match |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3341 You can also require a headline to be of a certain level, by writing |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3342 instead of any TAG an expression like @samp{LEVEL=3}. For example, a |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3343 search @samp{+LEVEL=3+BOSS/-DONE} lists all level three headlines that |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3344 have the tag BOSS and are @emph{not} marked with the todo keyword DONE. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3345 |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3346 @node Properties and columns, Timestamps, Tags, Top |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3347 @chapter Properties and Columns |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3348 @cindex properties |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3349 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3350 Properties are a set of key-value pairs associated with an entry. There |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3351 are two main applications for properties in Org-mode. First, properties |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3352 are like tags, but with a value. For example, in a file where you |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3353 document bugs and plan releases of a piece of software, instead of using |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3354 tags like @code{:release_1:}, @code{:release_2:}, it can be more |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3355 efficient to use a property @code{RELEASE} with a value @code{1.0} or |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3356 @code{2.0}. Second, you can use properties to implement (very basic) |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3357 database capabilities in an Org-mode buffer, for example to create a |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3358 list of Music CD's you own. You can edit and view properties |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3359 conveniently in column view (@pxref{Column view}). |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3360 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3361 @menu |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3362 * Property syntax:: How properties are spelled out |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3363 * Special properties:: Access to other Org-mode features |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3364 * Property searches:: Matching property values |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3365 * Column view:: Tabular viewing and editing |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3366 * Property API:: Properties for Lisp programmers |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3367 @end menu |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3368 |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3369 @node Property syntax, Special properties, Properties and columns, Properties and columns |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3370 @section Property Syntax |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3371 @cindex property syntax |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3372 @cindex drawer, for properties |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3373 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3374 Properties are key-value pairs. They need to be inserted into a special |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3375 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3376 is specified on a single line, with the key (surrounded by colons) |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3377 first, and the value after it. Here is an example: |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3378 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3379 @example |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3380 * CD collection |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3381 ** Classic |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3382 *** Goldberg Variations |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3383 :PROPERTIES: |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3384 :Title: Goldberg Variations |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3385 :Composer: J.S. Bach |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3386 :Artist: Glen Gould |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3387 :Publisher: Deutsche Grammphon |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3388 :NDisks: 1 |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3389 :END: |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3390 @end example |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3391 |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3392 You may define the allowed values for a particular property @samp{XYZ} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3393 by setting a property @samp{XYZ_ALL}. This special property is |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3394 @emph{inherited}, so if you set it in a level 1 entry, it will apply to |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3395 the entire tree. When allowed values are defined, setting the |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3396 corresponding property becomes easier and is less prone to typing |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3397 errors. For the example with the CD collection, we can predefine |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3398 publishers and the number of disks in a box like this: |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3399 |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3400 @example |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3401 * CD collection |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3402 :PROPERTIES: |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3403 :NDisks_ALL: 1 2 3 4 |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3404 :Publisher_ALL: "Deutsche Grammophon" Phillips EMI |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3405 :END: |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3406 @end example |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3407 |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
3408 If you want to set properties that can be inherited by any entry in a |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
3409 file, use a line like |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
3410 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
3411 @example |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
3412 #+PROPERTY: NDisks_ALL 1 2 3 4 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
3413 @end example |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
3414 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
3415 Property values set with the global variable |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
3416 @code{org-global-properties} can be inherited by all entries in all |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
3417 Org-mode files. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
3418 |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3419 @noindent |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3420 The following commands help to work with properties: |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3421 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3422 @table @kbd |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3423 @kindex M-@key{TAB} |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3424 @item M-@key{TAB} |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3425 After an initial colon in a line, complete property keys. All keys used |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3426 in the current file will be offered as possible completions. |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3427 @item M-x org-insert-property-drawer |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3428 Insert a property drawer into the current entry. The drawer will be |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3429 inserted early in the entry, but after the lines with planning |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3430 information like deadlines. |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3431 @kindex C-c C-c |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3432 @item C-c C-c |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3433 With the cursor in a property drawer, this executes property commands. |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3434 @item C-c C-c s |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3435 Set a property in the current entry. Both the property and the value |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3436 can be inserted using completion. |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3437 @kindex S-@key{right} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3438 @kindex S-@key{left} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3439 @item S-@key{left}/@key{right} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3440 Switch property at point to the next/previous allowed value. |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3441 @item C-c C-c d |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3442 Remove a property from the current entry. |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3443 @item C-c C-c D |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3444 Globally remove a property, from all entries in the current file. |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3445 @end table |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3446 |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3447 @node Special properties, Property searches, Property syntax, Properties and columns |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3448 @section Special Properties |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3449 @cindex properties, special |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3450 |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3451 Special properties provide alternative access method to Org-mode |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3452 features discussed in the previous chapters, like the TODO state or the |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3453 priority of an entry. This interface exists so that you can include |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3454 these states into columns view (@pxref{Column view}). The following |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3455 property names are special and should not be used as keys in the |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3456 properties drawer: |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3457 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3458 @example |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3459 TODO @r{The TODO keyword of the entry.} |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3460 TAGS @r{The tags defined directly in the headline.} |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3461 ALLTAGS @r{All tags, including inherited ones.} |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3462 PRIORITY @r{The priority of the entry, a string with a single letter.} |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3463 DEADLINE @r{The deadline time string, without the angular brackets.} |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3464 SCHEDULED @r{The scheduling time stamp, without the angular brackets.} |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3465 @end example |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3466 |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3467 @node Property searches, Column view, Special properties, Properties and columns |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3468 @section Property searches |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3469 @cindex properties, searching |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3470 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3471 To create sparse trees and special lists with selection based on |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3472 properties, the same commands are used as for tag searches (@pxref{Tag |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3473 searches}), and the same logic applies. For example, a search string |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3474 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3475 @example |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3476 +WORK-BOSS+PRIORITY="A"+coffee="unlimited"+with=@{Sarah\|Denny@} |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3477 @end example |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3478 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3479 @noindent |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3480 finds entries tagged @samp{:WORK:} but not @samp{:BOSS:}, which |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3481 also have a priority value @samp{A}, a @samp{:coffee:} property with the |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3482 value @samp{unlimited}, and a @samp{:with:} property that is matched by |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3483 the regular expression @samp{Sarah\|Denny}. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3484 |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3485 @node Column view, Property API, Property searches, Properties and columns |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3486 @section Column View |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3487 |
81838
09c82a1bcb6f
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81789
diff
changeset
|
3488 A great way to view and edit properties in an outline tree is |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3489 @emph{column view}. In column view, each outline item is turned into a |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3490 table row. Columns in this table provide access to properties of the |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3491 entries. Org-mode implements columns by overlaying a tabular structure |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3492 over the headline of each item. While the headlines have been turned |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3493 into a table row, you can still change the visibility of the outline |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3494 tree. For example, you get a compact table by switching to CONTENTS |
81838
09c82a1bcb6f
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81789
diff
changeset
|
3495 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view |
09c82a1bcb6f
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81789
diff
changeset
|
3496 is active), but you can still open, read, and edit the entry below each |
09c82a1bcb6f
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81789
diff
changeset
|
3497 headline. Or, you can switch to column view after executing a sparse |
09c82a1bcb6f
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81789
diff
changeset
|
3498 tree command and in this way get a table only for the selected items. |
09c82a1bcb6f
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81789
diff
changeset
|
3499 Column view also works in agenda buffers (@pxref{Agenda views}) where |
09c82a1bcb6f
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81789
diff
changeset
|
3500 queries have collected selected items, possibly from a number of files. |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3501 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3502 @menu |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3503 * Defining columns:: The COLUMNS format property |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3504 * Using column view:: How to create and use column view |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3505 @end menu |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3506 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3507 @node Defining columns, Using column view, Column view, Column view |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3508 @subsection Defining Columns |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3509 @cindex column view, for properties |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3510 @cindex properties, column view |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3511 |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3512 Setting up a column view first requires defining the columns. This is |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3513 done by defining a column format line. |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3514 |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3515 @menu |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3516 * Scope of column definitions:: Where defined, where valid? |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3517 * Column attributes:: Appearance and content of a column |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3518 @end menu |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3519 |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3520 @node Scope of column definitions, Column attributes, Defining columns, Defining columns |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3521 @subsubsection Scope of column definitions |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3522 |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3523 To define a column format for an entire file, use a line like |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3524 |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3525 @example |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3526 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3527 @end example |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3528 |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3529 To specify a format that only applies to a specific tree, add a COLUMNS |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3530 property to the top node of that tree, for example |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3531 @example |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3532 ** Top node for columns view |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3533 :PROPERTIES: |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3534 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3535 :END: |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3536 @end example |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3537 |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3538 If a @code{COLUMNS} property is present in an entry, it defines columns |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3539 for the entry itself, and for the entire subtree below it. Since the |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3540 column definition is part of the hierarchical structure of the document, |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3541 you can define columns on level 1 that are general enough for all |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3542 sublevels, and more specific columns further down, when you edit a |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3543 deeper part of the tree. |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3544 |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3545 @node Column attributes, , Scope of column definitions, Defining columns |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3546 @subsubsection Column attributes |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3547 A column definition sets the attributes of a column. The general |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3548 definition looks like this: |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3549 |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3550 @example |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3551 %[width]property[(title)][@{summary-type@}] |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3552 @end example |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3553 |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3554 @noindent |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3555 Except for the percent sign and the property name, all items are |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3556 optional. The individual parts have the following meaning: |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3557 |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3558 @example |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3559 width @r{An integer specifying the width of the column in characters.} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3560 @r{If omitted, the width will be determined automatically.} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3561 property @r{The property that should be edited in this column.} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3562 (title) @r{The header text for the column. If omitted, the} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3563 @r{property name is used.} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3564 @{summary-type@} @r{The summary type. If specified, the column values for} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3565 @r{parent nodes are computed from the children.} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3566 @r{Supported summary types are:} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3567 @{+@} @r{Sum numbers in this column.} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3568 @{:@} @r{Sum times, HH:MM:SS, plain numbers are hours.} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3569 @{X@} @r{Checkbox status, [X] if all children are [X].} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3570 @end example |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3571 |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3572 @noindent |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3573 Here is an example for a complete columns definition, along with allowed |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3574 values. |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3575 |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3576 @example |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3577 :COLUMNS: %20ITEM %9Approved(Approved?)@{X@} %Owner %11Status %10Time_Spent@{:@} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3578 :Owner_ALL: Tammy Mark Karl Lisa Don |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3579 :Status_ALL: "In progress" "Not started yet" "Finished" "" |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3580 :Approved_ALL: "[ ]" "[X]" |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3581 @end example |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3582 |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3583 The first column, @samp{%25ITEM}, means the first 25 characters of the |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3584 item itself, i.e. of the headline. You probably always should start the |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3585 column definition with the ITEM specifier. The other specifiers create |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3586 columns @samp{Owner} with a list of names as allowed values, for |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3587 @samp{Status} with four different possible values, and for a checkbox |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3588 field @samp{Approved}. When no width is given after the @samp{%} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3589 character, the column will be exactly as wide as it needs to be in order |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3590 to fully display all values. The @samp{Approved} column does have a |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3591 modified title (@samp{Approved?}, with a question mark). Summaries will |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3592 be created for the @samp{Time_Spent} column by adding time duration |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3593 expressions like HH:MM, and for the @samp{Approved} column, by providing |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3594 an @samp{[X]} status if all children have been checked. |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3595 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3596 @node Using column view, , Defining columns, Column view |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3597 @subsection Using Column View |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3598 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3599 @table @kbd |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3600 @tsubheading{Turning column view on and off} |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3601 @kindex C-c C-x C-c |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3602 @item C-c C-x C-c |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3603 Create the column view for the local environment. This command searches |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3604 the hierarchy, up from point, for a @code{COLUMNS} property that defines |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3605 a format. When one is found, the column view table is established for |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3606 the entire tree, starting from the entry that contains the @code{COLUMNS} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3607 property. If none is found, the format is taken from the @code{#+COLUMNS} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3608 line or from the variable @code{org-columns-default-format}, and column |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3609 view is established for the current entry and its subtree. |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3610 @kindex q |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3611 @item q |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3612 Exit column view. |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3613 @tsubheading{Editing values} |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3614 @item @key{left} @key{right} @key{up} @key{down} |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3615 Move through the column view from field to field. |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3616 @kindex S-@key{left} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3617 @kindex S-@key{right} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3618 @item S-@key{left}/@key{right} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3619 Switch to the next/previous allowed value of the field. For this, you |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3620 have to have specified allowed values for a property. |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3621 @kindex n |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3622 @kindex p |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3623 @itemx n / p |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3624 Same as @kbd{S-@key{left}/@key{right}} |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3625 @kindex e |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3626 @item e |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3627 Edit the property at point. For the special properties, this will |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3628 invoke the same interface that you normally use to change that |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3629 property. For example, when editing a TAGS property, the tag completion |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3630 or fast selection interface will pop up. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3631 @kindex v |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3632 @item v |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3633 View the full value of this property. This is useful if the width of |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3634 the column is smaller than that of the value. |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3635 @kindex a |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3636 @item a |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3637 Edit the list of allowed values for this property. If the list is found |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3638 in the hierarchy, the modified values is stored there. If no list is |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3639 found, the new value is stored in the first entry that is part of the |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3640 current column view. |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3641 @tsubheading{Modifying the table structure} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3642 @kindex < |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3643 @kindex > |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3644 @item < / > |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3645 Make the column narrower/wider by one character. |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3646 @kindex S-M-@key{right} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3647 @item S-M-@key{right} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3648 Insert a new column, to the right of the current column. |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3649 @kindex S-M-@key{left} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3650 @item S-M-@key{left} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3651 Delete the current column. |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3652 @end table |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3653 |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3654 @node Property API, , Column view, Properties and columns |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3655 @section The Property API |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3656 @cindex properties, API |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3657 @cindex API, for properties |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3658 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3659 There is a full API for accessing and changing properties. This API can |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3660 be used by Emacs Lisp programs to work with properties and to implement |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3661 features based on them. For more information see @ref{Using the |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3662 property API}. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
3663 |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
3664 @node Timestamps, Agenda views, Properties and columns, Top |
58792 | 3665 @chapter Timestamps |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3666 @cindex time stamps |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3667 @cindex date stamps |
58792 | 3668 |
3669 Items can be labeled with timestamps to make them useful for project | |
3670 planning. | |
3671 | |
3672 @menu | |
3673 * Time stamps:: Assigning a time to a tree entry | |
3674 * Creating timestamps:: Commands which insert timestamps | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3675 * Deadlines and scheduling:: Planning your work |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
3676 * Progress logging:: Documenting when what work was done. |
58792 | 3677 @end menu |
3678 | |
3679 | |
3680 @node Time stamps, Creating timestamps, Timestamps, Timestamps | |
3681 @section Time stamps, deadlines and scheduling | |
3682 @cindex time stamps | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3683 @cindex ranges, time |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3684 @cindex date stamps |
58792 | 3685 @cindex deadlines |
3686 @cindex scheduling | |
3687 | |
81465
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3688 A time stamp is a specification of a date (possibly with time or a range |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3689 of times) in a special format, either @samp{<2003-09-16 Tue>} or |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3690 @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3691 12:00-12:30>}@footnote{This is the standard ISO date/time format. If |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3692 you cannot get used to these, see @ref{Custom time format}}. A time |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3693 stamp can appear anywhere in the headline or body of an org-tree entry. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3694 Its presence causes entries to be shown on specific dates in the agenda |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3695 (@pxref{Weekly/Daily agenda}). We distinguish: |
58792 | 3696 |
3697 @table @var | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
3698 @item Plain time stamp |
58792 | 3699 @cindex timestamp |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
3700 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
|
3701 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
|
3702 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
|
3703 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
|
3704 associated with a plain time stamp will be shown exactly on that date. |
58792 | 3705 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3706 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3707 * Meet Peter at the movies <2006-11-01 Wed 19:15> |
81465
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3708 * Discussion on climate change <2006-11-02 Thu 20:00-22:00> |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3709 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3710 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3711 @item Time stamp with repeater interval |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3712 @cindex timestamp, with repeater interval |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3713 A time stamp may contain a @emph{repeater interval}, indicating that it |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3714 applies not only on the given date, but again and again after a certain |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3715 interval of N days (d), weeks (w), months(m), or years(y). The |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3716 following will show up in the agenda every Wednesday: |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3717 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3718 @example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3719 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w> |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3720 @end example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3721 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3722 @item Diary-style sexp entries |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3723 For more complex date specifications, Org-mode supports using the |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3724 special sexp diary entries implemented in the Emacs calendar/diary |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3725 package. For example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3726 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3727 @example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3728 * The nerd meeting on every 2nd Thursday of the month |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3729 <%%(diary-float t 4 2)> |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3730 @end example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3731 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3732 @item Time/Date range |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3733 @cindex timerange |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3734 @cindex date range |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3735 Two time stamps connected by @samp{--} denote a range. The headline |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3736 will be shown on the first and last day of the range, and on any dates |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3737 that are displayed and fall in the range. Here is an example: |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3738 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3739 @example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3740 ** Meeting in Amsterdam |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3741 <2004-08-23 Mon>--<2004-08-26 Thu> |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3742 @end example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3743 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3744 @item Inactive time stamp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3745 @cindex timestamp, inactive |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3746 @cindex inactive timestamp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3747 Just like a plain time stamp, but with square brackets instead of |
74030 | 3748 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
|
3749 @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
|
3750 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3751 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3752 * 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
|
3753 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3754 |
58792 | 3755 @end table |
3756 | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3757 @node Creating timestamps, Deadlines and scheduling, Time stamps, Timestamps |
58792 | 3758 @section Creating timestamps |
3759 @cindex creating timestamps | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
3760 @cindex timestamps, creating |
58792 | 3761 |
3762 For Org-mode to recognize time stamps, they need to be in the specific | |
3763 format. All commands listed below produce time stamps in the correct | |
3764 format. | |
3765 | |
3766 @table @kbd | |
3767 @kindex C-c . | |
3768 @item C-c . | |
3769 Prompt for a date and insert a corresponding time stamp. When the | |
3770 cursor is at a previously used time stamp, it is updated to NOW. When | |
3771 this command is used twice in succession, a time range is inserted. | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3772 @c |
58792 | 3773 @kindex C-u C-c . |
3774 @item C-u C-c . | |
3775 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
|
3776 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
|
3777 see the option @code{org-time-stamp-rounding-minutes}. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3778 @c |
65656 | 3779 @kindex C-c ! |
3780 @item C-c ! | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3781 Like @kbd{C-c .}, but insert an inactive time stamp that will not cause |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3782 an agenda entry. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3783 @c |
58792 | 3784 @kindex C-c < |
3785 @item C-c < | |
3786 Insert a time stamp corresponding to the cursor date in the Calendar. | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3787 @c |
58792 | 3788 @kindex C-c > |
3789 @item C-c > | |
3790 Access the Emacs calendar for the current date. If there is a | |
3791 timestamp in the current line, goto the corresponding date | |
3792 instead. | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3793 @c |
58792 | 3794 @kindex C-c C-o |
3795 @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
|
3796 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
|
3797 point (@pxref{Weekly/Daily agenda}). |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3798 @c |
58792 | 3799 @kindex S-@key{left} |
3800 @kindex S-@key{right} | |
3801 @item S-@key{left} | |
3802 @itemx S-@key{right} | |
63362 | 3803 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
|
3804 CUA-mode (@pxref{Conflicts}). |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3805 @c |
58792 | 3806 @kindex S-@key{up} |
3807 @kindex S-@key{down} | |
3808 @item S-@key{up} | |
3809 @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
|
3810 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
|
3811 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
|
3812 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
|
3813 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
|
3814 CUA-mode (@pxref{Conflicts}). |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3815 @c |
58792 | 3816 @kindex C-c C-y |
3817 @cindex evaluate time range | |
3818 @item C-c C-y | |
3819 Evaluate a time range by computing the difference between start and | |
3820 end. With prefix arg, insert result after the time range (in a table: | |
3821 into the following column). | |
3822 @end table | |
3823 | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3824 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3825 @menu |
74030 | 3826 * The date/time prompt:: How org-mode helps you entering date and time |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3827 * Custom time format:: Making dates look differently |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3828 @end menu |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3829 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3830 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3831 @subsection The date/time prompt |
58792 | 3832 @cindex date, reading in minibuffer |
3833 @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
|
3834 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3835 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
|
3836 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
|
3837 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
|
3838 (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
|
3839 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
|
3840 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
|
3841 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3842 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3843 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
|
3844 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
|
3845 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
|
3846 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
|
3847 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
|
3848 12 --> currentyear-currentmonth-12 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3849 Fri --> nearest Friday (today or later) |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3850 +4 --> 4 days from now (if +N is the only thing given) |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3851 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3852 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3853 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
|
3854 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
|
3855 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
|
3856 |
58792 | 3857 @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
|
3858 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
|
3859 you don't need/want the calendar, configure the variable |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3860 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3861 prompt, either by clicking on a date in the calendar, or by pressing |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3862 @key{RET}, the date selected in the calendar will be combined with the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3863 information entered at the prompt. You can control the calendar fully |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3864 from the minibuffer: |
58792 | 3865 |
3866 @table @kbd | |
3867 @kindex < | |
3868 @item < | |
3869 Scroll calendar backwards by one month. | |
3870 @kindex > | |
3871 @item > | |
3872 Scroll calendar forwards by one month. | |
3873 @kindex mouse-1 | |
3874 @item mouse-1 | |
3875 Select date by clicking on it. | |
3876 @kindex S-@key{right} | |
3877 @item S-@key{right} | |
3878 One day forward. | |
3879 @kindex S-@key{left} | |
3880 @item S-@key{left} | |
3881 One day back. | |
3882 @kindex S-@key{down} | |
3883 @item S-@key{down} | |
3884 One week forward. | |
3885 @kindex S-@key{up} | |
3886 @item S-@key{up} | |
3887 One week back. | |
3888 @kindex M-S-@key{right} | |
3889 @item M-S-@key{right} | |
3890 One month forward. | |
3891 @kindex M-S-@key{left} | |
3892 @item M-S-@key{left} | |
3893 One month back. | |
3894 @kindex @key{RET} | |
3895 @item @key{RET} | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3896 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
|
3897 @end table |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3898 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3899 @node Custom time format, , The date/time prompt, Creating timestamps |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3900 @subsection Custom time format |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3901 @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
|
3902 @cindex time format, custom |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3903 @cindex date format, custom |
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 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
|
3906 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
|
3907 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
|
3908 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
|
3909 @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
|
3910 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3911 @table @kbd |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3912 @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
|
3913 @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
|
3914 Toggle the display of custom formats for dates and times. |
58792 | 3915 @end table |
3916 | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3917 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3918 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
|
3919 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
|
3920 @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
|
3921 following consequences: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3922 @itemize @bullet |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3923 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3924 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
|
3925 after. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3926 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3927 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
|
3928 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
|
3929 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
|
3930 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
|
3931 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
|
3932 @item |
81465
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3933 If the time stamp contains a range of clock times or a repeater, these |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3934 will not be overlayed, but remain in the buffer as they were. |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
3935 @item |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3936 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
|
3937 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
|
3938 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
|
3939 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3940 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
|
3941 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
|
3942 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
|
3943 @end itemize |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
3944 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3945 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3946 @node Deadlines and scheduling, Progress logging, Creating timestamps, Timestamps |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3947 @section Deadlines and Scheduling |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3948 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3949 A time stamp may be preceded by special keywords to facilitate planning |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3950 of work: |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3951 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3952 @table @var |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3953 @item DEADLINE |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3954 @cindex DEADLINE keyword |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3955 The task (most likely a TODO item) is supposed to be finished on that |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3956 date, and it will be listed then. In addition, the compilation for |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3957 @emph{today} will carry a warning about the approaching or missed |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3958 deadline, starting @code{org-deadline-warning-days} before the due date, |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3959 and continuing until the entry is marked DONE. An example: |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3960 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3961 @example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3962 *** TODO write article about the Earth for the Guide |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3963 The editor in charge is [[bbdb:Ford Prefect]] |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3964 DEADLINE: <2004-02-29 Sun> |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3965 @end example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3966 |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
3967 You can specify a different lead time for warnings for a specific |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
3968 deadlines using the following syntax. Here is an example with a warning |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
3969 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
3970 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3971 @item SCHEDULED |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3972 @cindex SCHEDULED keyword |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3973 You are planning to start working on that task on the given date. The |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3974 headline will be listed under the given date@footnote{It will still be |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3975 listed on that date after it has been marked DONE. If you don't like |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3976 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3977 addition, a reminder that the scheduled date has passed will be present |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3978 in the compilation for @emph{today}, until the entry is marked DONE. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3979 I.e., the task will automatically be forwarded until completed. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3980 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3981 @example |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3982 *** TODO Call Trillian for a date on New Years Eve. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3983 SCHEDULED: <2004-12-25 Sat> |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
3984 @end example |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3985 @end table |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3986 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3987 @menu |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
3988 * Inserting deadline/schedule:: Planning items |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
3989 * Repeated tasks:: Items that show up again and again |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3990 @end menu |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3991 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3992 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3993 @subsection Inserting deadline/schedule |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3994 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3995 The following commands allow to quickly insert a deadline or to schedule |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3996 an item: |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3997 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3998 @table @kbd |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
3999 @c |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4000 @kindex C-c C-d |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4001 @item C-c C-d |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4002 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4003 happen in the line directly following the headline. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4004 @c FIXME Any CLOSED timestamp will be removed.???????? |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4005 @c |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4006 @kindex C-c C-w |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4007 @cindex sparse tree, for deadlines |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4008 @item C-c C-w |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4009 Create a sparse tree with all deadlines that are either past-due, or |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4010 which will become due within @code{org-deadline-warning-days}. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4011 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4012 prefix, check that many days. For example, @kbd{C-1 C-c C-w} shows |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4013 all deadlines due tomorrow. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4014 @c |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4015 @kindex C-c C-s |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4016 @item C-c C-s |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4017 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4018 happen in the line directly following the headline. Any CLOSED |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4019 timestamp will be removed. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4020 @end table |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4021 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4022 @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4023 @subsection Repeated Tasks |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4024 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4025 Some tasks need to be repeated again and again, and Org-mode therefore |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4026 allows to use a repeater in a DEADLINE or SCHEDULED time stamp, for |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4027 example: |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4028 @example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4029 ** TODO Pay the rent |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4030 DEADLINE: <2005-10-01 Sat +1m> |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4031 @end example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4032 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4033 Deadlines and scheduled items produce entries in the agenda when they |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4034 are over-due, so it is important to be able to mark such an entry as |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4035 completed once you have done so. When you mark a DEADLINE or a SCHEDULE |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4036 with the todo keyword DONE, it will no longer produce entries in the |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4037 agenda. The problem with this is, however, that then also the |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4038 @emph{next} instance of the repeated entry will not be active. Org-mode |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4039 deals with this in the following way: When you try to mark such an entry |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4040 DONE (using @kbd{C-c C-t}), it will shift the base date of the repeating |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4041 time stamp by the repeater interval, and immediately set the entry state |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4042 back to TODO. In the example above, setting the state to DONE would |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4043 actually switch the date like this: |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4044 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4045 @example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4046 ** TODO Pay the rent |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4047 DEADLINE: <2005-11-01 Tue +1m> |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4048 @end example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4049 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4050 You will also be prompted for a note that will be put under the DEADLINE |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4051 line to keep a record that you actually acted on the previous instance |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4052 of this deadline. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4053 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4054 As a consequence of shifting the base date, this entry will no longer be |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4055 visible in the agenda when checking past dates, but all future instances |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4056 will be visible. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4057 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4058 You may have both scheduling and deadline information for a specific |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4059 task - just make sure that the repeater intervals on both are the same. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4060 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4061 @node Progress logging, , Deadlines and scheduling, Timestamps |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4062 @section Progress Logging |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4063 @cindex progress logging |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4064 @cindex logging, of progress |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4065 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4066 Org-mode can automatically record a time stamp when you mark a TODO item |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4067 as DONE, or even each time when you change the state of a TODO item. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4068 You can also measure precisely the time you spent on specific items in a |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4069 project by starting and stopping a clock when you start and stop working |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4070 on an aspect of a project. |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4071 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4072 @menu |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
4073 * Closing items:: When was this entry marked DONE? |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4074 * Tracking TODO state changes:: When did the status change? |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4075 * 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
|
4076 @end menu |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4077 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4078 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4079 @subsection Closing items |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4080 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4081 If you want to keep track of @emph{when} a certain TODO item was |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4082 finished, turn on logging with@footnote{The corresponding in-buffer |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4083 setting is: @code{#+STARTUP: logdone}} |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4084 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4085 @lisp |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4086 (setq org-log-done t) |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4087 @end lisp |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4088 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4089 @noindent |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4090 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
|
4091 C-t} in the Org-mode buffer or @kbd{t} in the agenda buffer, a line |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4092 @samp{CLOSED: [timestamp]} will be inserted just after the headline. If |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4093 you turn the entry back into a TODO item through further state cycling, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4094 that line will be removed again. In the timeline (@pxref{Timeline}) and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4095 in the agenda (@pxref{Weekly/Daily agenda}), you can then use the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4096 @kbd{l} key to display the TODO items closed on each day, giving you an |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4097 overview of what has been done on a day. If you want to record a note |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4098 along with the timestamp, use@footnote{The corresponding in-buffer |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4099 setting is: @code{#+STARTUP: lognotedone}} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4100 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4101 @lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4102 (setq org-log-done '(done)) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4103 @end lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4104 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4105 @node Tracking TODO state changes, Clocking work time, Closing items, Progress logging |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4106 @subsection Tracking TODO state changes |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4107 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4108 When TODO keywords are used as workflow states (@pxref{Workflow |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4109 states}), you might want to keep track of when a state change occurred, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4110 and you may even want to attach notes to that state change. With the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4111 setting |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4112 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4113 @lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4114 (setq org-log-done '(state)) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4115 @end lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4116 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4117 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4118 each state change will prompt you for a note that will be attached to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4119 the current headline. Very likely you do not want this verbose tracking |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4120 all the time, so it is probably better to configure this behavior with |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4121 in-buffer options. For example, if you are tracking purchases, put |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4122 these into a separate file that starts with: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4123 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4124 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4125 #+SEQ_TODO: TODO ORDERED INVOICE PAYED RECEIVED SENT |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4126 #+STARTUP: lognotestate |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4127 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4128 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4129 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4130 @node Clocking work time, , Tracking TODO state changes, Progress logging |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4131 @subsection Clocking work time |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4132 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4133 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
|
4134 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
|
4135 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
|
4136 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
|
4137 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
|
4138 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4139 @table @kbd |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4140 @kindex C-c C-x C-i |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4141 @item C-c C-x C-i |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4142 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
|
4143 keyword together with a timestamp. |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4144 @kindex C-c C-x C-o |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4145 @item C-c C-x C-o |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4146 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
|
4147 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
|
4148 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
|
4149 HH:MM}. See the variable @code{org-log-done} for the possibility to |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4150 record an additional note together with the clock-out time |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4151 stamp@footnote{The corresponding in-buffer setting is: @code{#+STARTUP: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4152 lognoteclock-out}}. |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
4153 @kindex C-c C-y |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
4154 @item C-c C-y |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
4155 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
|
4156 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
|
4157 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
|
4158 @kindex C-c C-t |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4159 @item C-c C-t |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4160 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
|
4161 if it is running in this same item. |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4162 @kindex C-c C-x C-x |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4163 @item C-c C-x C-x |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4164 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
|
4165 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
|
4166 @kindex C-c C-x C-d |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4167 @item C-c C-x C-d |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4168 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
|
4169 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
|
4170 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
|
4171 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
|
4172 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
|
4173 @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
|
4174 @kindex C-c C-x C-r |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
4175 @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
|
4176 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
|
4177 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
|
4178 @example |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
4179 #+BEGIN: clocktable :maxlevel 2 :emphasize nil |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
4180 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
4181 #+END: clocktable |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
4182 @end example |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
4183 @noindent |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
4184 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
|
4185 table. The @samp{BEGIN} line can specify options: |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
4186 @example |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
4187 :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
|
4188 :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
|
4189 :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
|
4190 @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
|
4191 @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
|
4192 @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
|
4193 :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
|
4194 :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
|
4195 @end example |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
4196 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
|
4197 @example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
4198 #+BEGIN: clocktable :maxlevel 2 :block today |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
4199 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
4200 #+END: clocktable |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
4201 @end example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
4202 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
|
4203 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
|
4204 only to fit it onto the manual.} |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
4205 @example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
4206 #+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
|
4207 :tend "<2006-08-10 Thu 12:00>" |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
4208 |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
4209 #+END: clocktable |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
4210 @end example |
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
4211 @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
|
4212 @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
|
4213 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
|
4214 you have several clocktable blocks in a buffer. |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4215 @end table |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4216 |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4217 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
|
4218 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
|
4219 worked on or closed during a day. |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4220 |
81465
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
4221 @node Agenda views, Embedded LaTeX, Timestamps, Top |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4222 @chapter Agenda Views |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4223 @cindex agenda views |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4224 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4225 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
|
4226 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
|
4227 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
|
4228 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
|
4229 sorted and displayed in an organized way. |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4230 |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4231 Org-mode can select items based on various criteria, and display them |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4232 in a separate buffer. Six different view types are provided: |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4233 |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4234 @itemize @bullet |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4235 @item |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4236 an @emph{agenda} that is like a calendar and shows information |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4237 for specific dates, |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4238 @item |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4239 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
|
4240 action items, |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4241 @item |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4242 a @emph{tags view}, showings headlines based on |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4243 the tags associated with them, |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4244 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4245 a @emph{timeline view} that shows all events in a single Org-mode file, |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4246 in time-sorted view, |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4247 @item |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4248 a @emph{stuck projects view} showing projects that currently don't move |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4249 along, and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4250 @item |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4251 @emph{custom views} that are special tag/keyword searches and |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4252 combinations of different views. |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4253 @end itemize |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4254 |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4255 @noindent |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4256 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
|
4257 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
|
4258 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
|
4259 edit these files remotely. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4260 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4261 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
|
4262 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
|
4263 @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
|
4264 @code{org-agenda-restore-windows-after-quit}. |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4265 |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4266 @menu |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4267 * Agenda files:: Files being searched for agenda information |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4268 * Agenda dispatcher:: Keyboard access to agenda views |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4269 * Built-in agenda views:: What is available out of the box? |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4270 * 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
|
4271 * 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
|
4272 * Custom agenda views:: Defining special searches and views |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4273 @end menu |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4274 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
4275 @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
|
4276 @section Agenda files |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4277 @cindex agenda files |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4278 @cindex files for agenda |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4279 |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4280 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
|
4281 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
|
4282 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
|
4283 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
|
4284 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
|
4285 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
|
4286 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
|
4287 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
|
4288 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
|
4289 the easiest way to maintain it is through the following commands |
58792 | 4290 |
4291 @cindex files, adding to agenda list | |
4292 @table @kbd | |
4293 @kindex C-c [ | |
4294 @item C-c [ | |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
4295 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
|
4296 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
|
4297 the front. With prefix arg, file is added/moved to the end. |
58792 | 4298 @kindex C-c ] |
4299 @item C-c ] | |
4300 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
|
4301 @kindex C-, |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4302 @kindex C-' |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
4303 @item C-, |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4304 @itemx C-' |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4305 Cycle through agenda file list, visiting one file after the other. |
58792 | 4306 @end table |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4307 |
58792 | 4308 @noindent |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4309 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
|
4310 to visit any of them. |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4311 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4312 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda views |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4313 @section The agenda dispatcher |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4314 @cindex agenda dispatcher |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4315 @cindex dispatching agenda commands |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4316 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
|
4317 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
|
4318 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
|
4319 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
|
4320 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
|
4321 command. The dispatcher offers the following default commands: |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4322 @table @kbd |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4323 @item a |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
4324 Create the calendar-like agenda (@pxref{Weekly/Daily agenda}). |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4325 @item t @r{/} T |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4326 Create a list of all TODO items (@pxref{Global TODO list}). |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4327 @item m @r{/} M |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4328 Create a list of headlines matching a TAGS expression (@pxref{Matching |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
4329 tags and properties}). |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4330 @item L |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4331 Create the timeline view for the current buffer (@pxref{Timeline}). |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4332 @item # @r{/} ! |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4333 Create a list of stuck projects (@pxref{Stuck projects}). |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4334 @item 1 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4335 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
|
4336 @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
|
4337 @item 0 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4338 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
|
4339 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
|
4340 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
|
4341 command. |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4342 @end table |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4343 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4344 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
|
4345 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
|
4346 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
|
4347 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
|
4348 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
|
4349 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4350 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda views |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4351 @section The built-in agenda views |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4352 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4353 In this section we describe the built-in views. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4354 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4355 @menu |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4356 * Weekly/Daily agenda:: The calendar page with current tasks |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4357 * Global TODO list:: All unfinished action items |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
4358 * Matching tags and properties:: Structured information with fine-tuned search |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4359 * Timeline:: Time-sorted view for single file |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4360 * Stuck projects:: Find projects you need to review |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4361 @end menu |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4362 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4363 @node Weekly/Daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4364 @subsection The weekly/daily agenda |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4365 @cindex agenda |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4366 @cindex weekly agenda |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4367 @cindex daily agenda |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4368 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4369 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
|
4370 paper agenda, showing all the tasks for the current week or day. |
58792 | 4371 |
4372 @table @kbd | |
4373 @cindex org-agenda, command | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4374 @kindex C-c a a |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4375 @item C-c a a |
58792 | 4376 Compile an agenda for the current week from a list of org files. The |
4377 agenda shows the entries for each day. With a @kbd{C-u} prefix (or | |
4378 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
|
4379 unfinished TODO items (including those without a date) are also listed at |
58792 | 4380 the beginning of the buffer, before the first date.@* |
4381 @end table | |
4382 | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4383 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
|
4384 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
|
4385 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
|
4386 commands}. |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4387 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4388 @subsubheading Calendar/Diary integration |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4389 @cindex calendar integration |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4390 @cindex diary integration |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4391 |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4392 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
|
4393 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
|
4394 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
|
4395 anniversaries, lunar phases, sunrise/set, recurrent appointments |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4396 (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
|
4397 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
|
4398 the diary. |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4399 |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4400 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
|
4401 agenda, you only need to customize the variable |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4402 |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4403 @lisp |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4404 (setq org-agenda-include-diary t) |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4405 @end lisp |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4406 |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4407 @noindent After that, everything will happen automatically. All diary |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4408 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
|
4409 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
|
4410 @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
|
4411 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
|
4412 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
|
4413 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
|
4414 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
|
4415 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
|
4416 between calendar and agenda. |
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4417 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4418 If you are using the diary only for sexp entries and holidays, it is |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4419 faster to not use the above setting, but instead to copy or even move |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4420 the entries into an Org-mode file. Org-mode evaluates diary-style sexp |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4421 entries, and does it faster because there is no overhead for first |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4422 creating the diary display. Note that the sexp entries must start at |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4423 the left margin, no white space is allowed before them. For example, |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4424 the following segment of an Org-mode file will be processed and entries |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4425 will be made in the agenda: |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4426 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4427 @example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4428 * Birthdays and similar stuff |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4429 #+CATEGORY: Holiday |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4430 %%(org-calendar-holiday) ; special function for holiday names |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4431 #+CATEGORY: Ann |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
4432 %%(diary-anniversary 14 5 1956) Arthur Dent is %d years old |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4433 %%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4434 @end example |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4435 |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
4436 @node Global TODO list, Matching tags and properties, Weekly/Daily agenda, Built-in agenda views |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4437 @subsection The global TODO list |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4438 @cindex global TODO list |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4439 @cindex TODO list, global |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4440 |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4441 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
|
4442 collected into a single place. |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4443 |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4444 @table @kbd |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4445 @kindex C-c a t |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4446 @item C-c a t |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4447 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
|
4448 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
|
4449 @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
|
4450 the TODO entries directly from that buffer (@pxref{Agenda commands}). |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4451 @kindex C-c a T |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4452 @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
|
4453 @cindex TODO keyword matching |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4454 Like the above, but allows selection of a specific TODO keyword. You |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4455 can also do this by specifying a prefix argument to @kbd{C-c a t}. With |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4456 a @kbd{C-u} prefix you are prompted for a keyword, and you may also |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4457 specify several keywords by separating them with @samp{|} as boolean OR |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4458 operator. With a numeric prefix, the Nth keyword in |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4459 @code{org-todo-keywords} is selected. |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4460 @kindex r |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4461 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
|
4462 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
|
4463 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
|
4464 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
|
4465 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
|
4466 search (@pxref{Tag searches}). |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4467 @end table |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4468 |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
4469 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
|
4470 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
|
4471 TODO list are described in @ref{Agenda commands}. |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4472 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4473 @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
|
4474 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
|
4475 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
|
4476 it more compact: |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4477 @itemize @minus |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4478 @item |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4479 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
|
4480 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
|
4481 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
|
4482 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
|
4483 @item |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4484 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
|
4485 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
|
4486 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
|
4487 @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
|
4488 @end itemize |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4489 |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
4490 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
4491 @subsection Matching Tags and Properties |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4492 @cindex matching, of tags |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
4493 @cindex matching, of properties |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4494 @cindex tags view |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4495 |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4496 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
|
4497 (@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
|
4498 to them and collect them into an agenda buffer. |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4499 |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4500 @table @kbd |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4501 @kindex C-c a m |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4502 @item C-c a m |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4503 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
|
4504 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
|
4505 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
|
4506 @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
|
4507 define a custom command for it (@pxref{Agenda dispatcher}). |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4508 @kindex C-c a M |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4509 @item C-c a M |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4510 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
|
4511 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
|
4512 @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
|
4513 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
|
4514 @end table |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4515 |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4516 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
|
4517 commands}. |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4518 |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
4519 @node Timeline, Stuck projects, Matching tags and properties, Built-in agenda views |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4520 @subsection Timeline for a single file |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4521 @cindex timeline, single file |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4522 @cindex time-sorted view |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4523 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4524 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
|
4525 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
|
4526 to give an overview over events in a project. |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4527 |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4528 @table @kbd |
81838
09c82a1bcb6f
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81789
diff
changeset
|
4529 @kindex C-c a L |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4530 @item C-c a L |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4531 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
|
4532 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
|
4533 (scheduled or not) are also listed under the current date. |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4534 @end table |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4535 |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4536 @noindent |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4537 The commands available in the timeline buffer are listed in |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4538 @ref{Agenda commands}. |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4539 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4540 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4541 @node Stuck projects, , Timeline, Built-in agenda views |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4542 @subsection Stuck projects |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4543 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4544 If you are following a system like David Allen's GTD to organize your |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4545 work, one of the ``duties'' you have is a regular review to make sure |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4546 that all projects move along. A @emph{stuck} project is a project that |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4547 has no defined next actions, so it will never show up in the TODO lists |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4548 Org-mode produces. During the review, you need to identify such |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4549 projects and define next actions for them. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4550 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4551 @table @kbd |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4552 @kindex C-c a # |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4553 @item C-c a # |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4554 List projects that are stuck. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4555 @kindex C-c a ! |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4556 @item C-c a ! |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4557 Customize the variable @code{org-stuck-projects} to define what a stuck |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4558 project is and how to find it. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4559 @end table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4560 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4561 You almost certainly will have to configure this view before it will |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4562 work for you. The built-in default assumes that all your projects are |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4563 level-2 headlines, and that a project is not stuck if it has at least |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4564 one entry marked with a todo keyword TODO or NEXT or NEXTACTION. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4565 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4566 Lets assume that you, in your own way of using Org-mode, identify |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4567 projects with a tag PROJECT, and that you use a todo keyword MAYBE to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4568 indicate a project that should not be considered yet. Lets further |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4569 assume that the todo keyword DONE marks finished projects, and that NEXT |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4570 and TODO indicate next actions. The tag @@SHOP indicates shopping and |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4571 is a next action even without the NEXT tag. Finally, if the project |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4572 contains the special word IGNORE anywhere, it should not be listed |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4573 either. In this case you would start by identifying eligible projects |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4574 with a tags/todo match @samp{+PROJECT/-MAYBE-DONE}, and then check for |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4575 TODO, NEXT, @@SHOP, and IGNORE in the subtree to identify projects that |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4576 are not stuck. The correct customization for this is |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4577 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4578 @lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4579 (setq org-stuck-projects |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4580 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP") |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4581 "\\<IGNORE\\>")) |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4582 @end lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4583 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4584 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4585 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda views |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4586 @section Presentation and sorting |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4587 @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
|
4588 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4589 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
|
4590 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
|
4591 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
|
4592 (@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
|
4593 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
|
4594 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
|
4595 associated with the item. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4596 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4597 @menu |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4598 * 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
|
4599 * 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
|
4600 * 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
|
4601 @end menu |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4602 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4603 @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
|
4604 @subsection Categories |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4605 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4606 @cindex category |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4607 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
|
4608 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
|
4609 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
|
4610 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4611 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4612 #+CATEGORY: Thesis |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4613 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4614 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4615 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
|
4616 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
|
4617 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
|
4618 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
|
4619 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4620 @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
|
4621 @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
|
4622 @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
|
4623 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4624 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
|
4625 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
|
4626 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
|
4627 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
|
4628 @c |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4629 @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
|
4630 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4631 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
|
4632 plain text (like @samp{12:45} or a @samp{8:30-1pm}. If the agenda |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4633 integrates the Emacs diary (@pxref{Weekly/Daily agenda}), time |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4634 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
|
4635 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4636 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
|
4637 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
|
4638 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
|
4639 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4640 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4641 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
|
4642 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
|
4643 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
|
4644 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
|
4645 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4646 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4647 @cindex time grid |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4648 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
|
4649 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
|
4650 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4651 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4652 8:00...... ------------------ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4653 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
|
4654 10:00...... ------------------ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4655 12:00...... ------------------ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4656 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
|
4657 14:00...... ------------------ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4658 16:00...... ------------------ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4659 18:00...... ------------------ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4660 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
|
4661 20:00...... ------------------ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4662 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
|
4663 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4664 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4665 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
|
4666 @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
|
4667 @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
|
4668 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4669 @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
|
4670 @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
|
4671 @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
|
4672 @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
|
4673 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
|
4674 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
|
4675 @itemize @bullet |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4676 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4677 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
|
4678 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
|
4679 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
|
4680 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
|
4681 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
|
4682 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
|
4683 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
|
4684 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
|
4685 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
|
4686 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4687 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
|
4688 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
|
4689 (@pxref{Priorities}). |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4690 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4691 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
|
4692 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
|
4693 @end itemize |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4694 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4695 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
|
4696 @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
|
4697 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4698 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4699 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda views |
58792 | 4700 @section Commands in the agenda buffer |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4701 @cindex commands, in agenda buffer |
58792 | 4702 |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4703 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
|
4704 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
|
4705 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
|
4706 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
|
4707 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
|
4708 removing the risk that your agenda and note files may diverge. |
58792 | 4709 |
4710 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
|
4711 the other commands, the cursor needs to be in the desired line. |
58792 | 4712 |
4713 @table @kbd | |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4714 @tsubheading{Motion} |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4715 @cindex motion commands in agenda |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4716 @kindex n |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4717 @item n |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4718 Next line (same as @key{up}). |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4719 @kindex p |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4720 @item p |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4721 Previous line (same as @key{down}). |
58792 | 4722 @tsubheading{View/GoTo org file} |
4723 @kindex mouse-3 | |
4724 @kindex @key{SPC} | |
4725 @item mouse-3 | |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
4726 @itemx @key{SPC} |
58792 | 4727 Display the original location of the item in another window. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4728 @c |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4729 @kindex L |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4730 @item L |
58792 | 4731 Display original location and recenter that window. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4732 @c |
58792 | 4733 @kindex mouse-2 |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
4734 @kindex mouse-1 |
58792 | 4735 @kindex @key{TAB} |
4736 @item mouse-2 | |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
4737 @itemx mouse-1 |
58792 | 4738 @itemx @key{TAB} |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
4739 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
|
4740 22, @kbd{mouse-1} will also works for this. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4741 @c |
58792 | 4742 @kindex @key{RET} |
4743 @itemx @key{RET} | |
4744 Go to the original location of the item and delete other windows. | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4745 @c |
58792 | 4746 @kindex f |
4747 @item f | |
67537
f0c77dab544c
(Progress Logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
67382
diff
changeset
|
4748 Toggle Follow mode. In Follow mode, as you move the cursor through |
58792 | 4749 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
|
4750 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
|
4751 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
|
4752 @code{org-agenda-start-with-follow-mode}. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4753 @c |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4754 @kindex b |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4755 @item b |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4756 Display the entire subtree of the current item in an indirect buffer. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4757 With numerical prefix ARG, go up to this level and then take that tree. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4758 If ARG is negative, go up that many levels. With @kbd{C-u} prefix, do |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4759 not remove the previously used indirect buffer. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4760 @c |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4761 @kindex l |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
4762 @item l |
67537
f0c77dab544c
(Progress Logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
67382
diff
changeset
|
4763 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
|
4764 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
|
4765 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
|
4766 |
58792 | 4767 @tsubheading{Change display} |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4768 @cindex display changing, in agenda |
58792 | 4769 @kindex o |
4770 @item o | |
4771 Delete other windows. | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4772 @c |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
4773 @kindex d |
58792 | 4774 @kindex w |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
4775 @kindex m |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
4776 @kindex y |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
4777 @item d w m y |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
4778 Switch to day/week/month/year view. When switching to day or week view, |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
4779 this setting becomes the default for subseqent agenda commands. Since |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
4780 month and year views are slow to create, the do not become the default. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4781 @c |
63833 | 4782 @kindex D |
4783 @item D | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4784 Toggle the inclusion of diary entries. See @ref{Weekly/Daily agenda}. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4785 @c |
62548 | 4786 @kindex g |
4787 @item g | |
4788 Toggle the time grid on and off. See also the variables | |
4789 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}. | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4790 @c |
58792 | 4791 @kindex r |
4792 @item r | |
4793 Recreate the agenda buffer, for example to reflect the changes | |
4794 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
|
4795 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
|
4796 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
|
4797 keyword. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4798 @c |
71564
947e64a6bc0e
(Agenda commands): Document `s' key to save all
Carsten Dominik <dominik@science.uva.nl>
parents:
71525
diff
changeset
|
4799 @kindex s |
947e64a6bc0e
(Agenda commands): Document `s' key to save all
Carsten Dominik <dominik@science.uva.nl>
parents:
71525
diff
changeset
|
4800 @item s |
947e64a6bc0e
(Agenda commands): Document `s' key to save all
Carsten Dominik <dominik@science.uva.nl>
parents:
71525
diff
changeset
|
4801 Save all Org-mode buffers in the current Emacs session. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4802 @c |
58792 | 4803 @kindex @key{right} |
4804 @item @key{right} | |
4805 Display the following @code{org-agenda-ndays} days. For example, if | |
4806 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
|
4807 arg, go forward that many times @code{org-agenda-ndays} days. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4808 @c |
58792 | 4809 @kindex @key{left} |
4810 @item @key{left} | |
68033
59e35f6b8ff4
(Agenda Views): Chapter reorganized.
Carsten Dominik <dominik@science.uva.nl>
parents:
67884
diff
changeset
|
4811 Display the previous dates. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4812 @c |
58792 | 4813 @kindex . |
4814 @item . | |
4815 Goto today. | |
4816 | |
4817 @tsubheading{Remote editing} | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4818 @cindex remote editing, from agenda |
58792 | 4819 |
4820 @item 0-9 | |
4821 Digit argument. | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4822 @c |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4823 @cindex undoing remote-editing events |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4824 @cindex remote editing, undo |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4825 @kindex C-_ |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4826 @item C-_ |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4827 Undo a change due to a remote editing command. The change is undone |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4828 both in the agenda buffer and in the remote buffer. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4829 @c |
58792 | 4830 @kindex t |
4831 @item t | |
4832 Change the TODO state of the item, both in the agenda and in the | |
4833 original org file. | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4834 @c |
74030 | 4835 @kindex C-k |
4836 @item C-k | |
4837 Delete the current agenda item along with the entire subtree belonging | |
4838 to it in the original Org-mode file. If the text to be deleted remotely | |
4839 is longer than one line, the kill needs to be confirmed by the user. See | |
4840 variable @code{org-agenda-confirm-kill}. | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4841 @c |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4842 @kindex $ |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4843 @item $ |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4844 Archive the subtree corresponding to the current headline. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4845 @c |
68173
73b14864a9b7
(Agenda commands): Document tags command.
Carsten Dominik <dominik@science.uva.nl>
parents:
68060
diff
changeset
|
4846 @kindex T |
73b14864a9b7
(Agenda commands): Document tags command.
Carsten Dominik <dominik@science.uva.nl>
parents:
68060
diff
changeset
|
4847 @item T |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4848 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
|
4849 inheritance, this may be more than the tags listed in the line itself. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4850 @c |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
4851 @kindex : |
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
4852 @item : |
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
4853 Set tags for the current headline. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4854 @c |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4855 @kindex a |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4856 @item a |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
4857 Toggle the ARCHIVE tag for the current headline. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4858 @c |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4859 @kindex , |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4860 @item , |
58792 | 4861 Set the priority for the current item. Org-mode prompts for the |
4862 priority character. If you reply with @key{SPC}, the priority cookie | |
4863 is removed from the entry. | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4864 @c |
58792 | 4865 @kindex P |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
4866 @item P |
58792 | 4867 Display weighted priority of current item. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4868 @c |
58792 | 4869 @kindex + |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4870 @kindex S-@key{up} |
58792 | 4871 @item + |
63833 | 4872 @itemx S-@key{up} |
58792 | 4873 Increase the priority of the current item. The priority is changed in |
4874 the original buffer, but the agenda is not resorted. Use the @kbd{r} | |
4875 key for this. | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4876 @c |
58792 | 4877 @kindex - |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4878 @kindex S-@key{down} |
58792 | 4879 @item - |
63833 | 4880 @itemx S-@key{down} |
58792 | 4881 Decrease the priority of the current item. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4882 @c |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4883 @kindex C-c C-s |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4884 @item C-c C-s |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4885 Schedule this item |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4886 @c |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4887 @kindex C-c C-d |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4888 @item C-c C-d |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
4889 Set a deadline for this item. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4890 @c |
58792 | 4891 @kindex S-@key{right} |
4892 @item S-@key{right} | |
4893 Change the time stamp associated with the current line by one day into | |
4894 the future. With prefix argument, change it by that many days. For | |
4895 example, @kbd{3 6 5 S-@key{right}} will change it by a year. The | |
4896 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
|
4897 directly reflected in the agenda buffer. Use the |
58792 | 4898 @kbd{r} key to update the buffer. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4899 @c |
58792 | 4900 @kindex S-@key{left} |
4901 @item S-@key{left} | |
4902 Change the time stamp associated with the current line by one day | |
4903 into the past. | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4904 @c |
58792 | 4905 @kindex > |
4906 @item > | |
4907 Change the time stamp associated with the current line to today. | |
4908 The key @kbd{>} has been chosen, because it is the same as @kbd{S-.} | |
4909 on my keyboard. | |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4910 @c |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4911 @kindex I |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4912 @item I |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4913 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
|
4914 is stopped first. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4915 @c |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4916 @kindex O |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4917 @item O |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4918 Stop the previously started clock. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4919 @c |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4920 @kindex X |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4921 @item X |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4922 Cancel the currently running clock. |
58792 | 4923 |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4924 @tsubheading{Calendar commands} |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4925 @cindex calendar commands, from agenda |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4926 @kindex c |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4927 @item c |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4928 Open the Emacs calendar and move to the date at the agenda cursor. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4929 @c |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4930 @item c |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4931 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
|
4932 date at the cursor. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4933 @c |
71312
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4934 @cindex diary entries, creating from agenda |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4935 @kindex i |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4936 @item i |
e050af4a9e72
(Progress logging): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
71246
diff
changeset
|
4937 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
|
4938 (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
|
4939 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
|
4940 The date is taken from the cursor position. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4941 @c |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4942 @kindex M |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4943 @item M |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4944 Show the phases of the moon for the three months around current date. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4945 @c |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4946 @kindex S |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4947 @item S |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4948 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
|
4949 with calendar variables, see documentation of the Emacs calendar. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4950 @c |
61562
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4951 @kindex C |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4952 @item C |
6cd3b18f298e
Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents:
61136
diff
changeset
|
4953 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
|
4954 calendars. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4955 @c |
61136
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4956 @kindex H |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4957 @item H |
003dd96023ff
updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents:
59542
diff
changeset
|
4958 Show holidays for three month around the cursor date. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4959 @c |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
4960 @c FIXME: This should be a different key. |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4961 @kindex C-c C-x C-c |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4962 @item C-c C-x C-c |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
4963 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
|
4964 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4965 @tsubheading{Exporting to a file} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4966 @kindex C-x C-w |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4967 @item C-x C-w |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4968 @cindex exporting agenda views |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4969 @cindex agenda views, exporting |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4970 Write the agenda view to a file. Depending on the extension of the |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4971 selected file name, the view will be exported as HTML (extension |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4972 @file{.html} or @file{.htm}), Postscript (extension @file{.ps}), or |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4973 plain text (any other extension). Use the variable |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4974 @code{org-agenda-exporter-settings} to set options for @file{ps-print} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4975 and for @file{htmlize} to be used during export. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4976 |
58792 | 4977 @tsubheading{Quit and Exit} |
4978 @kindex q | |
4979 @item q | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
4980 Quit agenda, remove the agenda buffer. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
4981 @c |
58792 | 4982 @kindex x |
4983 @cindex agenda files, removing buffers | |
4984 @item x | |
4985 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs | |
4986 for the compilation of the agenda. Buffers created by the user to | |
4987 visit org files will not be removed. | |
4988 @end table | |
4989 | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4990 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4991 @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
|
4992 @section Custom agenda views |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4993 @cindex custom agenda views |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4994 @cindex agenda views, custom |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4995 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
4996 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
|
4997 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
|
4998 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
|
4999 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
|
5000 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5001 @menu |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5002 * 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
|
5003 * 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
|
5004 * Setting Options:: Changing the rules |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5005 * Exporting Agenda Views:: Writing agendas to files. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5006 * Extracting Agenda Information for other programs:: |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5007 @end menu |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5008 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5009 @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
|
5010 @subsection Storing searches |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5011 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5012 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
|
5013 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
|
5014 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
|
5015 buffer). |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5016 @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
|
5017 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
|
5018 @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
|
5019 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
|
5020 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
|
5021 search types: |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5022 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5023 @lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5024 @group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5025 (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
|
5026 '(("w" todo "WAITING") |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5027 ("W" todo-tree "WAITING") |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5028 ("u" tags "+BOSS-URGENT") |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5029 ("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
|
5030 ("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
|
5031 ("f" occur-tree "\\<FIXME\\>"))) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5032 @end group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5033 @end lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5034 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5035 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5036 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
|
5037 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
|
5038 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
|
5039 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
|
5040 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
|
5041 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5042 @table @kbd |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5043 @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
|
5044 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
|
5045 keyword |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5046 @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
|
5047 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
|
5048 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
|
5049 @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
|
5050 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
|
5051 @samp{:URGENT:} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5052 @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
|
5053 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
|
5054 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
|
5055 @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
|
5056 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
|
5057 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
|
5058 @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
|
5059 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
|
5060 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
|
5061 @end table |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5062 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5063 @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
|
5064 @subsection Block agenda |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5065 @cindex block agenda |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5066 @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
|
5067 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5068 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
|
5069 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
|
5070 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
|
5071 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
|
5072 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
|
5073 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
|
5074 @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
|
5075 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5076 @lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5077 @group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5078 (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
|
5079 '(("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
|
5080 ((agenda) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5081 (tags-todo "HOME") |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5082 (tags "GARDEN"))) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5083 ("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
|
5084 ((agenda) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5085 (tags-todo "WORK") |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5086 (tags "OFFICE"))))) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5087 @end group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5088 @end lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5089 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5090 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5091 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
|
5092 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
|
5093 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
|
5094 @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
|
5095 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
|
5096 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5097 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5098 @node Setting Options, Exporting Agenda Views, Block agenda, Custom agenda views |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5099 @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
|
5100 @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
|
5101 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5102 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
|
5103 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
|
5104 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
|
5105 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
|
5106 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
|
5107 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
|
5108 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5109 @lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5110 @group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5111 (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
|
5112 '(("w" todo "WAITING" |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5113 ((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
|
5114 (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
|
5115 ("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
|
5116 ((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
|
5117 (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
|
5118 @end group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5119 @end lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5120 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5121 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5122 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
|
5123 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
|
5124 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
|
5125 @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
|
5126 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
|
5127 will be shown. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5128 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5129 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
|
5130 @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
|
5131 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
|
5132 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
|
5133 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
|
5134 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
|
5135 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
|
5136 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
|
5137 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
|
5138 @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
|
5139 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5140 @lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5141 @group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5142 (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
|
5143 '(("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
|
5144 ((agenda) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5145 (tags-todo "HOME") |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5146 (tags "GARDEN" |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5147 ((org-agenda-sorting-strategy '(priority-up))))) |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5148 ((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
|
5149 ("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
|
5150 ((agenda) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5151 (tags-todo "WORK") |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5152 (tags "OFFICE"))))) |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5153 @end group |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5154 @end lisp |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5155 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5156 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
|
5157 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
|
5158 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
|
5159 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
|
5160 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
|
5161 yourself. |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5162 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5163 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5164 @node Exporting Agenda Views, Extracting Agenda Information for other programs, Setting Options, Custom agenda views |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5165 @subsection Exporting Agenda Views |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5166 @cindex agenda views, exporting |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5167 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5168 If you are away from your computer, it can be very useful to have a |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5169 printed version of some agenda views to carry around. Org-mode can |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5170 export custom agenda views as plain text, HTML@footnote{You need to |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5171 install Hrvoje Niksic' @file{htmlize.el}.} and postscript. If you want |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5172 to do this only occasionally, use the command |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5173 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5174 @table @kbd |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5175 @kindex C-x C-w |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5176 @item C-x C-w |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5177 @cindex exporting agenda views |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5178 @cindex agenda views, exporting |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5179 Write the agenda view to a file. Depending on the extension of the |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5180 selected file name, the view will be exported as HTML (extension |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5181 @file{.html} or @file{.htm}), Postscript (extension @file{.ps}), or |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5182 plain text (any other extension). Use the variable |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5183 @code{org-agenda-exporter-settings} to set options for @file{ps-print} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5184 and for @file{htmlize} to be used during export, for example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5185 @lisp |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5186 (setq org-agenda-exporter-settings |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5187 '((ps-number-of-columns 2) |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5188 (ps-landscape-mode t) |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5189 (htmlize-output-type 'css))) |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5190 @end lisp |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5191 @end table |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5192 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5193 If you need to export certain agenda views frequently, you can associate |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5194 any custom agenda command with a list of output file names |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5195 @footnote{If you want to store standard views like the weekly agenda |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5196 or the global TODO list as well, you need to define custom commands for |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5197 them in order to be able to specify filenames.}. Here is an example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5198 that first does define custom commands for the agenda and the global |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5199 todo list, together with a number of files to which to export them. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5200 Then we define two block agenda commands and specify filenames for them |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5201 as well. File names can be relative to the current working directory, |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5202 or absolute. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5203 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5204 @lisp |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5205 @group |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5206 (setq org-agenda-custom-commands |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5207 '(("X" agenda "" nil ("agenda.html" "agenda.ps")) |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5208 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps")) |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5209 ("h" "Agenda and Home-related tasks" |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5210 ((agenda) |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5211 (tags-todo "HOME") |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5212 (tags "GARDEN")) |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5213 nil |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5214 ("~/views/home.html")) |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5215 ("o" "Agenda and Office-related tasks" |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5216 ((agenda) |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5217 (tags-todo "WORK") |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5218 (tags "OFFICE")) |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5219 nil |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5220 ("~/views/office.ps")))) |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5221 @end group |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5222 @end lisp |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5223 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5224 The extension of the file name determines the type of export. If it is |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5225 @file{.html}, Org-mode will use the @file{htmlize.el} package to convert |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5226 the buffer to HTML and save it to this file name. If the extension is |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5227 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5228 postscript output. Any other extension produces a plain ASCII file. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5229 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5230 The export files are @emph{not} created when you use one of those |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5231 commands interactively. Instead, there is a special command to produce |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5232 @emph{all} specified files in one step: |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5233 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5234 @table @kbd |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5235 @kindex C-c a e |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5236 @item C-c a e |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5237 Export all agenda views that have export filenames associated with |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5238 them. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5239 @end table |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5240 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5241 You can use the options section of the custom agenda commands to also |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5242 set options for the export commands. For example: |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5243 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5244 @lisp |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5245 (setq org-agenda-custom-commands |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5246 '(("X" agenda "" |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5247 ((ps-number-of-columns 2) |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5248 (ps-landscape-mode t) |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5249 (org-agenda-prefix-format " [ ] ") |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5250 (org-agenda-with-colors nil) |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5251 (org-agenda-remove-tags t)) |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5252 ("theagenda.ps")))) |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5253 @end lisp |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5254 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5255 @noindent |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5256 This command sets two options for the postscript exporter, to make it |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5257 print in two columns in landscape format - the resulting page can be cut |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5258 in two and then used in a paper agenda. The remaining settings modify |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5259 the agenda prefix to omit category and scheduling information, and |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5260 instead include a checkbox to check off items. We also remove the tags |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5261 to make the lines compact, and we don't want to use colors for the |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5262 black-and-white printer. Settings specified in |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5263 @code{org-agenda-exporter-settings} will also apply, but the settings |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5264 in @code{org-agenda-custom-commands} take precedence. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5265 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5266 @noindent |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5267 From the command line you may also use |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5268 @example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5269 emacs -f org-batch-store-agenda-views -kill |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5270 @end example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5271 @noindent |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5272 or, if you need to modify some parameters |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5273 @example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5274 emacs -eval '(org-batch-store-agenda-views \ |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5275 org-agenda-ndays 30 \ |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5276 org-agenda-include-diary nil \ |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5277 org-agenda-files (quote ("~/org/project.org")))' \ |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5278 -kill |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5279 @end example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5280 @noindent |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5281 which will create the agenda views restricted to the file |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5282 @file{~/org/project.org}, without diary entries and with 30 days |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5283 extent. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5284 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5285 @node Extracting Agenda Information for other programs, , Exporting Agenda Views, Custom agenda views |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5286 @subsection Extracting Agenda Information for other programs |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5287 @cindex agenda, pipe |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5288 @cindex Scripts, for agenda processing |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5289 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5290 Org-mode provides commands to access agenda information for the command |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5291 line in emacs batch mode. This extracted information can be sent |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5292 directly to a printer, or it can be read by a program that does further |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5293 processing of the data. The first of these commands is the function |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5294 @code{org-batch-agenda}, that produces an agenda view and sends it as |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5295 ASCII text to STDOUT. The command takes a single string as parameter. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5296 If the string has length 1, it is used as a key to one of the commands |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5297 you have configured in @code{org-agenda-custom-commands}, basically any |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5298 key you can use after @kbd{C-c a}. For example, to directly print the |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5299 current TODO list, you could use |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5300 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5301 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5302 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
|
5303 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5304 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5305 If the parameter is a string with 2 or more characters, it is used as a |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5306 tags/todo match string. For example, to print your local shopping list |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5307 (all items with the tag @samp{shop}, but excluding the tag |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5308 @samp{NewYork}), you could use |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5309 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5310 @example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5311 emacs -batch -l ~/.emacs \ |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5312 -eval '(org-batch-agenda "+shop-NewYork")' | lpr |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5313 @end example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5314 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5315 @noindent |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5316 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
|
5317 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5318 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5319 emacs -batch -l ~/.emacs \ |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5320 -eval '(org-batch-agenda "a" \ |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5321 org-agenda-ndays 30 \ |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5322 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
|
5323 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
|
5324 | lpr |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5325 @end example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5326 |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5327 @noindent |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5328 which will produce a 30 day agenda, fully restricted to the Org file |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5329 @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
|
5330 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5331 If you want to process the agenda data in more sophisticated ways, you |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5332 can use the command @code{org-batch-agenda-csv} to get a comma-separated |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5333 list of values for each agenda item. Each line in the output will |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5334 contain a number of fields separated by commas. The fields in a line |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5335 are: |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5336 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5337 @example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5338 category @r{The category of the item} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5339 head @r{The headline, without TODO kwd, TAGS and PRIORITY} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5340 type @r{The type of the agenda entry, can be} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5341 todo @r{selected in TODO match} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5342 tagsmatch @r{selected in tags match} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5343 diary @r{imported from diary} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5344 deadline @r{a deadline} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5345 scheduled @r{scheduled} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5346 timestamp @r{appointment, selected by timestamp} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5347 closed @r{entry was closed on date} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5348 upcoming-deadline @r{warning about nearing deadline} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5349 past-scheduled @r{forwarded scheduled item} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5350 block @r{entry has date block including date} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5351 todo @r{The todo keyword, if any} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5352 tags @r{All tags including inherited ones, separated by colons} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5353 date @r{The relevant date, like 2007-2-14} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5354 time @r{The time, like 15:00-16:50} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5355 extra @r{String with extra planning info} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5356 priority-l @r{The priority letter if any was given} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5357 priority-n @r{The computed numerical priority} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5358 @end example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5359 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5360 @noindent |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5361 Time and date will only be given if a timestamp (or deadline/scheduled) |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5362 lead to the selection of the item. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5363 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5364 A CSV list like this is very easy to use in a post processing script. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5365 For example, here is a Perl program that gets the TODO list from |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5366 Emacs/org-mode and prints all the items, preceded by a checkbox: |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5367 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5368 @example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5369 @group |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5370 #!/usr/bin/perl |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5371 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5372 # define the Emacs command to run |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5373 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'"; |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5374 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5375 # run it and capture the output |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5376 $agenda = qx@{$cmd 2>/dev/null@}; |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5377 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5378 # loop over all lines |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5379 foreach $line (split(/\n/,$agenda)) @{ |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5380 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5381 # get the individual values |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5382 ($category,$head,$type,$todo,$tags,$date,$time,$extra, |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5383 $priority_l,$priority_n) = split(/,/,$line); |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5384 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5385 # proccess and print |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5386 print "[ ] $head\n"; |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5387 @} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5388 @end group |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5389 @end example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5390 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5391 @node Embedded LaTeX, Exporting, Agenda views, Top |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5392 @chapter Embedded LaTeX |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5393 @cindex @TeX{} interpretation |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5394 @cindex La@TeX{} interpretation |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5395 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5396 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
|
5397 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
|
5398 contain mathematical symbols and the occasional formula. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5399 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
|
5400 @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
|
5401 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
|
5402 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
|
5403 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
|
5404 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
|
5405 into images for HTML production. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5406 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5407 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
|
5408 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
|
5409 to do with it. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5410 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5411 @menu |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5412 * Math symbols:: TeX macros for symbols and Greek letters |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5413 * Subscripts and Superscripts:: Simple syntax for raising/lowering text |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5414 * LaTeX fragments:: Complex formulas made easy |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5415 * Processing LaTeX fragments:: Previewing LaTeX processing |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5416 * CDLaTeX mode:: Speed up entering of formulas |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5417 @end menu |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5418 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5419 @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
|
5420 @section Math symbols |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5421 @cindex math symbols |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5422 @cindex TeX macros |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5423 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5424 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
|
5425 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
|
5426 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
|
5427 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
|
5428 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
|
5429 without surrounding math delimiters, for example: |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5430 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5431 @example |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5432 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
|
5433 @end example |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5434 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5435 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
|
5436 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
|
5437 @samp{α} and @samp{→}, respectively. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5438 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5439 @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
|
5440 @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
|
5441 @cindex subscript |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5442 @cindex superscript |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5443 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5444 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
|
5445 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
|
5446 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
|
5447 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
|
5448 with curly braces. For example |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5449 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5450 @example |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
5451 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
|
5452 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
|
5453 @end example |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5454 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5455 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
|
5456 @samp{^} and @samp{_} with a backslash: @samp{\_} and @samp{\^}. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5457 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5458 During HTML export (@pxref{HTML export}), subscript and superscripts |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5459 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
|
5460 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5461 @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
|
5462 @section LaTeX fragments |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
5463 @cindex LaTeX fragments |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5464 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5465 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
|
5466 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
|
5467 MathML, but that is not yet fully supported by many browsers, and there |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5468 is no decent converter for turning La@TeX{} or ASCII representations of |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5469 formulas into MathML. So for the time being, converting formulas into |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5470 images seems the way to go.}. More complex expressions need a dedicated |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5471 formula processor. To this end, Org-mode can contain arbitrary La@TeX{} |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5472 fragments. It provides commands to preview the typeset result of these |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5473 fragments, and upon export to HTML, all fragments will be converted to |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5474 images and inlined into the HTML document@footnote{The La@TeX{} export |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5475 will not use images for displaying La@TeX{} fragments but include these |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5476 fragments directly into the La@TeX{} code.}. For this to work you |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5477 need to be on a system with a working La@TeX{} installation. You also |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5478 need the @file{dvipng} program, available at |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5479 @url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5480 will be used when processing a fragment can be configured with the |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5481 variable @code{org-format-latex-header}. |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5482 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5483 La@TeX{} fragments don't need any special marking at all. The following |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5484 snippets will be identified as La@TeX{} source code: |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5485 @itemize @bullet |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5486 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5487 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
|
5488 @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
|
5489 whitespace. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5490 @item |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
5491 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
|
5492 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
|
5493 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
|
5494 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
|
5495 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
|
5496 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
|
5497 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
|
5498 @end itemize |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5499 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5500 @noindent For example: |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5501 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5502 @example |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5503 \begin@{equation@} % arbitrary environments, |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5504 x=\sqrt@{b@} % even tables, figures |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5505 \end@{equation@} % etc |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5506 |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
5507 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
|
5508 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \]. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5509 @end example |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5510 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5511 @noindent |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5512 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
|
5513 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
|
5514 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
|
5515 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5516 @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
|
5517 @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
|
5518 @cindex LaTeX fragments, preview |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5519 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5520 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
|
5521 typeset expressions: |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5522 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5523 @table @kbd |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5524 @kindex C-c C-x C-l |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5525 @item C-c C-x C-l |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5526 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
|
5527 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
|
5528 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
|
5529 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
|
5530 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
|
5531 process the entire buffer. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5532 @kindex C-c C-c |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5533 @item C-c C-c |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5534 Remove the overlay preview images. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5535 @end table |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5536 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5537 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
|
5538 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
|
5539 setting is active: |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5540 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5541 @lisp |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5542 (setq org-export-with-LaTeX-fragments t) |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5543 @end lisp |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5544 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5545 @node CDLaTeX mode, , Processing LaTeX fragments, Embedded LaTeX |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5546 @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
|
5547 @cindex CDLaTeX |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5548 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5549 CDLaTeX-mode is a minor mode that is normally used in combination with a |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5550 major La@TeX{} mode like AUCTeX in order to speed-up insertion of |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5551 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
|
5552 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
|
5553 @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
|
5554 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
|
5555 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
|
5556 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
|
5557 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
|
5558 Org-mode files with |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5559 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5560 @lisp |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5561 (add-hook 'org-mode-hook 'turn-on-org-cdlatex) |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5562 @end lisp |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5563 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5564 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
|
5565 details see the documentation of cdlatex-mode): |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5566 @itemize @bullet |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5567 @kindex C-c @{ |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5568 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5569 Environment templates can be inserted with @kbd{C-c @{}. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5570 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5571 @kindex @key{TAB} |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5572 The @key{TAB} key will do template expansion if the cursor is inside a |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5573 La@TeX{} fragment@footnote{Org-mode has a method to test if the cursor is |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
5574 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
|
5575 @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
|
5576 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
|
5577 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
|
5578 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
|
5579 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
|
5580 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
|
5581 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
|
5582 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
|
5583 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5584 @kindex _ |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5585 @kindex ^ |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5586 Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5587 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
|
5588 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
|
5589 macro, they are removed again (depending on the variable |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5590 @code{cdlatex-simplify-sub-super-scripts}). |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5591 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5592 @kindex ` |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5593 Pressing the backquote @kbd{`} followed by a character inserts math |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5594 macros, also outside La@TeX{} fragments. If you wait more than 1.5 seconds |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5595 after the backquote, a help window will pop up. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5596 @item |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5597 @kindex ' |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5598 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
|
5599 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
|
5600 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
|
5601 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
|
5602 is normal. |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5603 @end itemize |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5604 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
5605 @node Exporting, Publishing, Embedded LaTeX, Top |
58792 | 5606 @chapter Exporting |
5607 @cindex exporting | |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5608 |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5609 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
|
5610 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
|
5611 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
|
5612 notes file on the web, while the XOXO format provides a solid base for |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5613 exchange with a broad range of other applications. La@TeX{} export lets |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5614 you use Org-mode and its structured editing functions to easily create |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5615 La@TeX{} files. To incorporate entries with associated times like |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5616 deadlines or appointments into a desktop calendar program like iCal, |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5617 Org-mode can also produce extracts in the iCalendar format. Currently |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5618 Org-mode only supports export, not import of these different formats. |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5619 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5620 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
|
5621 produced. @xref{Text interpretation}, for more details. |
58792 | 5622 |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
5623 @table @kbd |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
5624 @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
|
5625 @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
|
5626 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
|
5627 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
|
5628 command. |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
5629 @end table |
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
5630 |
58792 | 5631 @menu |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5632 * ASCII export:: Exporting to plain ASCII |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5633 * HTML export:: Exporting to HTML |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5634 * LaTeX export:: Exporting to LaTeX |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5635 * XOXO export:: Exporting to XOXO |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5636 * iCalendar export:: Exporting in iCalendar format |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5637 * Text interpretation:: How the exporter looks at the file |
58792 | 5638 @end menu |
5639 | |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5640 @node ASCII export, HTML export, Exporting, Exporting |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5641 @section ASCII export |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5642 @cindex ASCII export |
58792 | 5643 |
71098
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
5644 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
|
5645 file. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5646 |
58792 | 5647 @cindex region, active |
5648 @cindex active region | |
5649 @cindex transient-mark-mode | |
5650 @table @kbd | |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
5651 @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
|
5652 @item C-c C-e a |
58792 | 5653 Export as ASCII file. If there is an active region, only the region |
5654 will be exported. For an org file @file{myfile.org}, the ASCII file | |
5655 will be @file{myfile.txt}. The file will be overwritten without | |
5656 warning. | |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
5657 @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
|
5658 @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
|
5659 Export only the visible part of the document. |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5660 @end table |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5661 |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5662 @cindex headline levels, for exporting |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5663 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
|
5664 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
|
5665 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
|
5666 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
|
5667 |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5668 @example |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
5669 @kbd{C-1 C-c C-e a} |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5670 @end example |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5671 |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5672 @noindent |
71246
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
5673 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
|
5674 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
|
5675 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
|
5676 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
|
5677 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
|
5678 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
|
5679 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
|
5680 |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5681 @node HTML export, LaTeX export, ASCII export, Exporting |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5682 @section HTML export |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5683 @cindex HTML export |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5684 |
71098
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
5685 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
|
5686 HTML formatting, in ways similar to John Grubers @emph{markdown} |
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
5687 language, but with additional support for tables. |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5688 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5689 @menu |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5690 * HTML Export commands:: How to invoke LaTeX export |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5691 * Quoting HTML tags:: Using direct HTML in Org-mode |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5692 * Links:: Transformation of links for HTML |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5693 * Images:: How to include images |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5694 * CSS support:: Changing the appearence of the output |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5695 @end menu |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5696 |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5697 @node HTML Export commands, Quoting HTML tags, HTML export, HTML export |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5698 @subsection HTML export commands |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5699 |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5700 @cindex region, active |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5701 @cindex active region |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5702 @cindex transient-mark-mode |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5703 @table @kbd |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
5704 @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
|
5705 @item C-c C-e h |
58792 | 5706 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
|
5707 @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
|
5708 @item C-c C-e b |
58792 | 5709 Export as HTML file and open it with a browser. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5710 @kindex C-c C-e H |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5711 @item C-c C-e H |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5712 Export to a temporary buffer, do not create a file. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5713 @kindex C-c C-e R |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5714 @item C-c C-e H |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5715 Export the active region to a temporary buffer. With prefix arg, do not |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5716 produce file header and foot, but just the plain HTML section for the |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5717 region. This is good for cut-and-paste operations. |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
5718 @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
|
5719 @kindex C-c C-e v b |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5720 @kindex C-c C-e v H |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5721 @kindex C-c C-e v R |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
5722 @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
|
5723 @item C-c C-e v b |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5724 @item C-c C-e v H |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5725 @item C-c C-e v R |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5726 Export only the visible part of the document. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5727 @item M-x org-export-region-as-html |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5728 Convert the region to HTML under the assumption that it was org-mode |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5729 syntax before. This is a global command that can be invoked in any |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5730 buffer. |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5731 @item M-x org-replace-region-by-HTML |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5732 Replace the active region (assumed to be in Org-mode syntax) by HTML |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5733 code. |
58792 | 5734 @end table |
5735 | |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5736 @cindex headline levels, for exporting |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5737 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
|
5738 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
|
5739 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
|
5740 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
|
5741 |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5742 @example |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
5743 @kbd{C-2 C-c C-e b} |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5744 @end example |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5745 |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5746 @noindent |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5747 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
|
5748 |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5749 @node Quoting HTML tags, Links, HTML Export commands, HTML export |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5750 @subsection Quoting HTML tags |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5751 |
58792 | 5752 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5753 @samp{>} in HTML export. If you want to include simple HTML tags |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5754 which should be interpreted as such, mark them with @samp{@@} as in |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5755 @samp{@@<b>bold text@@</b>}. Note that this really works only for |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5756 simple tags. For more extensive HTML that should be copied verbatim to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5757 the exported file use either |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5758 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5759 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5760 #+HTML: Literal HTML code for export |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5761 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5762 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5763 @noindent or |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5764 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5765 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5766 #+BEGIN_HTML |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5767 All lines between these markers are exported literally |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5768 #+END_HTML |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5769 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5770 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5771 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5772 @node Links, Images, Quoting HTML tags, HTML export |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5773 @subsection Links |
58792 | 5774 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5775 @cindex links, in HTML export |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5776 @cindex internal links, in HTML export |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5777 @cindex external links, in HTML export |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5778 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
|
5779 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
|
5780 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
|
5781 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
|
5782 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
|
5783 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
|
5784 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
|
5785 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
|
5786 @ref{Publishing links}. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5787 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5788 @node Images, CSS support, Links, HTML export |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5789 @subsection Images |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5790 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5791 @cindex images, inline in HTML |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5792 @cindex inlining images in HTML |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5793 HTML export can inline images given as links in the Org-mode file, and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5794 it can make an image the clickable part of a link. By |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5795 default@footnote{but see the variable |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5796 @code{org-export-html-inline-images}}, images are inlined if a link does |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5797 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5798 while @samp{[[file:myimg.jpg][the image]]} will just produce a link |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5799 @samp{the image} that points to the image. If the description part |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5800 itself is a @code{file:} link or a @code{http:} URL pointing to an |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5801 image, this image will be inlined and activated so that clicking on the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5802 image will activate the link. For example, to include a thumbnail that |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5803 will link to a high resolution version of the image, you could use: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5804 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5805 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5806 [[file:highres.jpg][file:thumb.jpg]] |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5807 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5808 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5809 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5810 and you could use @code{http} addresses just as well. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5811 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5812 @node CSS support, , Images, HTML export |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5813 @subsection CSS support |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5814 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5815 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
|
5816 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
|
5817 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
|
5818 @example |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5819 .todo @r{TODO keywords} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5820 .done @r{the DONE keyword} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5821 .timestamp @r{time stamp} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5822 .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
|
5823 .tag @r{tag in a headline} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5824 .target @r{target for links} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5825 @end example |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5826 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5827 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
|
5828 @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
|
5829 you may use file variables, best wrapped into a COMMENT section at the |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5830 end of the outline tree. For example@footnote{Under Emacs 21, the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5831 continuation lines for a variable value should have no @samp{#} at the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5832 start of the line.}: |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
5833 |
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
5834 @example |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5835 * COMMENT html style specifications |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
5836 |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
5837 # Local Variables: |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
5838 # 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
|
5839 # p @{font-weight: normal; color: gray; @} |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5840 # h1 @{color: black; @} |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5841 # </style>" |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
5842 # End: |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
5843 @end example |
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
5844 |
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
5845 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
|
5846 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
|
5847 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
|
5848 section in the buffer. |
66988
578b7f9692c4
(FAQ): Document `org-table-tab-jumps-over-hlines'.
Carsten Dominik <dominik@science.uva.nl>
parents:
66690
diff
changeset
|
5849 |
70133
36d1ec75581c
* org.texi: (Time stamps): Better explanation of the purpose of
Carsten Dominik <dominik@science.uva.nl>
parents:
70065
diff
changeset
|
5850 @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
|
5851 @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
|
5852 |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5853 @node LaTeX export, XOXO export, HTML export, Exporting |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5854 @section LaTeX export |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5855 @cindex LaTeX export |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5856 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5857 Org-mode contains a La@TeX{} exporter written by Bastien Guerry. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5858 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5859 @menu |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5860 * LaTeX export commands:: How to invoke LaTeX export |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5861 * Quoting LaTeX code:: Incorporating literal LaTeX code |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5862 @end menu |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5863 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5864 @node LaTeX export commands, Quoting LaTeX code, LaTeX export, LaTeX export |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5865 @subsection LaTeX export commands |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5866 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5867 @table @kbd |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5868 @kindex C-c C-e l |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5869 @item C-c C-e l |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5870 Export as La@TeX{} file @file{myfile.tex}. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5871 @kindex C-c C-e L |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5872 @item C-c C-e L |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5873 Export to a temporary buffer, do not create a file. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5874 @kindex C-c C-e v l |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5875 @kindex C-c C-e v L |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5876 @item C-c C-e v l |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5877 @item C-c C-e v L |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5878 Export only the visible part of the document. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5879 @item M-x org-export-region-as-latex |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5880 Convert the region to La@TeX{} under the assumption that it was org-mode |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5881 syntax before. This is a global command that can be invoked in any |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5882 buffer. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5883 @item M-x org-replace-region-by-latex |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5884 Replace the active region (assumed to be in Org-mode syntax) by La@TeX{} |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5885 code. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5886 @end table |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5887 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5888 @cindex headline levels, for exporting |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5889 In the exported version, the first 3 outline levels will become |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5890 headlines, defining a general document structure. Additional levels |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5891 will be exported as description lists. The exporter can ignore them or |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5892 convert them to a custom string depending on |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5893 @code{org-latex-low-levels}. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5894 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5895 If you want that transition to occur at a different level, specify it |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5896 with a prefix argument. For example, |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5897 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5898 @example |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5899 @kbd{C-2 C-c C-e l} |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5900 @end example |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5901 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5902 @noindent |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5903 creates two levels of headings and does the rest as items. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5904 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5905 @node Quoting LaTeX code, , LaTeX export commands, LaTeX export |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5906 @subsection Quoting LaTeX code |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5907 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5908 Embedded La@TeX{} as described in @ref{Embedded LaTeX} will be correctly |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5909 inserted into the La@TeX{} file. Forthermore, you can add special code |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5910 that should only be present in La@TeX{} export with the following |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5911 constructs: |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5912 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5913 @example |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5914 #+LaTeX: Literal LaTeX code for export |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5915 @end example |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5916 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5917 @noindent or |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5918 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5919 @example |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5920 #+BEGIN_LaTeX |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5921 All lines between these markers are exported literally |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5922 #+END_LaTeX |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5923 @end example |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
5924 @node XOXO export, iCalendar export, LaTeX export, Exporting |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5925 @section XOXO export |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5926 @cindex XOXO export |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5927 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5928 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
|
5929 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
|
5930 does not interpret any additional Org-mode features. |
58792 | 5931 |
5932 @table @kbd | |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
5933 @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
|
5934 @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
|
5935 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
|
5936 @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
|
5937 @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
|
5938 Export only the visible part of the document. |
58792 | 5939 @end table |
5940 | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
5941 @node iCalendar export, Text interpretation, XOXO export, Exporting |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5942 @section iCalendar export |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
5943 @cindex iCalendar export |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5944 |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5945 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
|
5946 still prefer a standard calendar application for anniversaries and |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5947 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
|
5948 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
|
5949 application. Org-mode can export calendar information in the standard |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5950 iCalendar format. If you also want to have TODO entries included in the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5951 export, configure the variable @code{org-icalendar-include-todo}. |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5952 |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5953 @table @kbd |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
5954 @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
|
5955 @item C-c C-e i |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5956 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
|
5957 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
|
5958 @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
|
5959 @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
|
5960 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
|
5961 @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
|
5962 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
|
5963 @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
|
5964 @item C-c C-e c |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5965 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
|
5966 @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
|
5967 @code{org-combined-agenda-icalendar-file}. |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5968 @end table |
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5969 |
67344
22aa7225124f
(TODO basics): Document the global todo list.
Carsten Dominik <dominik@science.uva.nl>
parents:
67219
diff
changeset
|
5970 How this calendar is best read and updated, depends on the application |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5971 you are using. The FAQ covers this issue. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
5972 |
66264
d979e1d45f97
(Summary): Mention iCalendar support.
Carsten Dominik <dominik@science.uva.nl>
parents:
65965
diff
changeset
|
5973 |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5974 @node Text interpretation, , iCalendar export, Exporting |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5975 @section Text interpretation by the exporter |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5976 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5977 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
|
5978 in order to produce better output. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5979 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5980 @menu |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5981 * Comment lines:: Some lines will not be exported |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5982 * Initial text:: Text before the first headline |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5983 * Footnotes:: Numbers like [1] |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5984 * Enhancing text:: Subscripts, symbols and more |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5985 * 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
|
5986 @end menu |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5987 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5988 @node Comment lines, Initial text, Text interpretation, Text interpretation |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5989 @subsection Comment lines |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5990 @cindex comment lines |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5991 @cindex exporting, not |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5992 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5993 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
|
5994 and will never be exported. Also entire subtrees starting with the |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
5995 word @samp{COMMENT} will never be exported. |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5996 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5997 @table @kbd |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5998 @kindex C-c ; |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
5999 @item C-c ; |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6000 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
|
6001 @end table |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6002 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6003 @node Initial text, Footnotes, Comment lines, Text interpretation |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6004 @subsection Text before the first headline |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6005 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6006 Org-mode normally ignores any text before the first headline when |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6007 exporting, leaving this region for internal links to speed up navigation |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6008 etc. However, in publishing-oriented files, you might want to have some |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6009 text before the first headline, like a small introduction, special HTML |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6010 code with a navigation bar, etc. You can ask to have this part of the |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6011 file exported as well by setting the variable |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6012 @code{org-export-skip-text-before-1st-heading} to @code{nil}. On a |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6013 per-file basis, you can get the same effect with |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6014 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6015 @example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6016 #+OPTIONS: skip:nil |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6017 @end example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6018 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6019 The text before the first headline will be fully processed |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6020 (@pxref{Enhancing text}), and the first non-comment line becomes the |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6021 title of the exported document. If you need to include literal HTML, |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6022 use the special constructs described in @ref{Quoting HTML tags}. The |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6023 table of contents is normally inserted directly before the first |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6024 headline of the file. If you would like to get it to a different |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6025 location, insert the string @code{[TABLE-OF-CONTENTS]} on a line by |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6026 itself at the desired location. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6027 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6028 Finally, if you want to use the space before the first headline for |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6029 internal purposes, but @emph{still} want to place something before the |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6030 first headline when exporting the file, you can use the @code{#+TEXT} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6031 construct: |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6032 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6033 @example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6034 #+OPTIONS: skip:t |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6035 #+TEXT: This text will go before the *first* headline. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6036 #+TEXT: We place the table of contents here: |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6037 #+TEXT: [TABLE-OF-CONTENTS] |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6038 #+TEXT: This goes between the table of contents and the first headline |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6039 @end example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6040 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6041 @node Footnotes, Enhancing text, Initial text, Text interpretation |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6042 @subsection Footnotes |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6043 @cindex footnotes |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6044 @cindex @file{footnote.el} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6045 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6046 Numbers in square brackets are treated as footnotes, so that you can use |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6047 the Emacs package @file{footnote.el} to create footnotes. For example: |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6048 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6049 @example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6050 The org-mode homepage[1] clearly needs help from |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6051 a good web designer. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6052 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6053 [1] The link is: http://www.astro.uva.nl/~dominik/Tools/org |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6054 @end example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6055 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6056 @noindent |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6057 @kindex C-c ! |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6058 Note that the @file{footnote} package uses @kbd{C-c !} to invoke its |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6059 commands. This binding conflicts with the org-mode command for |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6060 inserting inactive time stamps. You could use the variable |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6061 @code{footnote-prefix} to switch footnotes commands to another key. Or, |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6062 if you are too used to this binding, you could use |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6063 @code{org-replace-disputed-keys} and @code{org-disputed-keys} to change |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6064 the settings in Org-mode. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6065 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6066 @node Enhancing text, Export options, Footnotes, Text interpretation |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6067 @subsection Enhancing text for export |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6068 @cindex enhancing text |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6069 @cindex richer text |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6070 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6071 Some of the export backends of Org-mode allow for sophisticated text |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6072 formatting, this is true in particular for the HTML and La@TeX{} |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6073 backends. Org-mode has a number of typing conventions that allow to |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6074 produce a richly formatted output. |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6075 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6076 @itemize @bullet |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6077 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6078 @cindex hand-formatted lists |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6079 @cindex lists, hand-formatted |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6080 @item |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6081 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
|
6082 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
|
6083 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
|
6084 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6085 @cindex underlined text |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6086 @cindex bold text |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6087 @cindex italic text |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6088 @item |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6089 You can make words @b{*bold*}, @i{/italic/}, _underlined_, |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6090 @code{=code=}, and even @samp{+strikethrough+}@footnote{but remember |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6091 that strikethrough is typographically evil and should @i{never} be |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6092 used.}. |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6093 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6094 @cindex horizontal rules, in exported files |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6095 @item |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6096 A line consisting of only dashes, and at least 5 of them, will be |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6097 exported as a horizontal line (@samp{<hr/>} in HTML). |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6098 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6099 @cindex LaTeX fragments, export |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6100 @cindex TeX macros, export |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6101 @item |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6102 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
|
6103 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
|
6104 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6105 @cindex tables, export |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6106 @item |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6107 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
|
6108 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
|
6109 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
|
6110 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6111 @cindex fixed width |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6112 @item |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6113 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
|
6114 headline will be typeset as fixed-width, to allow quoting of computer |
81465
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
6115 codes etc. Lines starting with @samp{:} are also typeset in fixed-width |
ea719971ae70
(Tag): Section swapped with node Timestamps.
Carsten Dominik <dominik@science.uva.nl>
parents:
81167
diff
changeset
|
6116 font. |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6117 @table @kbd |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6118 @kindex C-c : |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6119 @item C-c : |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6120 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
|
6121 @end table |
71246
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
6122 |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
6123 @cindex linebreak, forced |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
6124 @item |
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
6125 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
|
6126 this position. |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6127 @end itemize |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6128 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6129 If these conversions conflict with your habits of typing ASCII text, |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6130 they can all be turned off with corresponding variables. See the |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6131 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
|
6132 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
|
6133 buffer. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6134 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6135 |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6136 @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
|
6137 @subsection Export options |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6138 @cindex options, for export |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6139 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6140 @cindex completion, of option keywords |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6141 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
|
6142 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
|
6143 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
|
6144 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
|
6145 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
|
6146 (@pxref{Completion}). |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6147 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6148 @table @kbd |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
6149 @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
|
6150 @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
|
6151 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
|
6152 @end table |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6153 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6154 @example |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6155 #+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
|
6156 #+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
|
6157 #+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
|
6158 #+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
|
6159 #+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
|
6160 #+TEXT: Several lines may be given. |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6161 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ... |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6162 @end example |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6163 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6164 @noindent |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6165 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
|
6166 you can: |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6167 @cindex headline levels |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6168 @cindex section-numbers |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6169 @cindex table of contents |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6170 @cindex linebreak preservation |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6171 @cindex quoted HTML tags |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6172 @cindex fixed-width sections |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6173 @cindex tables |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6174 @cindex @TeX{}-like syntax for sub- and superscripts |
81530 | 6175 @cindex footnotes |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6176 @cindex emphasized text |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6177 @cindex @TeX{} macros |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6178 @cindex La@TeX{} fragments |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6179 @cindex author info, in export |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6180 @cindex time info, in export |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6181 @example |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6182 H: @r{set the number of headline levels for export} |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6183 num: @r{turn on/off section-numbers} |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6184 toc: @r{turn on/off table of contents, or set level limit (integer)} |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6185 \n: @r{turn on/off linebreak-preservation} |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6186 @@: @r{turn on/off quoted HTML tags} |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6187 :: @r{turn on/off fixed-width sections} |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6188 |: @r{turn on/off tables} |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6189 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If} |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6190 @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but} |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6191 @r{the simple @code{a_b} will be left as it is.} |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6192 f: @r{turn on/off foototes like this[1].} |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6193 *: @r{turn on/off emphasized text (bold, italic, underlined)} |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6194 TeX: @r{turn on/off simple @TeX{} macros in plain text} |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6195 LaTeX: @r{turn on/off La@TeX{} fragments} |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6196 skip: @r{turn on/off skipping the text before the first heading} |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6197 author: @r{turn on/off inclusion of author name/email into exported file} |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6198 timestamp: @r{turn on/off inclusion creation time into exported file} |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6199 @end example |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6200 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6201 These options take effect in both the HTML and La@TeX{} export, except |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6202 for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6203 @code{nil} for the La@TeX{} export. |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6204 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6205 @node Publishing, Miscellaneous, Exporting, Top |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6206 @chapter Publishing |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6207 @cindex publishing |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6208 |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
6209 Org-mode includes@footnote{@file{org-publish.el} is not distributed with |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
6210 Emacs 21, if you are still using Emacs 21, you need you need to download |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
6211 this file separately.} a publishing management system that allows you to |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
6212 configure automatic HTML conversion of @emph{projects} composed of |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6213 interlinked org files. This system is called @emph{org-publish}. You can |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6214 also configure org-publish to automatically upload your exported HTML |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6215 pages and related attachments, such as images and source code files, to |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6216 a web server. Org-publish turns org-mode into a web-site authoring tool. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6217 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6218 You can also use Org-publish to convert files into La@TeX{}, or even |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6219 combine HTML and La@TeX{} conversion so that files are available in both |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6220 formats on the server@footnote{Since La@TeX{} files on a server are not |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6221 that helpful, you surely want to perform further conversion on them -- |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6222 e.g. convert them to @code{PDF} format.}. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6223 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6224 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
|
6225 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6226 @menu |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6227 * Configuration:: Defining projects |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6228 * Sample configuration:: Example projects |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6229 * Triggering publication:: Publication commands |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6230 @end menu |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6231 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6232 @node Configuration, Sample configuration, Publishing, Publishing |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6233 @section Configuration |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6234 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6235 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
|
6236 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
|
6237 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6238 @menu |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6239 * Project alist:: The central configuration variable |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6240 * 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
|
6241 * 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
|
6242 * 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
|
6243 * Publishing options:: Tweaking HTML export |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6244 * 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
|
6245 * 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
|
6246 @end menu |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6247 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6248 @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
|
6249 @subsection The variable @code{org-publish-project-alist} |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6250 @cindex org-publish-project-alist |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6251 @cindex projects, for publishing |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6252 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6253 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
|
6254 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
|
6255 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
|
6256 the two following forms: |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6257 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6258 @lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6259 ("project-name" :property value :property value ...) |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6260 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6261 @r{or} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6262 |
71098
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
6263 ("project-name" :components ("project-name" "project-name" ...)) |
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
6264 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6265 @end lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6266 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6267 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
|
6268 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
|
6269 the publishing configuration to use when publishing those files. When |
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
6270 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
|
6271 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
|
6272 project, which group together files requiring different publishing |
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
6273 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
|
6274 will also publish. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6275 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6276 @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
|
6277 @subsection Sources and destinations for files |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6278 @cindex directories, for publishing |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6279 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6280 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
|
6281 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
|
6282 and where to put published files. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6283 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6284 @multitable @columnfractions 0.3 0.7 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6285 @item @code{:base-directory} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6286 @tab Directory containing publishing source files |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6287 @item @code{:publishing-directory} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6288 @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
|
6289 @item @code{:preparation-function} |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6290 @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
|
6291 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
|
6292 @end multitable |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6293 @noindent |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6294 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6295 @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
|
6296 @subsection Selecting files |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6297 @cindex files, selecting for publishing |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6298 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6299 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
|
6300 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
|
6301 properties |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6302 @multitable @columnfractions 0.25 0.75 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6303 @item @code{:base-extension} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6304 @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
|
6305 regular expression. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6306 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6307 @item @code{:exclude} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6308 @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
|
6309 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
|
6310 extension. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6311 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6312 @item @code{:include} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6313 @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
|
6314 and @code{:exclude}. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6315 @end multitable |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6316 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6317 @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
|
6318 @subsection Publishing Action |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6319 @cindex action, for publishing |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6320 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6321 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
|
6322 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
|
6323 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
|
6324 @code{org-publish-org-to-html} which calls the HTML exporter |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6325 (@pxref{HTML export}). But you also can publish your files in La@TeX{} by |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6326 using the function @code{org-publish-org-to-latex} instead. Other files |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6327 like images only need to be copied to the publishing destination. For |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6328 non-Org-mode files, you need to specify the publishing function. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6329 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6330 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6331 @multitable @columnfractions 0.3 0.7 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6332 @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
|
6333 @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
|
6334 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
|
6335 @end multitable |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6336 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6337 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
|
6338 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
|
6339 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
|
6340 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
|
6341 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
|
6342 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
|
6343 @code{org-publish-attachment}. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6344 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6345 @node Publishing options, Publishing links, Publishing action, Configuration |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6346 @subsection Options for the HTML/LaTeX exporters |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6347 @cindex options, for publishing |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6348 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6349 The property list can be used to set many export options for the HTML |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6350 and La@TeX{} exporters. In most cases, these properties correspond to user |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6351 variables in Org-mode. The table below lists these properties along |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6352 with the variable they belong to. See the documentation string for the |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6353 respective variable for details. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6354 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6355 @multitable @columnfractions 0.3 0.7 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6356 @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
|
6357 @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
|
6358 @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
|
6359 @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
|
6360 @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
|
6361 @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
|
6362 @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
|
6363 @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
|
6364 @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
|
6365 @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
|
6366 @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
|
6367 @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
|
6368 @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
|
6369 @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
|
6370 @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
|
6371 @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
|
6372 @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
|
6373 @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
|
6374 @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
|
6375 @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
|
6376 @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
|
6377 @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
|
6378 @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
|
6379 @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
|
6380 @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
|
6381 @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
|
6382 @end multitable |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6383 |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6384 Most of the @code{org-export-with-*} variables have the same effect in |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6385 both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6386 @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6387 La@TeX{} export. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6388 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6389 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
|
6390 setting overrides the value of the corresponding user variable (if any) |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
6391 during publishing. Options set within a file (@pxref{Export |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6392 options}), however, override everything. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6393 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6394 @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
|
6395 @subsection Links between published files |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6396 @cindex links, publishing |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6397 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6398 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
|
6399 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
|
6400 @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
|
6401 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
|
6402 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
|
6403 you publish them to HTML. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6404 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6405 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
|
6406 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
|
6407 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
|
6408 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
|
6409 |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6410 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
|
6411 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
|
6412 location. In this case, use the property |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6413 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6414 @multitable @columnfractions 0.4 0.6 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6415 @item @code{:link-validation-function} |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6416 @tab Function to validate links |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6417 @end multitable |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6418 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6419 @noindent |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6420 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
|
6421 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
|
6422 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
|
6423 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
|
6424 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
|
6425 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
|
6426 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
|
6427 |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6428 @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
|
6429 @subsection Project page index |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6430 @cindex index, of published pages |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6431 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6432 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
|
6433 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
|
6434 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6435 @multitable @columnfractions 0.25 0.75 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6436 @item @code{:auto-index} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6437 @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
|
6438 org-publish-all. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6439 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6440 @item @code{:index-filename} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6441 @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
|
6442 becomes @file{index.html}). |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6443 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6444 @item @code{:index-title} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6445 @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
|
6446 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6447 @item @code{:index-function} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6448 @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
|
6449 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
|
6450 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
|
6451 @end multitable |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6452 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6453 @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
|
6454 @section Sample configuration |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6455 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6456 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
|
6457 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
|
6458 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
|
6459 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6460 @menu |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6461 * Simple example:: One-component publishing |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6462 * 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
|
6463 @end menu |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6464 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6465 @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
|
6466 @subsection Example: simple publishing configuration |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6467 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6468 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
|
6469 directory on the local machine. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6470 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6471 @lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6472 (setq org-publish-project-alist |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6473 '(("org" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6474 :base-directory "~/org/" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6475 :publishing-directory "~/public_html" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6476 :section-numbers nil |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6477 :table-of-contents nil |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6478 :style "<link rel=stylesheet |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6479 href=\"../other/mystyle.css\" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6480 type=\"text/css\">"))) |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6481 @end lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6482 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6483 @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
|
6484 @subsection Example: complex publishing configuration |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6485 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6486 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
|
6487 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
|
6488 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
|
6489 excluded. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6490 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6491 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
|
6492 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
|
6493 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
|
6494 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
|
6495 @c |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6496 @example |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6497 file:../images/myimage.png |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6498 @end example |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6499 @c |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6500 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
|
6501 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
|
6502 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
|
6503 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6504 @lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6505 (setq org-publish-project-alist |
71098
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
6506 '(("orgfiles" |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6507 :base-directory "~/org/" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6508 :base-extension "org" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6509 :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
|
6510 :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
|
6511 :exclude "PrivatePage.org" ;; regexp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6512 :headline-levels 3 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6513 :section-numbers nil |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6514 :table-of-contents nil |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6515 :style "<link rel=stylesheet |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6516 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
|
6517 :auto-preamble t |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6518 :auto-postamble nil) |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6519 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6520 ("images" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6521 :base-directory "~/images/" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6522 :base-extension "jpg\\|gif\\|png" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6523 :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
|
6524 :publishing-function org-publish-attachment) |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6525 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6526 ("other" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6527 :base-directory "~/other/" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6528 :base-extension "css\\|el" |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6529 :publishing-directory "/ssh:user@@host:~/html/other/" |
71098
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
6530 :publishing-function org-publish-attachment) |
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
6531 ("website" :components ("orgfiles" "images" "other")))) |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6532 @end lisp |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6533 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6534 @node Triggering publication, , Sample configuration, Publishing |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6535 @section Triggering publication |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6536 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6537 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
|
6538 following functions: |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6539 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6540 @table @kbd |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6541 @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
|
6542 Prompt for a specific project and publish all files that belong to it. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6543 @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
|
6544 Publish the project containing the current file. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6545 @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
|
6546 Publish only the current file. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6547 @item C-c C-e A |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6548 Publish all projects. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6549 @end table |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6550 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6551 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
|
6552 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
|
6553 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
|
6554 |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6555 @node Miscellaneous, Extensions and Hacking, Publishing, Top |
58792 | 6556 @chapter Miscellaneous |
6557 | |
6558 @menu | |
6559 * Completion:: M-TAB knows what you need | |
6560 * Customization:: Adapting Org-mode to your taste | |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6561 * 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
|
6562 * 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
|
6563 * 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
|
6564 * TTY keys:: Using Org-mode on a tty |
58792 | 6565 * Interaction:: Other Emacs packages |
63362 | 6566 * Bugs:: Things which do not work perfectly |
58792 | 6567 @end menu |
6568 | |
6569 @node Completion, Customization, Miscellaneous, Miscellaneous | |
6570 @section Completion | |
63833 | 6571 @cindex completion, of @TeX{} symbols |
6572 @cindex completion, of TODO keywords | |
6573 @cindex completion, of dictionary words | |
6574 @cindex completion, of option keywords | |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
6575 @cindex completion, of tags |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6576 @cindex completion, of property keys |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6577 @cindex completion, of link abbreviations |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
6578 @cindex @TeX{} symbol completion |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
6579 @cindex TODO keywords completion |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
6580 @cindex dictionary word completion |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
6581 @cindex option keyword completion |
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
6582 @cindex tag completion |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6583 @cindex link abbreviations, completion of |
58792 | 6584 |
6585 Org-mode supports in-buffer completion. This type of completion does | |
6586 not make use of the minibuffer. You simply type a few letters into | |
6587 the buffer and use the key to complete text right there. | |
6588 | |
6589 @table @kbd | |
6590 @kindex M-@key{TAB} | |
6591 @item M-@key{TAB} | |
6592 Complete word at point | |
6593 @itemize @bullet | |
6594 @item | |
6595 At the beginning of a headline, complete TODO keywords. | |
6596 @item | |
6597 After @samp{\}, complete @TeX{} symbols supported by the exporter. | |
6598 @item | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6599 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
|
6600 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
|
6601 @item |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6602 After @samp{:} in a headline, complete tags. The list of tags is taken |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6603 from the variable @code{org-tag-alist} (possibly set through the |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6604 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6605 dynamically from all tags used in the current buffer. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6606 @item |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6607 After @samp{:} and not in a headline, complete property keys. The list |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6608 of keys is constructed dynamically from all keys used in the current |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6609 buffer. |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6610 @item |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6611 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}). |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
6612 @item |
58792 | 6613 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or |
6614 @samp{OPTIONS} which set file-specific options for Org-mode. When the | |
6615 option keyword is already complete, pressing @kbd{M-@key{TAB}} again | |
6616 will insert example settings for this keyword. | |
6617 @item | |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6618 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
|
6619 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
|
6620 @item |
58792 | 6621 Elsewhere, complete dictionary words using ispell. |
6622 @end itemize | |
6623 @end table | |
6624 | |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6625 @node Customization, In-buffer settings, Completion, Miscellaneous |
58792 | 6626 @section Customization |
6627 @cindex customization | |
6628 @cindex options, for customization | |
6629 @cindex variables, for customization | |
6630 | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6631 There are more than 180 variables that can be used to customize |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6632 Org-mode. For the sake of compactness of the manual, I am not |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
6633 describing the variables here. A structured overview of customization |
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
6634 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
|
6635 @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
|
6636 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
|
6637 lines into the buffer (@pxref{In-buffer settings}). |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6638 |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6639 @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
|
6640 @section Summary of in-buffer settings |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6641 @cindex in-buffer settings |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6642 @cindex special keywords |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6643 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6644 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
|
6645 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
|
6646 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
|
6647 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
|
6648 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
|
6649 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
|
6650 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
|
6651 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
|
6652 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
|
6653 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6654 @table @kbd |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6655 @item #+ARCHIVE: %s_done:: |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6656 This line sets the archive location for the agenda file. It applies for |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6657 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6658 of the file. The first such line also applies to any entries before it. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6659 The corresponding variable is @code{org-archive-location}. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6660 @item #+CATEGORY: |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6661 This line sets the category for the agenda file. The category applies |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6662 for all subsequent lines until the next @samp{#+CATEGORY} line, or the |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6663 end of the file. The first such line also applies to any entries before it. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6664 @item #+COLUMNS: %25ITEM ..... |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6665 Set the default format for columns view. This format applies when |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6666 columns view is invoked in location where no COLUMNS property applies. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6667 @item #+CONSTANTS: name1=value1 ... |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6668 Set file-local values for constants to be used in table formulas. This |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6669 line set the local variable @code{org-table-formula-constants-local}. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6670 The global version of theis variable is |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6671 @code{org-table-formula-constants}. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6672 corresponding |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6673 @item #+LINK: linkword replace |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6674 These lines (several are allowed) specify link abbreviations. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6675 @xref{Link abbreviations}. The corresponding variable is |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6676 @code{org-link-abbrev-alist}. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6677 @item #+PRIORITIES: highest lowest default |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6678 This line sets the limits and the default for the priorities. All three |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6679 must be either letters A-Z or numbers 0-9. The highest priority must |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6680 have a lower ASCII number that the lowest priority. |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6681 @item #+PROPERTY: Property_Name Value |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6682 This line sets a default inheritance value for entries in the current |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6683 buffer, most useful for specifying the allowed values of a property. |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6684 @item #+STARTUP: |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
6685 This line sets options to be used at startup of Org-mode, when an |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6686 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
|
6687 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
|
6688 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
|
6689 value @code{t}, which means @code{overview}. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6690 @cindex @code{overview}, STARTUP keyword |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6691 @cindex @code{content}, STARTUP keyword |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6692 @cindex @code{showall}, STARTUP keyword |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6693 @example |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6694 overview @r{top-level headlines only} |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6695 content @r{all headlines} |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6696 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
|
6697 @end example |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6698 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
|
6699 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
|
6700 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
|
6701 @code{nil}. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6702 @cindex @code{align}, STARTUP keyword |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6703 @cindex @code{noalign}, STARTUP keyword |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6704 @example |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6705 align @r{align all tables} |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
6706 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
|
6707 @end example |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6708 Logging TODO state changes and clock intervals (variable |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6709 @code{org-log-done}) can be configured using these options. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6710 @cindex @code{logdone}, STARTUP keyword |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6711 @cindex @code{nologging}, STARTUP keyword |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6712 @cindex @code{lognotedone}, STARTUP keyword |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6713 @cindex @code{lognoteclock-out}, STARTUP keyword |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6714 @cindex @code{lognotestate}, STARTUP keyword |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6715 @cindex @code{logrepeat}, STARTUP keyword |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6716 @cindex @code{nologrepeat}, STARTUP keyword |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6717 @example |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6718 logging @r{record a timestamp when an item is marked DONE} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6719 nologging @r{don't record when items are marked DONE} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6720 lognotedone @r{record timestamp and a note when DONE} |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
6721 lognotestate @r{record timestamp and a note when TODO state changes} |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
6722 logrepeat @r{record a note when re-instating a repeating item} |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6723 nologrepeat @r{do not record when re-instating repeating item} |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6724 lognoteclock-out @r{record timestamp and a note when clocking out} |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6725 @end example |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6726 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
|
6727 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
|
6728 @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
|
6729 (meaning @code{showstars} and @code{oddeven}). |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6730 @cindex @code{hidestars}, STARTUP keyword |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6731 @cindex @code{showstars}, STARTUP keyword |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6732 @cindex @code{odd}, STARTUP keyword |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6733 @cindex @code{even}, STARTUP keyword |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6734 @example |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6735 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
|
6736 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
|
6737 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
|
6738 oddeven @r{allow all outline levels} |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6739 @end example |
74030 | 6740 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
|
6741 @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
|
6742 @code{org-time-stamp-overlay-formats}), use |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6743 @cindex @code{customtime}, STARTUP keyword |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6744 @example |
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6745 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
|
6746 @end example |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6747 The following options influence the table spreadsheet (variable |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6748 @code{constants-unit-system}). |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6749 @cindex @code{constcgs}, STARTUP keyword |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6750 @cindex @code{constSI}, STARTUP keyword |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6751 @example |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6752 constcgs @r{@file{constants.el} should use the c-g-s unit system} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6753 constSI @r{@file{constants.el} should use the SI unit system} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6754 @end example |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6755 @item #+TAGS: TAG1(c1) TAG2(c2) |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6756 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
|
6757 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
|
6758 keys. The corresponding variable is @code{org-tag-alist}. |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6759 @item #+TBLFM: |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6760 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
|
6761 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS: |
71098
b98399840395
Small typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70974
diff
changeset
|
6762 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
|
6763 @ref{Export options}. |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6764 @item #+SEQ_TODO: #+TYP_TODO: |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6765 These lines set the TODO keywords and their interpretation in the |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6766 current file. The corresponding variables are @code{org-todo-keywords} |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
6767 and @code{org-todo-interpretation}. |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6768 @end table |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6769 |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6770 @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
|
6771 @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
|
6772 @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
|
6773 @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
|
6774 |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6775 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
|
6776 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
|
6777 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
|
6778 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
|
6779 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
|
6780 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
|
6781 |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6782 @itemize @minus |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6783 @item |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
6784 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
|
6785 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
|
6786 @item |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6787 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
|
6788 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
|
6789 information. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
6790 @item |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6791 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
|
6792 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
|
6793 @item |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6794 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
|
6795 the entire table. |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6796 @item |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6797 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
|
6798 activate that table. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
6799 @item |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
6800 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
|
6801 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
|
6802 default location. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
6803 @item |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6804 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
|
6805 corresponding links in this buffer. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6806 @item |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
6807 If the cursor is in a property line or at the start or end of a property |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
6808 drawer, offer property commands. |
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
6809 @item |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6810 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
|
6811 of the checkbox. |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6812 @item |
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6813 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
|
6814 ordered list. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
6815 @end itemize |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
6816 |
70011
74050e653990
(Visibility cycling): Better names for the startup
Carsten Dominik <dominik@science.uva.nl>
parents:
69999
diff
changeset
|
6817 @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
|
6818 @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
|
6819 @cindex hiding leading stars |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6820 @cindex clean outline view |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6821 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6822 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
|
6823 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
|
6824 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
|
6825 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6826 @example |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6827 * Top level headline |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6828 ** Second level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6829 *** 3rd level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6830 some text |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6831 *** 3rd level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6832 more text |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6833 * Another top level headline |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6834 @end example |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6835 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6836 @noindent |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6837 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
|
6838 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
|
6839 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
|
6840 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
|
6841 @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
|
6842 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6843 @lisp |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6844 (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
|
6845 @end lisp |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6846 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6847 @noindent |
69456
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
6848 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
|
6849 the buffer) |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
6850 |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
6851 @example |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
6852 #+STARTUP: showstars |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
6853 #+STARTUP: hidestars |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
6854 @end example |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
6855 |
69456
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
6856 @noindent |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
6857 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
|
6858 the modifications. |
69456
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
6859 |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
6860 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
|
6861 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6862 @example |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6863 * Top level headline |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6864 * Second level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6865 * 3rd level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6866 some text |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6867 * 3rd level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6868 more text |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6869 * Another top level headline |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6870 @end example |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6871 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6872 @noindent |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6873 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
|
6874 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
|
6875 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
|
6876 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
|
6877 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
|
6878 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
|
6879 @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
|
6880 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6881 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
|
6882 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
|
6883 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
|
6884 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6885 @example |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6886 * Top level headline |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6887 * Second level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6888 * 3rd level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6889 some text |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6890 * 3rd level |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6891 more text |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6892 * Another top level headline |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6893 @end example |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6894 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6895 @noindent |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6896 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
|
6897 convention correctly, use |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6898 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6899 @lisp |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6900 (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
|
6901 @end lisp |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6902 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6903 @noindent |
69456
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
6904 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
|
6905 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
|
6906 activate changes immediately). |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
6907 |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
6908 @example |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
6909 #+STARTUP: odd |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
6910 #+STARTUP: oddeven |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
6911 @end example |
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
6912 |
69999
bd591cbbcdec
(Updating settings): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
69929
diff
changeset
|
6913 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
|
6914 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
|
6915 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
|
6916 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
|
6917 |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6918 @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
|
6919 @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
|
6920 @cindex tty keybindings |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6921 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6922 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
|
6923 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
|
6924 @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
|
6925 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
|
6926 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
|
6927 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
|
6928 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
|
6929 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
|
6930 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
|
6931 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
|
6932 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
|
6933 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
|
6934 |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6935 @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
|
6936 @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
|
6937 @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
|
6938 @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
|
6939 @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
|
6940 @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
|
6941 @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
|
6942 @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
|
6943 @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
|
6944 @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
|
6945 @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
|
6946 @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
|
6947 @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
|
6948 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6949 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6950 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6951 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6952 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6953 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
6954 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab |
69225
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6955 @end multitable |
a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Carsten Dominik <dominik@science.uva.nl>
parents:
69117
diff
changeset
|
6956 |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6957 @node Interaction, Bugs, TTY keys, Miscellaneous |
58792 | 6958 @section Interaction with other packages |
6959 @cindex packages, interaction with other | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6960 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
|
6961 with other code out there. |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6962 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6963 @menu |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6964 * Cooperation:: Packages Org-mode cooperates with |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6965 * Conflicts:: Packages that lead to conflicts |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6966 @end menu |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6967 |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
6968 @node Cooperation, Conflicts, Interaction, Interaction |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6969 @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
|
6970 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
6971 @table @asis |
63833 | 6972 @cindex @file{calc.el} |
6973 @item @file{calc.el} by Dave Gillespie | |
6974 Org-mode uses the calc package for implementing spreadsheet | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6975 functionality in its tables (@pxref{The spreadsheet}). Org-mode |
63833 | 6976 checks for the availability of calc by looking for the function |
6977 @code{calc-eval} which should be autoloaded in your setup if calc has | |
6978 been installed properly. As of Emacs 22, calc is part of the Emacs | |
6979 distribution. Another possibility for interaction between the two | |
6980 packages is using calc for embedded calculations. @xref{Embedded Mode, | |
64517 | 6981 , Embedded Mode, calc, GNU Emacs Calc Manual}. |
63833 | 6982 @cindex @file{constants.el} |
6983 @item @file{constants.el} by Carsten Dominik | |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
6984 In a table formula (@pxref{The spreadsheet}), it is possible to use |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
6985 names for natural constants or units. Instead of defining your own |
63833 | 6986 constants in the variable @code{org-table-formula-constants}, install |
6987 the @file{constants} package which defines a large number of constants | |
6988 and units, and lets you use unit prefixes like @samp{M} for | |
6989 @samp{Mega} etc. You will need version 2.0 of this package, available | |
6990 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org-mode checks for | |
6991 the function @code{constants-get}, which has to be autoloaded in your | |
6992 setup. See the installation instructions in the file | |
6993 @file{constants.el}. | |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6994 @item @file{cdlatex.el} by Carsten Dominik |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6995 @cindex @file{cdlatex.el} |
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
6996 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
|
6997 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
|
6998 @item @file{remember.el} by John Wiegley |
63833 | 6999 @cindex @file{remember.el} |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
7000 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
|
7001 @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
|
7002 @cindex @file{table.el} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
7003 @item @file{table.el} by Takaaki Ota |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7004 @kindex C-c C-c |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7005 @cindex table editor, @file{table.el} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7006 @cindex @file{table.el} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7007 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7008 Complex ASCII tables with automatic line wrapping, column- and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7009 row-spanning, and alignment can be created using the Emacs table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7010 package by Takaaki Ota (@uref{http://sourceforge.net/projects/table}, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7011 and also part of Emacs 22). |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7012 When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org-mode |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7013 will call @command{table-recognize-table} and move the cursor into the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7014 table. Inside a table, the keymap of Org-mode is inactive. In order |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7015 to execute Org-mode-related commands, leave the table. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7016 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7017 @table @kbd |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7018 @kindex C-c C-c |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7019 @item C-c C-c |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7020 Recognize @file{table.el} table. Works when the cursor is in a |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7021 table.el table. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7022 @c |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7023 @kindex C-c ~ |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7024 @item C-c ~ |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7025 Insert a table.el table. If there is already a table at point, this |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7026 command converts it between the table.el format and the Org-mode |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7027 format. See the documentation string of the command |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7028 @code{org-convert-table} for the restrictions under which this is |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7029 possible. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7030 @end table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7031 @file{table.el} is part of Emacs 22. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7032 @cindex @file{footnote.el} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7033 @item @file{footnote.el} by Steven L. Baur |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7034 Org-mode recognizes numerical footnotes as provided by this package |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7035 (@pxref{Footnotes}). |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
7036 @end table |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
7037 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
7038 @node Conflicts, , Cooperation, Interaction |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
7039 @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
|
7040 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
7041 @table @asis |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
7042 |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
7043 @cindex @file{allout.el} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
7044 @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
|
7045 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
|
7046 @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
|
7047 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
|
7048 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
|
7049 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
|
7050 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
|
7051 @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
|
7052 |
63362 | 7053 @cindex @file{CUA.el} |
7054 @item @file{CUA.el} by Kim. F. Storm | |
7055 Keybindings in Org-mode conflict with the @kbd{S-<cursor>} keys | |
7056 used by CUA-mode (as well as pc-select-mode and s-region-mode) to | |
7057 select and extend the region. If you want to use one of these | |
7058 packages along with Org-mode, configure the variable | |
63833 | 7059 @code{org-CUA-compatible}. When set, Org-mode will move the following |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7060 keybindings in Org-mode files, and in the agenda buffer (but not |
63362 | 7061 during date selection). |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
7062 |
63362 | 7063 @example |
7064 S-UP -> M-p S-DOWN -> M-n | |
7065 S-LEFT -> M-- S-RIGHT -> M-+ | |
7066 @end example | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
7067 |
63362 | 7068 Yes, these are unfortunately more difficult to remember. If you want |
7069 to have other replacement keys, look at the variable | |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
7070 @code{org-disputed-keys}. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
7071 @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
|
7072 @cindex @file{windmove.el} |
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
7073 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
|
7074 in the paragraph above about CUA mode also applies here. |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7075 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7076 @cindex @file{footnote.el} |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7077 @item @file{footnote.el} by Steven L. Baur |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7078 Org-mode supports the syntax of the footnote package, but only the |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7079 numerical footnote markers. Also, the default key for footnote |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7080 commands, @kbd{C-c !} is already used by Org-mode. You could use the |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7081 variable @code{footnote-prefix} to switch footnotes commands to another |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7082 key. Or, you could use @code{org-replace-disputed-keys} and |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7083 @code{org-disputed-keys} to change the settings in Org-mode. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7084 |
58792 | 7085 @end table |
7086 | |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
7087 |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7088 @node Bugs, , Interaction, Miscellaneous |
63362 | 7089 @section Bugs |
7090 @cindex bugs | |
7091 | |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
7092 Here is a list of things that should work differently, but which I |
63362 | 7093 have found too hard to fix. |
58792 | 7094 |
63362 | 7095 @itemize @bullet |
63672
c90c20a1b568
(Remember): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents:
63362
diff
changeset
|
7096 @item |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
7097 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
|
7098 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
|
7099 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
|
7100 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
|
7101 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
|
7102 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
|
7103 @item |
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
7104 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
|
7105 @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
|
7106 @item |
65656 | 7107 Text in an entry protected with the @samp{QUOTE} keyword should not |
7108 autowrap. | |
7109 @item | |
63362 | 7110 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
|
7111 (for example because the application does not exist or refuses to open |
63362 | 7112 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
|
7113 @item |
63833 | 7114 Recalculating a table line applies the formulas from left to right. |
65656 | 7115 If a formula uses @emph{calculated} fields further down the row, |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7116 multiple recalculation may be needed to get all fields consistent. You |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7117 may use the command @code{org-table-iterate} (@kbd{C-u C-c *}) to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7118 recalculate until convergence. |
63833 | 7119 @item |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7120 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
|
7121 @item |
63362 | 7122 The exporters work well, but could be made more efficient. |
7123 @end itemize | |
7124 | |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7125 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7126 @node Extensions and Hacking, History and Acknowledgments, Miscellaneous, Top |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7127 @appendix Extensions, Hooks and Hacking |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7128 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7129 This appendix lists extensions for Org-mode written by other authors. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7130 It also covers some aspects where users can extend the functionality of |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7131 Org-mode. |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7132 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7133 @menu |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
7134 * Extensions:: Existing 3rd-part extensions |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7135 * Adding hyperlink types:: New custom link types |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7136 * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
7137 * Dynamic blocks:: Automatically filled blocks |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7138 * Special agenda views:: Customized views |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7139 * Using the property API:: Writing programs that use entry properties |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7140 @end menu |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7141 |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7142 @node Extensions, Adding hyperlink types, Extensions and Hacking, Extensions and Hacking |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7143 @section Third-party extensions for Org-mode |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7144 @cindex extension, third-party |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7145 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7146 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
|
7147 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7148 @table @asis |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7149 @cindex @file{org-publish.el} |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7150 @item @file{org-publish.el} by David O'Toole |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7151 This package provides facilities for publishing related sets of Org-mode |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7152 files together with linked files like images as webpages. It is |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7153 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
|
7154 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
|
7155 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
|
7156 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
|
7157 @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
|
7158 @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
|
7159 @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
|
7160 @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
|
7161 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
|
7162 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
|
7163 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
|
7164 @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
|
7165 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
|
7166 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
|
7167 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
|
7168 @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
|
7169 @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
|
7170 @cindex @file{org-blog.el} |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7171 @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
|
7172 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
|
7173 @url{http://dto.freeshell.org/notebook/OrgMode.html}. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7174 @cindex @file{blorg.el} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7175 @item @file{blorg.el} by Bastien Guerry |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7176 Publish Org-mode files as |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7177 blogs. @url{http://www.cognition.ens.fr/~guerry/blorg.html}. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7178 @cindex @file{org2rem.el} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7179 @item @file{org2rem.el} by Bastien Guerry |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7180 Translates Org-mode files into something readable by |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7181 Remind. @url{http://www.cognition.ens.fr/~guerry/u/org2rem.el}. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7182 @end table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7183 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7184 @page |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7185 |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7186 @node Adding hyperlink types, Tables in arbitrary syntax, Extensions, Extensions and Hacking |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7187 @section Adding hyperlink types |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7188 @cindex hyperlinks, adding new types |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7189 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7190 Org-mode has a large number of hyperlink types built-in |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7191 (@pxref{Hyperlinks}). If you would like to add new link types, it |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7192 provides an interface for doing so. Lets look at an example file |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7193 @file{org-man.el} that will add support for creating links like |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7194 @samp{[[man:printf][The printf manpage]]} to show unix manual pages inside |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7195 emacs: |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7196 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7197 @lisp |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7198 ;;; org-man.el - Support for links to manpages in Org-mode |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7199 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7200 (require 'org) |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7201 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7202 (org-add-link-type "man" 'org-man-open) |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7203 (add-hook 'org-store-link-functions 'org-man-store-link) |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7204 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7205 (defcustom org-man-command 'man |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7206 "The Emacs command to be used to display a man page." |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7207 :group 'org-link |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7208 :type '(choice (const man) (const woman))) |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7209 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7210 (defun org-man-open (path) |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7211 "Visit the manpage on PATH. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7212 PATH should be a topic that can be thrown at the man command." |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7213 (funcall org-man-command path)) |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7214 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7215 (defun org-man-store-link () |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7216 "Store a link to a manpage." |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7217 (when (memq major-mode '(Man-mode woman-mode)) |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7218 ;; This is a man page, we do make this link |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7219 (let* ((page (org-man-get-page-name)) |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7220 (link (concat "man:" page)) |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7221 (description (format "Manpage for %s" page))) |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7222 (org-store-link-props |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7223 :type "man" |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7224 :link link |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7225 :description description)))) |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7226 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7227 (defun org-man-get-page-name () |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7228 "Extract the page name from the buffer name." |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7229 ;; This works for both `Man-mode' and `woman-mode'. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7230 (if (string-match " \\(\\S-+\\)\\*" (buffer-name)) |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7231 (match-string 1 (buffer-name)) |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7232 (error "Cannot create link to this man page"))) |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7233 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7234 (provide 'org-man) |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7235 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7236 ;;; org-man.el ends here |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7237 @end lisp |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7238 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7239 @noindent |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7240 You would activate this new link type in @file{.emacs} with |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7241 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7242 @lisp |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7243 (require 'org-man) |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7244 @end lisp |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7245 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7246 @noindent |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7247 Lets go through the file and see what it does. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7248 @enumerate |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7249 @item |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7250 It does @code{(require 'org)} to make sure that @file{org.el} has been |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7251 loaded. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7252 @item |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7253 The next line calls @code{org-add-link-type} to define a new link type |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7254 with prefix @samp{man}. The call also contains the name of a function |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7255 that will be called to follow such a link. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7256 @item |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7257 The next line adds a function to @code{org-store-link-functions}, in |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7258 order to allow the command @kbd{C-c l} to record a useful link in a |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7259 buffer displaying a man page. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7260 @end enumerate |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7261 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7262 The rest of the file defines the necessary variables and functions. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7263 First there is a customization variable that determines which emacs |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7264 command should be used to display manpages. There are two options, |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7265 @code{man} and @code{woman}. Then the function to follow a link is |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7266 defined. It gets the link path as an argument - in this case the link |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7267 path is just a topic for the manual command. The function calls the |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7268 value of @code{org-man-command} to display the man page. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7269 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7270 Finally the function @code{org-man-store-link} is defined. When you try |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7271 to store a link with @kbd{C-c l}, also this function will be called to |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7272 try to make a link. The function must first decide if it is supposed to |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7273 create the link for this buffer type, we do this by checking the value |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7274 of the variable @code{major-mode}. If not, the function must exit and |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7275 retunr the value @code{nil}. If yes, the link is created by getting the |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7276 manual tpoic from the buffer name and prefixing it with the string |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7277 @samp{man:}. Then it must call the command @code{org-store-link-props} |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7278 and set the @code{:type} and @code{:link} properties. Optionally you |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7279 can also set the @code{:description} property to provide a default for |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7280 the link description when the link is later inserted into tan Org-mode |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7281 buffer with @kbd{C-c C-l}. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7282 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7283 @node Tables in arbitrary syntax, Dynamic blocks, Adding hyperlink types, Extensions and Hacking |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7284 @section Tables in arbitrary syntax |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7285 @cindex tables, in other modes |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7286 @cindex orgtbl-mode |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7287 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7288 Since Orgtbl-mode can be used as a minor mode in arbitrary buffers, a |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7289 frequent feature request has been to make it work with native tables in |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7290 specific languages, for example La@TeX{}. However, this is extremely hard |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7291 to do in a general way, would lead to a customization nightmare, and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7292 would take away much of the simplicity of the Orgtbl-mode table editor. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7293 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7294 This appendix describes a different approach. We keep the Orgtbl-mode |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7295 table in its native format (the @i{source table}), and use a custom |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7296 function to @i{translate} the table to the correct syntax, and to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7297 @i{install} it in the right location (the @i{target table}). This puts |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7298 the burden of writing conversion functions on the user, but it allows |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7299 for a very flexible system. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7300 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7301 @menu |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7302 * Radio tables:: Sending and receiving |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7303 * A LaTeX example:: Step by step, almost a tutorial |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7304 * Translator functions:: Copy and modify |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7305 @end menu |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7306 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7307 @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7308 @subsection Radio tables |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7309 @cindex radio tables |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7310 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7311 To define the location of the target table, you first need to create two |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7312 lines that are comments in the current mode, but contain magic words for |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7313 Orgtbl-mode to find. Orgtbl-mode will insert the translated table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7314 between these lines, replacing whatever was there before. For example: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7315 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7316 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7317 /* BEGIN RECEIVE ORGTBL table_name */ |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7318 /* END RECEIVE ORGTBL table_name */ |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7319 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7320 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7321 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7322 Just above the source table, we put a special line that tells |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7323 Orgtbl-mode how to translate this table and where to install it. For |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7324 example: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7325 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7326 #+ORGTBL: SEND table_name translation_function arguments.... |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7327 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7328 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7329 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7330 @code{table_name} is the reference name for the table that is also used |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7331 in the receiver lines. @code{translation_function} is the Lisp function |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7332 that does the translation. Furthermore, the line can contain a list of |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7333 arguments (alternating key and value) at the end. The arguments will be |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7334 passed as a property list to the translation function for |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7335 interpretation. A few standard parameters are already recognized and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7336 acted upon before the translation function is called: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7337 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7338 @table @code |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7339 @item :skip N |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7340 Skip the first N lines of the table. Hlines do count! |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7341 @item :skipcols (n1 n2 ...) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7342 List of columns that should be skipped. If the table has a column with |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7343 calculation marks, that column is automatically discarded as well. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7344 Please note that the translator function sees the table @emph{after} the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7345 removal of these columns, the function never knows that there have been |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7346 additional columns. |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7347 @end table |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7348 |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7349 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7350 The one problem remaining is how to keep the source table in the buffer |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7351 without disturbing the normal workings of the file, for example during |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7352 compilation of a C file or processing of a La@TeX{} file. There are a |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7353 number of different solutions: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7354 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7355 @itemize @bullet |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7356 @item |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7357 The table could be placed in a block comment if that is supported by the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7358 language. For example, in C-mode you could wrap the table between |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7359 @samp{/*} and @samp{*/} lines. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7360 @item |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7361 Sometimes it is possible to put the table after some kind of @i{END} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7362 statement, for example @samp{\bye} in TeX and @samp{\end@{document@}} |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7363 in La@TeX{}. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7364 @item |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7365 You can just comment the table line by line whenever you want to process |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7366 the file, and uncomment it whenever you need to edit the table. This |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7367 only sounds tedious - the command @kbd{M-x orgtbl-toggle-comment} does |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7368 make this comment-toggling very easy, in particular if you bind it to a |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7369 key. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7370 @end itemize |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7371 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7372 @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7373 @subsection A LaTeX example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7374 @cindex LaTeX, and orgtbl-mode |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7375 |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7376 The best way to wrap the source table in La@TeX{} is to use the |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7377 @code{comment} environment provided by @file{comment.sty}. It has to be |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7378 activated by placing @code{\usepackage@{comment@}} into the document |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7379 header. Orgtbl-mode can insert a radio table skeleton@footnote{By |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7380 default this works only for La@TeX{}, HTML, and TeXInfo. Configure the |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7381 variable @code{orgtbl-radio-tables} to install templates for other |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7382 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7383 be prompted for a table name, lets say we use @samp{salesfigures}. You |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7384 will then get the following template: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7385 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7386 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7387 % BEGIN RECEIVE ORGTBL salesfigures |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7388 % END RECEIVE ORGTBL salesfigures |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7389 \begin@{comment@} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7390 #+ORGTBL: SEND salesfigures orgtbl-to-latex |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7391 | | | |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7392 \end@{comment@} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7393 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7394 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7395 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7396 The @code{#+ORGTBL: SEND} line tells orgtbl-mode to use the function |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7397 @code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7398 into the receiver location with name @code{salesfigures}. You may now |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7399 fill in the table, feel free to use the spreadsheet features@footnote{If |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7400 the @samp{#+TBLFM} line contains an odd number of dollar characters, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7401 this may cause problems with font-lock in latex-mode. As shown in the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7402 example you can fix this by adding an extra line inside the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7403 @code{comment} environment that is used to balance the dollar |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7404 expressions. If you are using AUCTeX with the font-latex library, a |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7405 much better solution is to add the @code{comment} environment to the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7406 variable @code{LaTeX-verbatim-environments}.}: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7407 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7408 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7409 % BEGIN RECEIVE ORGTBL salesfigures |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7410 % END RECEIVE ORGTBL salesfigures |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7411 \begin@{comment@} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7412 #+ORGTBL: SEND salesfigures orgtbl-to-latex |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7413 | Month | Days | Nr sold | per day | |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7414 |-------+------+---------+---------| |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7415 | Jan | 23 | 55 | 2.4 | |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7416 | Feb | 21 | 16 | 0.8 | |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7417 | March | 22 | 278 | 12.6 | |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7418 #+TBLFM: $4=$3/$2;%.1f |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7419 % $ (optional extra dollar to keep font-lock happy, see footnote) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7420 \end@{comment@} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7421 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7422 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7423 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7424 When you are done, press @kbd{C-c C-c} in the table to get the converted |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7425 table inserted between the two marker lines. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7426 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7427 Now lets assume you want to make the table header by hand, because you |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7428 want to control how columns are aligned etc. In this case we make sure |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7429 that the table translator does skip the first 2 lines of the source |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7430 table, and tell the command to work as a @i{splice}, i.e. to not produce |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7431 header and footer commands of the target table: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7432 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7433 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7434 \begin@{tabular@}@{lrrr@} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7435 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\ |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7436 % BEGIN RECEIVE ORGTBL salesfigures |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7437 % END RECEIVE ORGTBL salesfigures |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7438 \end@{tabular@} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7439 % |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7440 \begin@{comment@} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7441 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7442 | Month | Days | Nr sold | per day | |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7443 |-------+------+---------+---------| |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7444 | Jan | 23 | 55 | 2.4 | |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7445 | Feb | 21 | 16 | 0.8 | |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7446 | March | 22 | 278 | 12.6 | |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7447 #+TBLFM: $4=$3/$2;%.1f |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7448 \end@{comment@} |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7449 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7450 |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7451 The La@TeX{} translator function @code{orgtbl-to-latex} is already part of |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7452 Orgtbl-mode. It uses a @code{tabular} environment to typeset the table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7453 and marks horizontal lines with @code{\hline}. Furthermore, it |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7454 interprets the following parameters: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7455 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7456 @table @code |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7457 @item :splice nil/t |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7458 When set to t, return only table body lines, don't wrap them into a |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7459 tabular environment. Default is nil. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7460 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7461 @item :fmt fmt |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7462 A format to be used to wrap each field, should contain @code{%s} for the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7463 original field value. For example, to wrap each field value in dollars, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7464 you could use @code{:fmt "$%s$"}. This may also be a property list with |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7465 column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7466 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7467 @item :efmt efmt |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7468 Use this format to print numbers with exponentials. The format should |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7469 have @code{%s} twice for inserting mantissa and exponent, for example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7470 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7471 may also be a property list with column numbers and formats, for example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7472 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7473 @code{efmt} has been applied to a value, @code{fmt} will also be |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7474 applied. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7475 @end table |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7476 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7477 @node Translator functions, , A LaTeX example, Tables in arbitrary syntax |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7478 @subsection Translator functions |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7479 @cindex HTML, and orgtbl-mode |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7480 @cindex translator function |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7481 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7482 Orgtbl-mode has several translator functions built-in: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7483 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7484 @code{orgtbl-to-texinfo}. Except for @code{orgtbl-to-html}@footnote{The |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7485 HTML translator uses the same code that produces tables during HTML |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7486 export.}, these all use a generic translator, @code{orgtbl-to-generic}. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7487 For example, @code{orgtbl-to-latex} itself is a very short function that |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7488 computes the column definitions for the @code{tabular} environment, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7489 defines a few field and line separators and then hands over to the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7490 generic translator. Here is the entire code: |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7491 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7492 @lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7493 @group |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7494 (defun orgtbl-to-latex (table params) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7495 "Convert the orgtbl-mode TABLE to LaTeX." |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7496 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l")) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7497 org-table-last-alignment "")) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7498 (params2 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7499 (list |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7500 :tstart (concat "\\begin@{tabular@}@{" alignment "@}") |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7501 :tend "\\end@{tabular@}" |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7502 :lstart "" :lend " \\\\" :sep " & " |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7503 :efmt "%s\\,(%s)" :hline "\\hline"))) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7504 (orgtbl-to-generic table (org-combine-plists params2 params)))) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7505 @end group |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7506 @end lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7507 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7508 As you can see, the properties passed into the function (variable |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7509 @var{PARAMS}) are combined with the ones newly defined in the function |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7510 (variable @var{PARAMS2}). The ones passed into the function (i.e. the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7511 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7512 would like to use the La@TeX{} translator, but wanted the line endings to |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7513 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7514 overrule the default with |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7515 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7516 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7517 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]" |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7518 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7519 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7520 For a new language, you can either write your own converter function in |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7521 analogy with the La@TeX{} translator, or you can use the generic function |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7522 directly. For example, if you have a language where a table is started |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7523 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7524 started with @samp{!BL!}, ended with @samp{!EL!} and where the field |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7525 separator is a TAB, you could call the generic translator like this (on |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7526 a single line!): |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7527 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7528 @example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7529 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!" |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7530 :lstart "!BL! " :lend " !EL!" :sep "\t" |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7531 @end example |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7532 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7533 @noindent |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7534 Please check the documentation string of the function |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7535 @code{orgtbl-to-generic} for a full list of parameters understood by |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7536 that function and remember that you can pass each of them into |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7537 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7538 using the generic function. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7539 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7540 Of course you can also write a completely new function doing complicated |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7541 things the generic translator cannot do. A translator function takes |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7542 two arguments. The first argument is the table, a list of lines, each |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7543 line either the symbol @code{hline} or a list of fields. The second |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7544 argument is the property list containing all parameters specified in the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7545 @samp{#+ORGTBL: SEND} line. The function must return a single string |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7546 containing the formatted table. If you write a generally useful |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7547 translator, please post it on @code{emacs-orgmode@@gnu.org} so that |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7548 others can benefit from your work. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7549 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7550 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Extensions and Hacking |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7551 @section Dynamic blocks |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7552 @cindex dynamic blocks |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7553 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7554 Org-mode documents can contain @emph{dynamic blocks}. These are |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7555 specially marked regions that are updated by some user-written function. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7556 A good example for such a block is the clock table inserted by the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7557 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}). |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7558 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7559 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
|
7560 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
|
7561 the content of the block. |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7562 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7563 @example |
72399
99e38d5aaf87
(Installation, Activation): Split from Installation and
Carsten Dominik <dominik@science.uva.nl>
parents:
72101
diff
changeset
|
7564 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ... |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7565 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7566 #+END: |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7567 @end example |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7568 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7569 Dynamic blocks are updated with the following commands |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7570 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7571 @table @kbd |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7572 @kindex C-c C-x C-u |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7573 @item C-c C-x C-u |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7574 Update dynamic block at point. |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7575 @kindex C-u C-c C-x C-u |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7576 @item C-u C-c C-x C-u |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7577 Update all dynamic blocks in the current file. |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7578 @end table |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7579 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7580 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
|
7581 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
|
7582 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
|
7583 with name @code{myblock}, the writer function is |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7584 @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
|
7585 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
|
7586 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
|
7587 run: |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7588 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7589 @example |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7590 #+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
|
7591 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7592 #+END: |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7593 @end example |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7594 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7595 @noindent |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7596 The corresponding block writer function could look like this: |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7597 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7598 @lisp |
71653
9c582eb56ce7
(Exporting): Document `C-c C-e' as the prefix for
Carsten Dominik <dominik@science.uva.nl>
parents:
71564
diff
changeset
|
7599 (defun org-dblock-write:block-update-time (params) |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7600 (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
|
7601 (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
|
7602 (format-time-string fmt (current-time))))) |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7603 @end lisp |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7604 |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7605 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
|
7606 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
|
7607 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
|
7608 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
|
7609 |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7610 @node Special agenda views, Using the property API, Dynamic blocks, Extensions and Hacking |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7611 @section Special Agenda Views |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7612 @cindex agenda views, user-defined |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7613 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7614 Org-mode provides a special hook that can be used to narrow down the |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7615 selection made by any of the agenda views. You may specify a function |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7616 that is used at each match to verify if the match should indeed be part |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7617 of the agenda view, and if not, how much should be skipped. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7618 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7619 Let's say you want to produce a list of projects that contain a WAITING |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7620 tag anywhere in the project tree. Let's further assume that you have |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7621 marked all tree headings that define a project with the todo keyword |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7622 PROJECT. In this case you would run a todo search for the keyword |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7623 PROJECT, but skip the match unless there is a WAITING tag anywhere in |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7624 the subtree belonging to the project line. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7625 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7626 To achieve this, you must write a function that searches the subtree for |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7627 the tag. If the tag is found, the function must return @code{nil} to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7628 indicate that this match should not be skipped. If there is no such |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7629 tag, return the location of the end of the subtree, to indicate that |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7630 search should continue from there. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7631 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7632 @lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7633 (defun my-skip-unless-waiting () |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7634 "Skip trees that are not waiting" |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7635 (let ((subtree-end (save-excursion (org-end-of-subtree t)))) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7636 (if (re-search-forward ":WAITING:" subtree-end t) |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7637 nil ; tag found, do not skip |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7638 subtree-end))) ; tag not found, continue after end of subtree |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7639 @end lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7640 |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7641 Now you may use this function in an agenda custom command, for example |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7642 like this: |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7643 |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7644 @lisp |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7645 (org-add-agenda-custom-command |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7646 '("b" todo "PROJECT" |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7647 ((org-agenda-skip-function 'my-org-waiting-projects) |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7648 (org-agenda-overriding-header "Projects waiting for something: ")))) |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7649 @end lisp |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7650 |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7651 Note that this also binds @code{org-agenda-overriding-header} to get a |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7652 meaningful header in the agenda view. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7653 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7654 You may also put a Lisp form into @code{org-agenda-skip-function}. In |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7655 particular, you may use the functions @code{org-agenda-skip-entry-if} |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7656 and @code{org-agenda-skip-subtree-if} in this form, for example: |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7657 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7658 @table @code |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7659 @item '(org-agenda-skip-entry-if 'scheduled) |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7660 Skip current entry if it has been scheduled. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7661 @item '(org-agenda-skip-entry-if 'notscheduled) |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7662 Skip current entry if it has not been scheduled. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7663 @item '(org-agenda-skip-entry-if 'deadline) |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7664 Skip current entry if it has a deadline. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7665 @item '(org-agenda-skip-entry-if 'scheduled 'deadline) |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7666 Skip current entry if it has a deadline, or if it is scheduled. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7667 @item '(org-agenda-skip-entry 'regexp "regular expression") |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7668 Skip current entry if the regular expression contained in the variable |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7669 @code{org-agenda-skip-regexp} matches in the entry. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7670 @item '(org-agenda-skip-subtree-if 'regexp "regular expression") |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7671 Same as above, but check and skip the entire subtree. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7672 @end table |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7673 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7674 Therefore we could also have written the search for WAITING projects |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7675 like this, even without defining a special function: |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7676 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7677 @lisp |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7678 (org-add-agenda-custom-command |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7679 '("b" todo "PROJECT" |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7680 ((org-agenda-skip-function '(org-agenda-skip-subtree-if |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7681 'regexp ":WAITING:")) |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7682 (org-agenda-overriding-header "Projects waiting for something: ")))) |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7683 @end lisp |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7684 |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7685 |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7686 @node Using the property API, , Special agenda views, Extensions and Hacking |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7687 @section Using the property API |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7688 @cindex API, for properties |
81789
98fb807fb54e
* org.texi (Properties and columns): Chapter rewritten.
Carsten Dominik <dominik@science.uva.nl>
parents:
81684
diff
changeset
|
7689 @cindex properties, API |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7690 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7691 Here is a description of the functions that can be used to work with |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7692 properties. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7693 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7694 @defun org-entry-properties &optional pom which |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7695 Get all properties of the entry at point-or-marker POM. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7696 This includes the TODO keyword, the tags, time strings for deadline, |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7697 scheduled, and clocking, and any additional properties defined in the |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7698 entry. The return value is an alist, keys may occur multiple times |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7699 if the property key was used several times. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7700 POM may also be nil, in which case the current entry is used. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7701 If WHICH is nil or `all', get all properties. If WHICH is |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7702 `special' or `standard', only get that subclass. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7703 @end defun |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7704 @defun org-entry-get pom property &optional inherit |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7705 Get value of PROPERTY for entry at point-or-marker POM. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7706 If INHERIT is non-nil and the entry does not have the property, |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7707 then also check higher levels of the hierarchy. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7708 @end defun |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7709 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7710 @defun org-entry-delete pom property |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7711 Delete the property PROPERTY from entry at point-or-marker POM. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7712 @end defun |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7713 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7714 @defun org-entry-put pom property value |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7715 Set PROPERTY to VALUE for entry at point-or-marker POM. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7716 @end defun |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7717 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7718 @defun org-buffer-property-keys &optional include-specials |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7719 Get all property keys in the current buffer. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7720 @end defun |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7721 |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7722 @defun org-insert-property-drawer |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7723 Insert a property drawer at point. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7724 @end defun |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7725 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7726 @node History and Acknowledgments, Index, Extensions and Hacking, Top |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7727 @appendix History and Acknowledgments |
58792 | 7728 @cindex acknowledgments |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7729 @cindex history |
67613
eab2494a32d7
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67604
diff
changeset
|
7730 @cindex thanks |
58792 | 7731 |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
7732 Org-mode was borne in 2003, out of frustration over the user interface |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7733 of the Emacs outline-mode. I was trying to organize my notes and |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7734 projects, and using Emacs seemed to be the natural way to go. However, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7735 having to remember eleven different commands with two or three keys per |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7736 command, only to hide and unhide parts of the outline tree, that seemed |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7737 entirely unacceptable to me. Also, when using outlines to take notes, I |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7738 constantly want to restructure the tree, organizing it parallel to my |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7739 thoughts and plans. @emph{Visibility cycling} and @emph{structure |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7740 editing} were originally implemented in the package |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7741 @file{outline-magic.el}, but quickly moved to the more general |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7742 @file{org.el}. As this environment became comfortable for project |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7743 planning, the next step was adding @emph{TODO entries}, basic @emph{time |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7744 stamps}, and @emph{table support}. These areas highlight the two main |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7745 goals that Org-mode still has today: To create a new, outline-based, |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7746 plain text mode with innovative and intuitive editing features, and to |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7747 incorporate project planning functionality directly into a notes file. |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
7748 |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7749 Since the first release, literally thousands of emails to me or on |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
7750 @code{emacs-orgmode@@gnu.org} have provided a constant stream of bug |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7751 reports, feedback, new ideas, and sometimes patches and add-on code. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7752 Many thanks to everyone who has helped to improve this package. I am |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7753 trying to keep here a list of the people who had significant influence |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7754 in shaping one or more aspects of Org-mode. The list may not be |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7755 complete, if I have forgotten someone, please accept my apologies and |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
7756 let me know. |
58792 | 7757 |
7758 @itemize @bullet | |
73967
8aa00b07ec99
Minor typo fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
73874
diff
changeset
|
7759 |
58792 | 7760 @item |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7761 @i{Russel Adams} came up with the idea for drawers. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7762 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7763 @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
|
7764 system. |
69090
66a57755230b
* org.texi (Internal Links): Rewritten to cover the modified
Carsten Dominik <dominik@science.uva.nl>
parents:
68639
diff
changeset
|
7765 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7766 @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
|
7767 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7768 @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
|
7769 for Remember. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
7770 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7771 @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
|
7772 specified time. |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
7773 @item |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7774 @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
|
7775 calculations and improved XEmacs compatibility, in particular by porting |
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7776 @file{nouline.el} to XEmacs. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
7777 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7778 @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
|
7779 @item |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7780 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7781 came up with the idea of properties, and that there should be an API for |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7782 them. |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
7783 @item |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7784 @i{Kees Dullemond} used to edit projects lists directly in HTML and so |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7785 inspired some of the early development, including HTML export. He also |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7786 asked for a way to narrow wide table columns. |
70065
4804517d7073
(Formula syntax): Fixed link to Calc Manual.
Carsten Dominik <dominik@science.uva.nl>
parents:
70011
diff
changeset
|
7787 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7788 @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
|
7789 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
|
7790 @item |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7791 @i{David Emery} provided a patch for custom CSS support in exported |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7792 HTML agendas. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7793 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7794 @i{Nic Ferrier} contributed mailcap and XOXO support. |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
7795 @item |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7796 @i{John Foerch} figured out how to make incremental search show context |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7797 around a match in a hidden outline tree. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7798 @item |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
7799 @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
|
7800 @item |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7801 @i{Bastien Guerry} wrote the La@TeX{} exporter and has been prolific |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7802 with patches, ideas, and bug reports. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7803 to Org-mode. |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7804 @item |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
7805 @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
|
7806 @item |
81684
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7807 @i{Scott Jaderholm} proposed footnotes, control over whitespace between |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7808 folded entries, and column view for properties. |
985d689b2181
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
81530
diff
changeset
|
7809 @item |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7810 @i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7811 provided frequent feedback and some patches. |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7812 @item |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7813 @i{Jason F. McBrayer} suggested agenda export to CSV format. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7814 @item |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7815 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7816 basis. |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
7817 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7818 @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
|
7819 happy. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
7820 @item |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7821 @i{Rick Moynihan} proposed to allow multiple TODO sequences in a file. |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7822 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7823 @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
|
7824 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7825 @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
|
7826 file links, and TAGS. |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
7827 @item |
76138
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7828 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7829 into Japanese. |
f89ec8cbd4d9
(The spreadsheet): Renamed from "Table calculations".
Carsten Dominik <dominik@science.uva.nl>
parents:
75348
diff
changeset
|
7830 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7831 @i{Oliver Oppitz} suggested multi-state TODO items. |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7832 @item |
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7833 @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
|
7834 links, among other things. |
67694
5f1a4736c318
*** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents:
67613
diff
changeset
|
7835 @item |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
7836 @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
|
7837 provided frequent feedback. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
7838 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7839 @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
|
7840 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7841 @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
|
7842 control. |
58792 | 7843 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7844 @i{Kevin Rogers} contributed code to access VM files on remote hosts. |
58792 | 7845 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7846 @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
|
7847 conflict with @file{allout.el}. |
70164
7ce8d4154af5
Many small fixes.
Carsten Dominik <dominik@science.uva.nl>
parents:
70133
diff
changeset
|
7848 @item |
74030 | 7849 @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
|
7850 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7851 @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
|
7852 of feedback. |
58792 | 7853 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7854 @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
|
7855 other things. |
63362 | 7856 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7857 Linking to VM/BBDB/GNUS was inspired by @i{Tom Shannon}'s |
58792 | 7858 @file{organizer-mode.el}. |
71450
93e8ae57983b
(Embedded LaTeX): New chapter.
Carsten Dominik <dominik@science.uva.nl>
parents:
71386
diff
changeset
|
7859 @item |
71508
c12f8a27aae5
(Embedded LaTeX): Fix typos and implement small improvements
Carsten Dominik <dominik@science.uva.nl>
parents:
71450
diff
changeset
|
7860 @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
|
7861 subtrees. |
58792 | 7862 @item |
73874
3d54d97a0181
(ARCHIVE tag): Document C-TAB for forcing cycling of
Carsten Dominik <dominik@science.uva.nl>
parents:
72888
diff
changeset
|
7863 @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
|
7864 @item |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7865 @i{Adam Spiers} asked for global linking commands and inspired the link |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7866 extension system. support mairix. |
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7867 @item |
71246
f32b17d18b4b
(ASCII export): Document indentation adaptation.
Carsten Dominik <dominik@science.uva.nl>
parents:
71224
diff
changeset
|
7868 @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
|
7869 chapter about publishing. |
70867
68e63907ebfb
(Plain lists): Added new item navigation commands.
Carsten Dominik <dominik@science.uva.nl>
parents:
70164
diff
changeset
|
7870 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7871 @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
|
7872 in HTML output. |
58792 | 7873 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7874 @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
|
7875 keyword. |
69456
6c85e996427c
(Clean view): Document new startup options.
Carsten Dominik <dominik@science.uva.nl>
parents:
69318
diff
changeset
|
7876 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7877 @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
|
7878 system. |
58792 | 7879 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7880 @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
|
7881 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
|
7882 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
|
7883 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
|
7884 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
|
7885 description is shown, and (ii) popping up a calendar to select a date. |
82760
fdded9c0e328
* org.texi (Adding hyperlink types): New section.
Carsten Dominik <dominik@science.uva.nl>
parents:
81838
diff
changeset
|
7886 John has also contributed a number of great ideas directly to Org-mode. |
58792 | 7887 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7888 @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
|
7889 linking to GNUS. |
69929
beebc22085fe
(Link format): New section, emphasis on bracket links.
Carsten Dominik <dominik@science.uva.nl>
parents:
69891
diff
changeset
|
7890 @item |
70951
39f6e1889f85
(ASCII export): Omit command name.
Carsten Dominik <dominik@science.uva.nl>
parents:
70867
diff
changeset
|
7891 @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
|
7892 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
|
7893 @item |
74030 | 7894 @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
|
7895 and contributed various ideas and code snippets. |
58792 | 7896 @end itemize |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7897 |
81167
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7898 |
bf0c02ef2719
Large number of changes.
Carsten Dominik <dominik@science.uva.nl>
parents:
77235
diff
changeset
|
7899 @node Index, Key Index, History and Acknowledgments, Top |
71386
0b2c58e8821c
(Publishing links): Document the
Carsten Dominik <dominik@science.uva.nl>
parents:
71312
diff
changeset
|
7900 @unnumbered Index |
58792 | 7901 |
7902 @printindex cp | |
7903 | |
7904 @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
|
7905 @unnumbered Key Index |
58792 | 7906 |
7907 @printindex ky | |
7908 | |
7909 @bye | |
64070 | 7910 |
7911 @ignore | |
7912 arch-tag: 7893d1fe-cc57-4d13-b5e5-f494a1bcc7ac | |
7913 @end ignore |