annotate man/org.texi @ 62096:8e4e8735ffb3

(Functions): Add "Obsolete Functions" to menu. (Defining Functions): Add xref. (Obsolete Functions): New node. (Function Safety): Standardize capitalization of section title.
author Luc Teirlinck <teirllm@auburn.edu>
date Thu, 05 May 2005 23:12:19 +0000
parents 88492f3ccffa
children 55227ff1f8d5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1 \input texinfo
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2 @c %**start of header
61923
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
3 @c @setfilename org
59542
fdada1e7ef51 Fixed typo in setfilename
Carsten Dominik <dominik@science.uva.nl>
parents: 59541
diff changeset
4 @setfilename ../info/org
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5 @settitle Org Mode Manual
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
6
61923
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
7 @set VERSION 3.08
61136
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
8 @set DATE April 2005
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10 @dircategory Emacs
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11 @direntry
58848
99bd50b5d3ca Fix @direntry file name.
Richard M. Stallman <rms@gnu.org>
parents: 58833
diff changeset
12 * Org Mode: (org). Outline-based notes management and organizer
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13 @end direntry
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
15 @c Version and Contact Info
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16 @set MAINTAINERSITE @uref{http://www.astro.uva.nl/~dominik/Tools/org/,maintainers webpage}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17 @set MAINTAINER Carsten Dominik
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18 @set MAINTAINEREMAIL @email{dominik@@science.uva.nl}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19 @set MAINTAINERCONTACT @uref{mailto:dominik@@science.uva.nl,contact the maintainer}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20 @c %**end of header
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 @finalout
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
22
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
23 @c Macro definitions
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
24
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
25 @c Subheadings inside a table. Need a difference between info and the rest.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
26 @macro tsubheading{text}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27 @ifinfo
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
28 @subsubheading \text\
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
29 @end ifinfo
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
30 @ifnotinfo
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
31 @item @b{\text\}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
32 @end ifnotinfo
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
33 @end macro
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35 @copying
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
36 This manual is for Org-mode (version @value{VERSION}).
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37
61136
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
38 Copyright @copyright{} 2004, 2005 Free Software Foundation
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
40 @quotation
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
41 Permission is granted to copy, distribute and/or modify this document
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
42 under the terms of the GNU Free Documentation License, Version 1.1 or
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
43 any later version published by the Free Software Foundation; with no
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
44 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
45 and with the Back-Cover Texts as in (a) below. A copy of the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46 license is included in the section entitled ``GNU Free Documentation
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
47 License.''
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
48
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
49 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
50 this GNU Manual, like GNU software. Copies published by the Free
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
51 Software Foundation raise funds for GNU development.''
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
52 @end quotation
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
53 @end copying
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
54
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
55 @titlepage
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
56 @title Org Mode Manual
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
57
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
58 @subtitle Release @value{VERSION}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
59 @author by Carsten Dominik
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
60
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
61 @c The following two commands start the copyright page.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
62 @page
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
63 @vskip 0pt plus 1filll
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
64 @insertcopying
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
65 @end titlepage
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
66
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
67 @c Output the table of contents at the beginning.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
68 @contents
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
69
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
70 @ifnottex
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
71 @node Top, Introduction, (dir), (dir)
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
72 @top Org Mode Manual
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
73
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
74 @insertcopying
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
75 @end ifnottex
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
76
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
77 @menu
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
78 * Introduction:: Getting started
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
79 * Document Structure:: A tree works like your brain
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
80 * Tables:: Pure magic for quick formatting
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
81 * Hyperlinks:: Notes in context
61923
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
82 * TODO items:: Every tree branch can be a TODO item
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
83 * Timestamps:: Assign date and time to items
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
84 * Timeline and Agenda:: Use time-stamped items to produce an agenda
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
85 * Exporting:: Sharing and publishing of notes
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
86 * Miscellaneous:: All the rest which did not fit elsewhere
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
87 * Index:: The fast road to specific information
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
88 * Key Index:: Key bindings and where they are described
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
89
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
90 @detailmenu
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
91 --- The Detailed Node Listing ---
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
92
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
93 Introduction
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
94
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
95 * Summary:: Brief summary of what Org-mode does
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
96 * Installation and Activation:: How to install Org-mode
61923
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
97 * Feedback:: Bug reportes, ideas, patches etc.
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
98
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
99 Document Structure
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
100
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
101 * Outlines:: Org-mode is based on outline-mode
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
102 * Headlines:: How to typeset org-tree headlines
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
103 * Visibility cycling:: Show ad hide, much simplified
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
104 * Motion:: Jumping to other headlines
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
105 * Structure editing:: Changing sequence and level of headlines
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
106 * Sparse trees:: Matches embedded in context
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
107
61923
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
108 Tables
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
109
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
110 * Built-in table editor:: Simple tables
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
111 * table.el:: Complex tables
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
112 * orgtbl-mode:: The table editor as minor mode
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
113
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
114 Hyperlinks
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
115
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
116 * Links:: URL-like links to the world
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
117 * Remember:: Org-trees store quick notes
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
118
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
119 TODO items
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
120
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
121 * TODO basics:: Marking and displaying TODO entries
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
122 * TODO extensions:: Workflow and assignments
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
123 * Priorities:: Some things are more important than others
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
124
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
125 Extended use of TODO keywords
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
126
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
127 * Workflow states:: From TODO to DONE in steps
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
128 * TODO types:: I do this, Fred the rest
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
129 * Per file keywords:: Different files, different requirements
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
130
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
131 Timestamps
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
132
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
133 * Time stamps:: Assigning a time to a tree entry
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
134 * Creating timestamps:: Commands which insert timestamps
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
135
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
136 Timeline and Agenda
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
137
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
138 * Timeline:: Time-sorted view for single file
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
139 * Agenda:: Your weekly planner
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
140 * Agenda commands:: Remote editing of org trees
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
141 * Calendar/Diary integration:: Integrating Anniversaries and more
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
142
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
143 Calendar/Diary integration
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
144
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
145 * Diary to agenda:: Agenda incorporates the diary
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
146 * Agenda to diary:: Diary incorporates the agenda
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
147
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
148 Exporting
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
149
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
150 * Export commands:: Commands which export and display
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
151 * HTML formatting:: Interpretation of the buffer content
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
152 * Export options:: How to influence exports
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
153 * Comment lines:: Lines which will not be exported
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
154
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
155 Miscellaneous
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
156
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
157 * Completion:: M-TAB knows what you need
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
158 * Customization:: Adapting Org-mode to your taste
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
159 * Tips and Tricks:: An author-imposed FAQ, sort of
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
160 * Interaction:: Other Emacs packages
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
161 * Acknowledgments:: These people provided feedback and more
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
162 * Bugs:: Things which do not work perfectly
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
163
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
164 @end detailmenu
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
165 @end menu
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
166
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
167 @node Introduction, Document Structure, Top, Top
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
168 @chapter Introduction
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
169 @cindex introduction
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
170
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
171 @menu
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
172 * Summary:: Brief summary of what Org-mode does
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
173 * Installation and Activation:: How to install Org-mode
61923
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
174 * Feedback:: Bug reportes, ideas, patches etc.
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
175 @end menu
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
176
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
177 @node Summary, Installation and Activation, Introduction, Introduction
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
178 @section Summary
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
179 @cindex summary
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
180
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
181 Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
182 project planning with a fast and effective plain-text system.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
183
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
184 Org-mode develops organizational tasks around NOTES files that contain
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
185 information about projects as plain text. Org-mode is implemented on
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
186 top of outline-mode, which makes it possible to keep the content of
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
187 large files well structured. Visibility cycling and structure editing
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
188 help to work with the tree. Tables are easily created with a built-in
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
189 table editor. Org-mode supports ToDo items, deadlines, time stamps,
61136
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
190 and scheduling. It dynamically compiles entries into an agenda that
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
191 utilizes and smoothly integrates much of the Emacs calendar and diary.
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
192 Plain text URL-like links connect to websites, emails, usenet
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
193 messages, BBDB entries, and any files related to the projects. For
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
194 printing and sharing of notes, an Org-mode file can be exported as a
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
195 structured ASCII file, or as HTML.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
196
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
197 Org-mode keeps simple things simple. Not every outline branch needs
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
198 to be an action item, not every action item needs to have priority or
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
199 scheduling information associated with it. Org-mode can be used on
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
200 different levels and in different ways, for example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
201
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
202 @example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
203 @r{@bullet{} as an outline extension with visibility cycling and structure editing}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
204 @r{@bullet{} as an ASCII system and table editor to take structured notes}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
205 @r{@bullet{} as a simple hypertext system, with HTML export}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
206 @r{@bullet{} as a TODO list editor}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
207 @r{@bullet{} as a full agenda and planner with deadlines and work scheduling}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
208 @end example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
209
61136
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
210 The Org-mode table editor can be integrated into any major mode by
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
211 activating the minor Orgtbl-mode.
59541
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
212
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
213 There is a website for Org-mode which provides links to the newest
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
214 version of Org-mode, as well as additional information, screen shots
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
215 and example files. This page is located at
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
216 @uref{http://www.astro.uva.nl/~dominik/Tools/org/}.
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
217
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
218 @page
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
219
61923
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
220 @node Installation and Activation, Feedback, Summary, Introduction
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
221 @section Installation and Activation
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
222 @cindex installation
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
223 @cindex autoload
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
224 @cindex global keybindings
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
225 @cindex keybindings, global
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
226
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
227 The instructions below assume that you have downloaded Org-mode from
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
228 the web. If Org-mode is part of the Emacs distribution or an XEmacs
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
229 package, you only need to add to @file{.emacs} the last three Lisp
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
230 lines below - all the rest will be taken care of automatically.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
231
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
232 Byte-compile @file{org.el} and put it on your load path. If you'd
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
233 like to use the Info documentation, copy the file @file{org} into the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
234 directory containing info files and run the command @code{install-info
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
235 org}.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
236
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
237 Then copy the following lines into @file{.emacs}. The last two lines
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
238 define @emph{global} keys for the commands @command{org-store-link}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
239 and @command{org-agenda} - please choose suitable keys yourself.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
240
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
241 @lisp
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
242 ;; These lines only if org-mode is not part of the X/Emacs distribution.
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
243 (autoload 'org-mode "org" "Org mode" t)
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
244 (autoload 'org-diary "org" "Diary entries from Org mode")
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
245 (autoload 'org-agenda "org" "Multi-file agenda from Org mode" t)
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
246 (autoload 'org-store-link "org" "Store a link to the current location" t)
59541
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
247 (autoload 'orgtbl-mode "org" "Org tables as a minor mode" t)
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
248 (autoload 'turn-on-orgtbl "org" "Org tables as a minor mode")
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
249
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
250 ;; The following lines are always needed. Choose your own keys.
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
251 (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
252 (define-key global-map "\C-cl" 'org-store-link)
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
253 (define-key global-map "\C-ca" 'org-agenda)
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
254 @end lisp
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
255
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
256 @cindex org-mode, turning on
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
257 @noindent
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
258 This will put all files with extension @samp{.org} into Org-mode. As
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
259 an alternative, make the first line of a file look like this:
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
260
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
261 @example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
262 MY PROJECTS -*- mode: org; -*-
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
263 @end example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
264
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
265 @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
266 the file's name is. See also the variable
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
267 @code{org-insert-mode-line-in-empty-file'}.
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
268
61923
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
269 @node Feedback, , Installation and Activation, Introduction
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
270 @section Feedback
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
271 @cindex feedback
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
272 @cindex bug reports
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
273 @cindex maintainer
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
274 @cindex author
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
275
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
276 If you find problems with Org-mode, or if you have questions, remarks,
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
277 or ideas about it, please contact the maintainer Carsten Dominik at
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
278 @value{MAINTAINEREMAIL}.
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
279
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
280 For bug reports, please provide as much information as possible,
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
281 including the version information of Emacs (@kbd{C-h v emacs-version
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
282 @key{RET}}) and Org-mode (@kbd{M-x org-version}), as well as the
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
283 Org-mode related setup in @file{.emacs}. If an error occurs, a
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
284 traceback can be very useful. Often a small example file helps, along
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
285 with clear information about:
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
286 @enumerate
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
287 @item What exactly did you do?
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
288 @item What did you expect to happen?
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
289 @item What happened instead?
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
290 @end enumerate
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
291 @noindent Thanks for helping to improve this mode.
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
292
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
293
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
294 @node Document Structure, Tables, Introduction, Top
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
295 @chapter Document Structure
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
296 @cindex document structure
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
297 @cindex structure of document
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
298
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
299 Org-mode is based on outline mode and provides flexible commands to
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
300 edit the structure of the document.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
301
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
302 @menu
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
303 * Outlines:: Org-mode is based on outline-mode
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
304 * Headlines:: How to typeset org-tree headlines
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
305 * Visibility cycling:: Show ad hide, much simplified
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
306 * Motion:: Jumping to other headlines
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
307 * Structure editing:: Changing sequence and level of headlines
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
308 * Sparse trees:: Matches embedded in context
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
309 @end menu
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
310
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
311 @node Outlines, Headlines, Document Structure, Document Structure
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
312 @section Outlines
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
313 @cindex outlines
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
314 @cindex outline-mode
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
315
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
316 Org-mode is implemented on top of outline-mode. Outlines allow to
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
317 organize a document in a hierarchical structure, which (at least for
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
318 me) is the best representation of notes and thoughts. Overview over
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
319 this structure is achieved by folding (hiding) large parts of the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
320 document to show only the general document structure and the parts
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
321 currently being worked on. Org-mode greatly simplifies the use of
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
322 outlines by compressing the entire show/hide functionality into a
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
323 single command @command{org-cycle}, which is bound to the @key{TAB}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
324 key.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
325
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
326 @node Headlines, Visibility cycling, Outlines, Document Structure
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
327 @section Headlines
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
328 @cindex headlines
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
329 @cindex outline tree
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
330
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
331 Headlines define the structure of an outline tree. The Headlines in
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
332 Org-mode start with one or more stars, for example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
333
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
334 @example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
335 * Top level headline
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
336 ** Second level
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
337 *** 3rd level
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
338 some text
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
339 *** 3rd level
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
340 more text
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
341 * Another top level headline
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
342 @end example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
343
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
344 @node Visibility cycling, Motion, Headlines, Document Structure
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
345 @section Visibility cycling
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
346 @cindex visibility cycling
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
347 @cindex trees, visibility
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
348
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
349 Outlines make it possible to hide parts of the text in the buffer.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
350 Org-mode uses a single command bound to the @key{TAB} key to change
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
351 the visibility in the buffer.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
352
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
353 @cindex subtree visibility states
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
354 @cindex folded, subtree visibility state
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
355 @cindex children, subtree visibility state
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
356 @cindex subtree, subtree visibility state
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
357 @table @kbd
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
358 @kindex @key{TAB}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
359 @item @key{TAB}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
360 Rotate current subtree between the states
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
361 @example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
362 ,-> FOLDED -> CHILDREN -> SUBTREE --.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
363 '-----------------------------------'
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
364 @end example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
365 At the beginning of the buffer (or when called with @kbd{C-u}), this does
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
366 the same as the command @kbd{S-@key{TAB}} below.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
367
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
368 @cindex global visibility states
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
369 @cindex overview, global visibility state
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
370 @cindex contents, global visibility state
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
371 @cindex show all, global visibility state
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
372 @kindex S-@key{TAB}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
373 @item S-@key{TAB}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
374 Rotate the entire buffer between the states
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
375 @example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
376 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
377 '--------------------------------------'
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
378 @end example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
379 Note that inside tables, @kbd{S-@key{TAB}} jumps to the previous field.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
380
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
381 @cindex show all, command
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
382 @kindex C-c C-a
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
383 @item C-c C-a
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
384 Show all.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
385 @end table
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
386
61136
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
387 When Emacs firsts visits a Org-mode file, the global state is set to
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
388 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
389 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
390 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
391 buffer:
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
392
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
393 @example
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
394 #+STARTUP: fold
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
395 #+STARTUP: nofold
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
396 #+STARTUP: content
61136
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
397 @end example
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
398
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
399 @node Motion, Structure editing, Visibility cycling, Document Structure
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
400 @section Motion
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
401 @cindex motion, between headlines
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
402 @cindex jumping, to headlines
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
403 The following commands jump to other headlines in the buffer.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
404
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
405 @table @kbd
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
406 @kindex C-c C-n
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
407 @item C-c C-n
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
408 Next heading.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
409 @kindex C-c C-p
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
410 @item C-c C-p
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
411 Previous heading.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
412 @kindex C-c C-f
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
413 @item C-c C-f
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
414 Next heading same level.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
415 @kindex C-c C-b
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
416 @item C-c C-b
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
417 Previous heading same level.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
418 @kindex C-c C-u
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
419 @item C-c C-u
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
420 Backward to higher level heading.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
421 @kindex C-c C-j
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
422 @item C-c C-j
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
423 Jump to a different place without changing the current outline
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
424 visibility. Shows the document structure in a temporary buffer, where
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
425 you can use visibility cycling (@key{TAB}) to find your destination.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
426 After pressing @key{RET}, the cursor moves to the selected location in
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
427 the original buffer, and the headings hierarchy above it is made
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
428 visible.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
429 @end table
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
430
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
431 @node Structure editing, Sparse trees, Motion, Document Structure
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
432 @section Structure editing
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
433 @cindex structure editing
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
434 @cindex headline, promotion and demotion
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
435 @cindex promotion, of subtrees
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
436 @cindex demotion, of subtrees
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
437 @cindex subtree, cut and paste
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
438 @cindex pasting, subtrees
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
439 @cindex cutting, subtrees
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
440 @cindex copying, subtrees
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
441
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
442 @table @kbd
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
443 @kindex M-@key{RET}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
444 @item M-@key{RET}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
445 Insert new heading with same level as current
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
446 @kindex M-S-@key{RET}
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
447 @item M-S-@key{RET}
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
448 Insert new TODO entry with same level as current heading.
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
449 @kindex M-@key{left}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
450 @item M-@key{left}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
451 Promote current heading by one level
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
452 @kindex M-@key{right}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
453 @item M-@key{right}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
454 Demote current heading by one level
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
455 @kindex M-S-@key{left}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
456 @item M-S-@key{left}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
457 Promote the current subtree by one level
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
458 @kindex M-S-@key{right}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
459 @item M-S-@key{right}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
460 Demote the current subtree by one level
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
461 @kindex M-S-@key{up}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
462 @item M-S-@key{up}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
463 Move subtree up (swap with previous subtree of same level)
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
464 @kindex M-S-@key{down}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
465 @item M-S-@key{down}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
466 Move subtree down (swap with next subtree of same level)
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
467 @kindex C-c C-h C-w
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
468 @item C-c C-h C-w
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
469 Kill subtree, i.e. remove it from buffer but save in kill ring.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
470 @kindex C-c C-h M-w
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
471 @item C-c C-h M-w
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
472 Copy subtree to kill ring.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
473 @kindex C-c C-h C-y
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
474 @item C-c C-h C-y
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
475 Yank subtree from kill ring. This does modify the level of the subtree to
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
476 make sure the tree fits in nicely at the yank position. The yank
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
477 level can also be specified with a prefix arg, or by yanking after a
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
478 headline marker like @samp{****}.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
479 @end table
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
480
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
481 @cindex region, active
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
482 @cindex active region
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
483 @cindex transient-mark-mode
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
484 When there is an active region (transient-mark-mode), promotion and
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
485 demotion work on all headlines in the region. To select a region of
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
486 headlines, it is best to place both point and mark at the beginning of a
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
487 line, mark at the beginning of the first headline, and point at the line
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
488 just after the last headline to change. Note that when the cursor is
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
489 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
490 functionality.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
491
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
492 @node Sparse trees, , Structure editing, Document Structure
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
493 @section Sparse trees
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
494 @cindex sparse trees
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
495 @cindex trees, sparse
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
496 @cindex folding, sparse trees
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
497 @cindex occur, command
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
498
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
499 An important feature of Org-mode is the ability to construct
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
500 @emph{sparse trees} for selected information in an outline tree. A
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
501 sparse tree means that the entire document is folded as much as
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
502 possible, but the selected information is made visible along with the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
503 headline structure above it. Just try it out and you will see
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
504 immediately how it works.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
505
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
506 Org-mode contains several commands creating such trees. The most
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
507 basic one is @command{org-occur}:
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
508
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
509 @table @kbd
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
510 @kindex C-c /
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
511 @item C-c /
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
512 Occur. Prompts for a regexp and shows a sparse tree with all matches.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
513 If the match is in a headline, the headline is made visible. If the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
514 match is in the body of an entry, headline and body are made visible.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
515 In order to provide minimal context, also the full hierarchy of
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
516 headlines above the match is shown, as well as the headline following
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
517 the match.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
518 @end table
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
519
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
520 Other commands are using this feature as well. For example @kbd{C-c
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
521 C-v} creates a sparse TODO tree (@pxref{TODO basics}).
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
522
61136
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
523 @kindex C-c C-x v
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
524 @cindex printing sparse trees
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
525 @cindex visible text, printing
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
526 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
527 @code{ps-print-buffer-with-faces} which does not print invisible parts
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
528 of the document @footnote{this does not work under XEmacs, because
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
529 XEmacs uses selective display for outlining, not text properties}.
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
530 Or you can use the command @kbd{C-c C-x v} to copy the visible part of
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
531 the document to another file (extension @file{.txt}) which then can be
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
532 printed in any desired way.
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
533
61923
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
534 @node Tables, Hyperlinks, Document Structure, Top
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
535 @chapter Tables
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
536 @cindex tables
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
537
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
538 For taking notes, tables are an essential tool because they allow
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
539 immediate and clear structuring of data. Org-mode has a very fast and
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
540 intuitive table editor built-in. More complex tables can be created
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
541 with the Emacs table.el package.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
542
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
543 @menu
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
544 * Built-in table editor:: Simple tables
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
545 * table.el:: Complex tables
59541
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
546 * orgtbl-mode:: The table editor as minor mode
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
547 @end menu
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
548
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
549 @node Built-in table editor, table.el, Tables, Tables
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
550 @section The built-in table editor
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
551 @cindex table editor, builtin
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
552
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
553 Org-mode makes it easy to format tables in plain ASCII. Any line with
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
554 @samp{|} as the first non-white character is considered part of a
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
555 table. @samp{|} is also the column separator. A table might look
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
556 like this:
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
557
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
558 @example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
559 | Name | Phone | Age |
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
560 |-------+-------+-----|
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
561 | Peter | 1234 | 17 |
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
562 | Anna | 4321 | 25 |
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
563 @end example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
564
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
565 A table is re-aligned automatically each time you press @key{TAB} or
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
566 @key{RET} inside the table. @key{TAB} also moves to the next field
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
567 (@key{RET} to the next row) and creates new table rows at the end of the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
568 table or before horizontal lines. The indentation of the table is set
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
569 by the first line. Any line starting with @samp{|-} is considered as a
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
570 horizontal separator line and will be expanded on the next re-align to
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
571 span the whole table width. So, to create the above table, you would
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
572 only type
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
573
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
574 @example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
575 |Name|Phone|Age
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
576 |-
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
577 @end example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
578
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
579 @noindent and then press @key{TAB} to align the table and start filling in
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
580 fields.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
581
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
582 @table @kbd
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
583 @tsubheading{Creation and conversion}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
584 @kindex C-c C-c
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
585 @item C-c C-c
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
586 Recognize @file{table.el} table. Works when the cursor is in a
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
587 table.el table
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
588
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
589 @kindex C-c C-c
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
590 @item C-c C-c
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
591 Convert region to table. Works when the cursor is not in an existing
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
592 table, and when there is a region defined. If every line contains at
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
593 least one TAB character, the function assumes that the material is tab
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
594 separated. If not, lines are split at whitespace into fields. You
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
595 can use a prefix argument to indicate how many consecutive spaces are
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
596 at least required to indicate a field separator (default: just one).
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
597
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
598 @item M-x org-table-create
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
599 Creates an empty Org-mode table. However, it is much easier to just
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
600 start typing, like @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
601
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
602 @tsubheading{Re-aligning and field motion}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
603 @kindex C-c C-c
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
604 @item C-c C-c
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
605 Re-align the table without moving the cursor.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
606
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
607 @kindex @key{TAB}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
608 @item @key{TAB}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
609 Re-align the table, move to the next field. Creates a new row if
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
610 necessary.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
611
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
612 @kindex S-@key{TAB}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
613 @item S-@key{TAB}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
614 Move to previous field.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
615
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
616 @kindex @key{RET}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
617 @item @key{RET}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
618 Re-align the table and move down to next row. Creates a new row if
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
619 necessary. At the beginning or end of a line, @key{RET} still does
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
620 NEWLINE, so it can be used to split a table.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
621
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
622 @tsubheading{Column and row editing}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
623 @kindex M-@key{left}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
624 @kindex M-@key{right}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
625 @item M-@key{left}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
626 @itemx M-@key{right}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
627 Move the current column left/right
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
628
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
629 @kindex M-S-@key{left}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
630 @item M-S-@key{left}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
631 Kill the current column.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
632
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
633 @kindex M-S-@key{right}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
634 @item M-S-@key{right}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
635 Insert a new column to the left of the cursor position.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
636
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
637 @kindex M-@key{up}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
638 @kindex M-@key{down}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
639 @item M-@key{up}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
640 @itemx M-@key{down}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
641 Move the current row up/down
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
642
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
643 @kindex M-S-@key{up}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
644 @item M-S-@key{up}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
645 Kill the current row or horizontal line.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
646
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
647 @kindex M-S-@key{down}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
648 @item M-S-@key{down}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
649 Insert a new row above (with arg: below) the current row.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
650
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
651 @kindex C-c -
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
652 @item C-c -
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
653 Insert a horizontal line below current row. With prefix arg, line is
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
654 created above the current line.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
655
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
656 @tsubheading{Regions}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
657 @kindex C-c C-h M-w
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
658 @item C-c C-h M-w
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
659 Copy an rectangular region from a table to a special clipboard. Point
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
660 and mark determine edge fields of the rectangle. The process ignores
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
661 horizontal separator lines.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
662 @kindex C-c C-h C-w
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
663 @item C-c C-h C-w
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
664 Copy an rectangular region from a table to a special clipboard, and
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
665 blank all fields in the rectangle.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
666 @kindex C-c C-h C-y
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
667 @item C-c C-h C-y
61136
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
668 Paste a rectangular region into a table.
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
669 The upper right corner ends up in the current field. All involved fields
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
670 will be overwritten. If the rectangle does not fit into the present table,
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
671 the table is enlarged as needed. The process ignores horizontal separator
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
672 lines.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
673 @kindex C-c C-q
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
674 @item C-c C-q
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
675 Wrap several fields in a column like a paragraph. If there is an active
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
676 region, and both point and mark are in the same column, the text in the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
677 column is wrapped to minimum width for the given number of lines. A
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
678 prefix ARG may be used to change the number of desired lines. If there
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
679 is no region, the current field is split at the cursor position and the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
680 text fragment to the right of the cursor is prepended to the field one
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
681 line down. If there is no region, but you specify a prefix ARG, the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
682 current field gets blank, and the content is appended to the field
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
683 above.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
684
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
685 @tsubheading{Calculations}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
686 @kindex C-c ?
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
687 @item C-c ?
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
688 Which table column is the cursor in? Displays number >0 in echo
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
689 area.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
690
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
691 @cindex region, active
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
692 @cindex active region
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
693 @cindex transient-mark-mode
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
694 @kindex C-c +
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
695 @item C-c +
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
696 Sum the numbers in the current column, or in the rectangle defined by
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
697 the active region. The result is displayed in the echo area and can
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
698 be inserted with @kbd{C-y}.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
699
61136
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
700 @kindex S-@key{RET}
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
701 @item S-@key{RET}
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
702 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
703 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
704 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
705 @code{org-table-copy-increment}, integer field values will be
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
706 incremented during copy.
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
707
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
708 @cindex formula, in tables
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
709 @cindex calculations, in tables
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
710 @kindex C-c =
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
711 @item C-c =
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
712 Replace current field with the result of a formula. Requires the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
713 Emacs calc package. The formula can access the current field with
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
714 @samp{$}, and the other fields in the current row
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
715 with @samp{$1}, @samp{$2},... For details see the documentation of the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
716 command @command{org-table-eval-formula}.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
717
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
718 @tsubheading{Miscellaneous}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
719 @kindex C-c |
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
720 @item C-c |
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
721 Toggle the visibility of vertical lines in tables. The lines are
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
722 still there, only made invisible with a text property. Any @samp{|}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
723 added by hand will become invisible on the next align.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
724 Typographically it is good style to have no vertical lines in tables.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
725
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
726 @item M-x org-table-import
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
727 Import a file as a table. The table should be TAB- or whitespace
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
728 separated. Useful for example to import an Excel table or data from a
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
729 database, because these programs generally can write TAB-separated text
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
730 files. This command works by inserting the file into the buffer and
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
731 then converting the region to a table. Any prefix argument is passed on
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
732 to the converter, which uses it to determine the separator.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
733
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
734 @item M-x org-table-export
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
735 Export the table as a TAB-separated file. Useful for data exchange with
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
736 for example Excel or database programs.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
737
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
738 @end table
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
739
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
740 If you don't like the automatic table editor because it gets into your
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
741 way in lines which you would like to start with @samp{|}, you can turn
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
742 it off with
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
743 @lisp
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
744 (setq org-enable-table-editor nil)
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
745 @end lisp
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
746 @noindent The only table command which then still works is
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
747 @kbd{C-c C-c} to do a manual re-align.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
748
59541
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
749 @node table.el, orgtbl-mode, Built-in table editor, Tables
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
750 @section The @file{table.el} package
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
751 @kindex C-c C-c
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
752 @cindex table editor, table.el
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
753 @cindex @file{table.el}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
754
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
755 More complex ASCII tables (with automatic line wrapping, column- and
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
756 row-spanning, and alignment) can be created using the Emacs table
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
757 package by Takaaki Ota (@uref{http://sourceforge.net/projects/table}).
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
758 When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org-mode
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
759 will call @command{table-recognize-table} and move the cursor into the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
760 table. Inside a table, the keymap of Org-mode is inactive. In order
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
761 to execute org-related commands, leave the table.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
762
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
763 @table @kbd
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
764 @kindex C-c #
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
765 @item C-c #
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
766 Insert a table.el table. If there is already a table at point, this
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
767 command converts it between the table.el format and the Org-mode
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
768 format. See the documentation string of the command
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
769 @code{org-convert-table} for the restrictions under which this is
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
770 possible.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
771 @end table
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
772
59541
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
773 @node orgtbl-mode, , table.el, Tables
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
774 @section The Orgtbl minor mode
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
775 @cindex orgtbl-mode
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
776 @cindex Minor mode for tables
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
777
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
778 If you like the intuitive way the Org-mode table editor works, you
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
779 might want to use it also in other modes like text-mode or mail-mode.
61923
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
780 The minor mode Orgtbl-mode makes this possible. You can always toggle
59541
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
781 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
782 example in mail mode, use
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
783 @lisp
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
784 (add-hook 'mail-mode-hook 'turn-on-orgtbl)
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
785 @end lisp
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
786
61923
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
787 @node Hyperlinks, TODO items, Tables, Top
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
788 @chapter Hyperlinks
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
789 @cindex hyperlinks
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
790
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
791 Just like HMTL, Org-mode provides links to other files, usenet
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
792 articles, emails and much more.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
793
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
794 @menu
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
795 * Links:: URL-like links to the world
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
796 * Remember:: Org-trees store quick notes
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
797 @end menu
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
798
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
799 @node Links, Remember, Hyperlinks, Hyperlinks
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
800 @section Links
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
801 @cindex links
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
802 @cindex GNUS links
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
803 @cindex BBDB links
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
804 @cindex VM links
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
805 @cindex RMAIL links
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
806 @cindex WANDERLUST links
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
807 @cindex USENET links
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
808 @cindex SHELL links
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
809
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
810 Org-mode supports links to files, websites, usenet and email messages;
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
811 and BBDB database entries. Links are just plain-text URL-like locators.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
812 The following list shows examples for each link type.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
813
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
814 @example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
815 http://www.astro.uva.nl/~dominik @r{on the web}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
816 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
817 file:papers/last.pdf @r{file, relative path}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
818 file:~/code/main.c:255 @r{file, with line number}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
819 news:comp.emacs @r{Usenet link}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
820 mailto:adent@@galaxy.net @r{Mail link}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
821 vm:folder @r{VM folder link}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
822 vm:folder#id @r{VM message link}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
823 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
824 wl:folder @r{WANDERLUST folder link}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
825 wl:folder#id @r{WANDERLUST message link}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
826 rmail:folder @r{RMAIL folder link}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
827 rmail:folder#id @r{RMAIL message link}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
828 gnus:group @r{GNUS group link}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
829 gnus:group#id @r{GNUS article link}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
830 bbdb:Richard Stallman @r{BBDB link}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
831 shell:ls *.org @r{A shell command}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
832 @end example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
833
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
834 A link may contain space characters and is terminated by the end of
61923
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
835 the line or, in tables, by the end of the table field. Therefore,
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
836 outside of tables there can be only one link per line (but see the
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
837 variable @code{org-allow-space-in-links}).
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
838
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
839 @cindex storing links
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
840 @table @kbd
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
841 @kindex C-c l
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
842 @item C-c l
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
843 Store a link to the current location. This is a @emph{global} command
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
844 which can be used in any buffer to create a link. The link will be
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
845 stored for later insertion into an Org-mode buffer (see below). For VM,
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
846 RMAIL, WANDERLUST, GNUS and BBDB buffers, the link will point to the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
847 current article/entry. For W3 and W3M buffer, the link goes to the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
848 current URL. For any other files, the link will just point to the file.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
849 The key binding @kbd{C-c l} is only a suggestion - see
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
850 @ref{Installation and Activation}.
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
851
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
852 @kindex C-c C-l
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
853 @item C-c C-l
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
854 Insert a link. This prompts for a link to be inserted into the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
855 buffer. You can just type a link, using one of the link type prefixes
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
856 mentioned in the examples above. Through completion, all links stored
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
857 during the current session can be accessed. When called with prefix
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
858 arg, you can use file name completion to enter a file link. Note that
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
859 you don't have to use this command to insert a link. Links in
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
860 Org-mode are plain text, and you can type or paste them straight into
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
861 the buffer.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
862
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
863 @cindex inserting links
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
864 @kindex C-c C-o
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
865 @item C-c C-o
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
866 Open link at point. This will launch a web browser for URLs (using
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
867 @command{browse-url-at-point}), run vm/gnus/bbdb for the corresponding
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
868 links, execute the command in a shell link, visit text files with
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
869 Emacs and select a suitable application for non-text files.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
870 Classification of files is based on file extension only. See option
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
871 @code{org-file-apps}. If there is no link at point, the current
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
872 subtree will be searched for one. If you want to override the default
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
873 application and visit the file with Emacs, use a @kbd{C-u} prefix.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
874 If the cursor is on a time stamp, compiles the agenda for that date.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
875
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
876 @strong{IMPORTANT}: Be careful not to use any dangerous commands in a
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
877 shell link.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
878
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
879 @kindex mouse-2
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
880 @item mouse-2
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
881 On links, @kbd{mouse-2} will open the link just like @kbd{C-c C-o} would.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
882
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
883 @kindex mouse-3
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
884 @item mouse-3
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
885 Like @kbd{mouse-2}, but force file links to be opened with Emacs.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
886 @end table
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
887
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
888 @node Remember, , Links, Hyperlinks
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
889 @section Remember
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
890 @cindex @file{remember.el}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
891
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
892 Another way to create org entries with links to other files is through
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
893 the @emph{Remember} package by John Wiegley. @emph{Remember} lets you
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
894 store quick notes with little interruption of your work flow. See
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
895 @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
896 information. The notes produced by @emph{Remember} can be stored in
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
897 different ways, and Org-mode files are a good target.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
898 Org-mode allows to file away notes either to a default file, or
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
899 directly to the correct location in your Org-mode outline tree. The
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
900 following customization will tell @emph{Remember} to use org files as
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
901 target, and to create annotations compatible with Org-mode links.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
902
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
903 @c FIXME: The autoload will not be necessary when Org-mode is part of Emacs
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
904 @example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
905 (autoload 'org-remember-annotation "org")
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
906 (autoload 'org-remember-handler "org")
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
907 (setq org-directory "~/path/to/my/orgfiles/")
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
908 (setq org-default-notes-file "~/.notes")
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
909 (setq remember-annotation-functions '(org-remember-annotation))
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
910 (setq remember-handler-functions '(org-remember-handler))
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
911 @end example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
912
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
913 When you compose a note with remember, you have to press @kbd{C-c C-c}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
914 to exit remember-mode and to file away the note. The handler first
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
915 prompts for a target file - if you press @key{RET}, the value of
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
916 @code{org-default-notes-file} is used. Then the command offers the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
917 headings tree of the selected file. You can either immediately press
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
918 @key{RET} to get the note appended to the file. Or you can use
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
919 vertical cursor motion (@key{up} and @key{down}) and visibility
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
920 cycling (@key{TAB}) to find a better place. Pressing @key{RET} or
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
921 @key{left} or @key{right} leads to the following result.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
922
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
923 @multitable @columnfractions 0.2 0.1 0.7
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
924 @item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
925 @item buffer-start @tab @key{RET} @tab as level 2 heading at end of file
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
926 @item on headline @tab @key{RET} @tab as sublevel of the heading at cursor
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
927 @item @tab @key{left} @tab as same level, before current heading
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
928 @item @tab @key{right} @tab as same level, after current heading
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
929 @item not on headline @tab @key{RET}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
930 @tab at cursor position, level taken from context.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
931 Or use prefix arg to specify level manually.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
932 @end multitable
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
933
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
934 So the fastest way to store the note is to press @kbd{C-c C-c @key{RET}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
935 @key{RET}} to append it to the default file. But with little extra
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
936 effort, you can push it directly to the correct location.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
937
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
938 Before inserting the text into a tree, the function ensures that the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
939 text has a headline, i.e. a first line that starts with a @samp{*}.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
940 If not, a headline is constructed from the current date and some
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
941 additional data. If the variable @code{org-adapt-indentation} is
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
942 non-nil, the entire text is also indented so that it starts in the
61136
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
943 same column as the headline (after the asterisks).
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
944
61923
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
945 @node TODO items, Timestamps, Hyperlinks, Top
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
946 @chapter TODO items
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
947 @cindex TODO items
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
948
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
949 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
950 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
951 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
952 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
953 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
954 item emerged is always present when you check.
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
955
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
956 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
957 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
958 things you have to do.
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
959
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
960 @menu
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
961 * TODO basics:: Marking and displaying TODO entries
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
962 * TODO extensions:: Workflow and assignments
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
963 * Priorities:: Some things are more important than others
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
964 @end menu
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
965
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
966 @node TODO basics, TODO extensions, TODO items, TODO items
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
967 @section Basic TODO functionality
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
968
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
969 Any headline can become a TODO item by starting it with the word TODO,
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
970 for example
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
971
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
972 @example
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
973 *** TODO Write letter to Sam Fortune
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
974 @end example
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
975
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
976 @noindent
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
977 The most important commands to work with TODO entries are:
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
978
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
979 @table @kbd
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
980 @kindex C-c C-t
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
981 @item C-c C-t
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
982 Rotate the TODO state of the current item between
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
983 @example
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
984 ,-> (unmarked) -> TODO -> DONE --.
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
985 '--------------------------------'
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
986 @end example
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
987 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
988 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
989 @kindex C-c C-v
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
990 @cindex sparse tree, for TODO
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
991 @item C-c C-v
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
992 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
993 the entire buffer, but shows all TODO items and the headings hierarchy
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
994 above them. With prefix arg, show also the DONE entries.
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
995 @item C-u C-c a
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
996 A @kbd{C-u} argument to the @code{org-agenda command} (@pxref{Agenda})
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
997 collects all unfinished TODO items into a single place.
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
998 @end table
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
999
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1000 @node TODO extensions, Priorities, TODO basics, TODO items
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1001 @section Extended use of TODO keywords
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1002 @cindex extended TODO keywords
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1003
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1004 The default implementation of TODO entries is just two states: TODO
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1005 and DONE. You can, however, use the TODO feature for more
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1006 complicated things by configuring the variables
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1007 @code{org-todo-keywords} and @code{org-todo-interpretation}. Using
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1008 special setup, you can even use TODO keywords in different ways in
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1009 different org files.
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1010
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1011 @menu
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1012 * Workflow states:: From TODO to DONE in steps
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1013 * TODO types:: I do this, Fred the rest
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1014 * Per file keywords:: Different files, different requirements
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1015 @end menu
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1016
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1017 @node Workflow states, TODO types, TODO extensions, TODO extensions
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1018 @subsection TODO keywords as workflow states
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1019 @cindex TODO workflow
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1020 @cindex workflow states as TODO keywords
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1021
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1022 You can use TODO keywords to indicate different states in the process
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1023 of working on an item, for example
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1024
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1025 @lisp
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1026 (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1027 org-todo-interpretation 'sequence)
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1028 @end lisp
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1029
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1030 With this setup, the command @kbd{C-c C-t} will cycle an entry from
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1031 TODO to FEEDBACK, then to VERIFY, and finally too DONE. You may also
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1032 use a prefix argument to quickly select a specific state. For example
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1033 @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1034 If you define many keywords, you can use in-buffer completion (see
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1035 @ref{Completion}) to insert these words into the buffer.
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1036
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1037 @node TODO types, Per file keywords, Workflow states, TODO extensions
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1038 @subsection TODO keywords as types
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1039 @cindex TODO types
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1040 @cindex names as TODO keywords
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1041 @cindex types as TODO keywords
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1042
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1043 The second possibility is to use TODO keywords to indicate different
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1044 types of action items. For example, you might want to indicate that
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1045 items are for ``work'' or ``home''. Or, when you work with several
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1046 people on a single project, you might want to assign action items
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1047 directly to persons, by using their names as TODO keywords. This
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1048 would be set up like this:
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1049
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1050 @lisp
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1051 (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE")
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1052 org-todo-interpretation 'type)
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1053 @end lisp
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1054
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1055 In this case, different keywords do not indicate a sequence, but
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1056 rather different types. So it is normally not useful to change from
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1057 one type to another. Therefore, in this case the the behavior of the
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1058 command @kbd{C-c C-t} is changed slightly@footnote{This is also true
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1059 for the @kbd{t} command in the timeline and agenda buffers}. When
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1060 used several times in succession, it will still cycle through all
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1061 names. But when when you return to the item after some time and
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1062 execute @kbd{C-c C-t} again, it will switch from each name directly to
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1063 DONE. Use prefix arguments or completion to quickly select a specific
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1064 name.
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1065
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1066 @node Per file keywords, , TODO types, TODO extensions
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1067 @subsection Setting up TODO keywords for individual files
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1068 @cindex keyword options
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1069 @cindex per file keywords
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1070
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1071 It can be very useful to use different aspects of the TODO mechanism
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1072 in different files, which is not possible with the global settings
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1073 described above. For file-local settings, you need to add special
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1074 lines to the file which set the keywords and interpretation for that
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1075 file only. For example, to set one of the two examples discussed
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1076 above, you need one of the following lines, starting in column zero
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1077 anywhere in the file:
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1078
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1079 @example
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1080 #+SEQ_TODO: TODO FEEDBACK VERIFY DONE
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1081 #+TYP_TODO: Fred Sara Lucy Mike DONE
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1082 @end example
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1083
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1084 @cindex Completing option keywords
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1085 @kindex M-@key{TAB}
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1086 @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
1087 @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
1088
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1089 @cindex DONE, final TODO keyword
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1090 Remember that the last keyword must always mean that the item is DONE
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1091 (you may use a different word, though). Also note that in each file,
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1092 only one of the two aspects of TODO keywords can be used. After
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1093 changing one of these lines, use @kbd{C-c C-c} with the cursor still
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1094 in the line to make the changes known to Org-mode@footnote{Org-mode
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1095 parses these lines only when Org-mode is activated after visiting a
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1096 file. @kbd{C-c C-c} with the cursor in a line starting with @samp{#-}
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1097 is simply restarting Org-mode, making sure that these changes will be
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1098 respected.}.
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1099
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1100 If you want to use very many keywords, for example when working with a
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1101 large group of people, you may split the names over several lines:
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1102
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1103 @example
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1104 #+TYP_TODO: Fred Sara Lucy Mike
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1105 #+TYP_TODO: Luis George Jules Jessica
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1106 #+TYP_TODO: Kim Arnold Peter
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1107 #+TYP_TODO: DONE
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1108 @end example
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1109
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1110 @node Priorities, , TODO extensions, TODO items
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1111 @section Priorities
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1112 @cindex priorities
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1113
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1114 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
1115 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
1116 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
1117 headline, like this
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1118
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1119 @example
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1120 *** TODO [#A] Write letter to Sam Fortune
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1121 @end example
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1122
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1123 @noindent
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1124 With its standard setup, Org-mode supports priorities @samp{A},
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1125 @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
1126 without a cookie is treated as priority @samp{B}. Priorities make a
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1127 difference only in the agenda (@pxref{Agenda}).
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1128
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1129 @table @kbd
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1130 @kindex @kbd{C-c ,}
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1131 @item @kbd{C-c ,}
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1132 Set the priority of the current item. The command prompts for a
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1133 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
1134 @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
1135 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
1136 agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1137
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1138 @kindex S-@key{up}
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1139 @kindex S-@key{down}
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1140 @item S-@key{up}
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1141 @itemx S-@key{down}
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1142 Increase/decrease priority of current item. Note that these keys are
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1143 also used to modify time stamps (@pxref{Creating timestamps}).
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1144 @end table
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1145
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1146
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1147
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1148 @node Timestamps, Timeline and Agenda, TODO items, Top
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1149 @chapter Timestamps
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1150
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1151 Items can be labeled with timestamps to make them useful for project
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1152 planning.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1153
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1154 @menu
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1155 * Time stamps:: Assigning a time to a tree entry
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1156 * Creating timestamps:: Commands which insert timestamps
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1157 @end menu
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1158
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1159
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1160 @node Time stamps, Creating timestamps, Timestamps, Timestamps
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1161 @section Time stamps, deadlines and scheduling
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1162 @cindex time stamps
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1163 @cindex deadlines
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1164 @cindex scheduling
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1165
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1166 A time stamp is a specification of a date (possibly with time) in a
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1167 special format, either @samp{<2003-09-16 Tue>} or @samp{<2003-09-16
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1168 Tue 09:39>}. A time stamp can appear anywhere in the headline or body
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1169 of an org-tree entry. Its presence allows to show entries on specific
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1170 dates in the agenda (@pxref{Agenda}). We distinguish:
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1171
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1172 @table @var
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1173 @cindex timestamp
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1174 @item TIMESTAMP
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1175 A simple time stamp just assigns a date/time to an item. In the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1176 timeline and agenda displays, the headline of the entry will be shown
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1177 exactly on that date.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1178
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1179 @item TIMERANGE
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1180 @cindex timerange
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1181 Two time stamps connected by @samp{--} denote a time range. The
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1182 headline will be shown on the first and last day of the range, and on
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1183 any dates that are displayed and fall in the range. Here is an
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1184 example:
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1185
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1186 @example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1187 ** Meeting in Amsterdam
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1188 <2004-08-23 Mon>--<2004-08-26 Thu>
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1189 @end example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1190
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1191 @item DEADLINE
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1192 @cindex deadline
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1193 If a time stamp is preceded by the word @samp{DEADLINE:}, the task
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1194 (most likely a TODO item) is supposed to be finished on that date, and
59541
7de30c78c347 version 3.04
Carsten Dominik <dominik@science.uva.nl>
parents: 58848
diff changeset
1195 it will be listed then. In addition, the compilation for the
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1196 @emph{current day} will carry a warning about the approaching or
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1197 missed deadline, starting @code{org-deadline-warning-days} before the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1198 due date, and continuing until the entry is marked DONE. An example:
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1199
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1200 @example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1201 *** TODO write article about the Earth for the Guide
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1202 The editor in charge is bbdb:Ford Prefect
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1203 DEADLINE: <2004-02-29 Sun>
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1204 @end example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1205
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1206 @item SCHEDULED
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1207 @cindex scheduled
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1208 If a time stamp is preceded by the word @samp{SCHEDULED:}, it means
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1209 you are planning to start working on that task on the given date. The
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1210 headline will be listed under the given date. In addition, a reminder
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1211 that the scheduled date has passed will be present in the compilation
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1212 for the @emph{current day}, until the entry is marked DONE. I.e., the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1213 task will automatically be forwarded.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1214 @end table
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1215
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1216 @node Creating timestamps, , Time stamps, Timestamps
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1217 @section Creating timestamps
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1218 @cindex creating timestamps
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1219
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1220 For Org-mode to recognize time stamps, they need to be in the specific
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1221 format. All commands listed below produce time stamps in the correct
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1222 format.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1223
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1224 @table @kbd
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1225 @kindex C-c .
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1226 @item C-c .
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1227 Prompt for a date and insert a corresponding time stamp. When the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1228 cursor is at a previously used time stamp, it is updated to NOW. When
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1229 this command is used twice in succession, a time range is inserted.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1230
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1231 @kindex C-u C-c .
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1232 @item C-u C-c .
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1233 Like @kbd{C-c .}, but use the alternative format which contains date
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1234 and time.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1235
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1236 @kindex C-c <
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1237 @item C-c <
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1238 Insert a time stamp corresponding to the cursor date in the Calendar.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1239
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1240 @kindex C-c >
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1241 @item C-c >
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1242 Access the Emacs calendar for the current date. If there is a
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1243 timestamp in the current line, goto the corresponding date
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1244 instead.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1245
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1246 @kindex C-c C-o
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1247 @item C-c C-o
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1248 Access the agenda for the date given by the time stamp at point
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1249 (@pxref{Agenda}).
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1250
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1251 @kindex C-c C-d
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1252 @item C-c C-d
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1253 Insert @samp{DEADLINE} keyword along with a stamp.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1254 @kindex C-c C-w
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1255 @cindex sparse tree, for deadlines
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1256 @item C-c C-w
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1257 Create a sparse tree with all deadlines that are either past-due, or
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1258 which will become due within @code{org-deadline-warning-days}.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1259 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1260 prefix, check that many days. For example, @kbd{C-1 C-c C-w} shows
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1261 all deadlines due tomorrow.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1262
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1263 @kindex C-c C-s
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1264 @item C-c C-s
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1265 Insert @samp{SCHEDULED} keyword along with a stamp.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1266
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1267 @kindex S-@key{left}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1268 @kindex S-@key{right}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1269 @item S-@key{left}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1270 @itemx S-@key{right}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1271 Change date at cursor by one day.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1272
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1273 @kindex S-@key{up}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1274 @kindex S-@key{down}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1275 @item S-@key{up}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1276 @itemx S-@key{down}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1277 Change the item under the cursor in a timestamp. The cursor can be on
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1278 a year, month, day, hour or minute. Note that if the cursor is not at
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1279 a time stamp, these same keys modify the priority of an item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1280 (@pxref{Priorities}).
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1281
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1282 @kindex C-c C-y
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1283 @cindex evaluate time range
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1284 @item C-c C-y
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1285 Evaluate a time range by computing the difference between start and
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1286 end. With prefix arg, insert result after the time range (in a table:
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1287 into the following column).
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1288 @end table
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1289
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1290 @cindex date, reading in minibuffer
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1291 @cindex time, reading in minibuffer
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1292 @cindex calendar, for selecting date
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1293 When org prompts for a date/time, the function reading your input will
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1294 replace anything you choose not to specify with the current date and
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1295 time. For details, see the documentation string of
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1296 @command{org-read-date}. Also, a calender will pop up to allow
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1297 selecting a date. The calendar can be fully controlled from the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1298 minibuffer, and a date can be selected with the following commands:
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1299
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1300 @table @kbd
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1301 @kindex <
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1302 @item <
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1303 Scroll calendar backwards by one month.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1304 @kindex >
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1305 @item >
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1306 Scroll calendar forwards by one month.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1307 @kindex mouse-1
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1308 @item mouse-1
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1309 Select date by clicking on it.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1310 @kindex S-@key{right}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1311 @item S-@key{right}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1312 One day forward.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1313 @kindex S-@key{left}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1314 @item S-@key{left}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1315 One day back.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1316 @kindex S-@key{down}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1317 @item S-@key{down}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1318 One week forward.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1319 @kindex S-@key{up}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1320 @item S-@key{up}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1321 One week back.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1322 @kindex M-S-@key{right}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1323 @item M-S-@key{right}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1324 One month forward.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1325 @kindex M-S-@key{left}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1326 @item M-S-@key{left}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1327 One month back.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1328 @kindex @key{RET}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1329 @item @key{RET}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1330 Choose date in calendar (only if nothing typed into minibuffer).
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1331 @end table
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1332
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1333 @node Timeline and Agenda, Exporting, Timestamps, Top
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1334 @chapter Timeline and Agenda
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1335 @cindex agenda
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1336
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1337 We have already described three commands to filter important
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1338 information in an org file into a sparse tree (@pxref{Sparse trees}):
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1339
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1340 @cindex sparse trees
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1341 @itemize @bullet
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1342 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1343 The TODO tree, (@kbd{C-c C-v}), see @ref{TODO items}.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1344 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1345 The occur tree @kbd{C-c /}, see @ref{TODO items}.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1346 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1347 Checking upcoming deadlines with @kbd{C-c C-w}, see @ref{Creating
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1348 timestamps}.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1349 @end itemize
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1350 @noindent
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1351
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1352 Instead of using the sparse trees, Org-mode can also collect and
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1353 time-sort the important items into a separate buffer, which we call
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1354 the @emph{timeline} of the org file. It can also collect information
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1355 from a @emph{list of files} and in this way provide an @emph{agenda}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1356 which covers all of your current projects, action items and
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1357 appointments.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1358
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1359 @menu
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1360 * Timeline:: Time-sorted view for single file
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1361 * Agenda:: Your weekly planner
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1362 * Agenda commands:: Remote editing of org trees
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1363 * Calendar/Diary integration:: Integrating Anniversaries and more
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1364 @end menu
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1365
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1366 @node Timeline, Agenda, Timeline and Agenda, Timeline and Agenda
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1367 @section Timeline for a single file
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1368 @cindex single file summary
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1369 @cindex agenda, for single file
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1370 @cindex timeline, single file
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1371 @cindex time-sorted view
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1372
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1373 The timeline shows all time-stamped items in a single Org-mode file,
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1374 in @emph{time-sorted view}. The main purpose of this command is to
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1375 give an overview over events in a project.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1376
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1377 @table @kbd
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1378 @kindex C-c C-r
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1379 @item C-c C-r
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1380 Show a time-sorted view of the org file, with all time-stamped items
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1381 of today or later. When called with a @kbd{C-u} prefix, past dates
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1382 will be included as well. When called with two @kbd{C-u C-u}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1383 prefixes, all unfinished TODO entries (scheduled or not) are also
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1384 listed under the current date.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1385 @end table
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1386 @noindent
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1387
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1388 The timeline is shown in a temporary buffer @file{*Org Agenda*}. The
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1389 commands available in the Agenda buffer are listed in @ref{Agenda
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1390 commands}.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1391
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1392 @node Agenda, Agenda commands, Timeline, Timeline and Agenda
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1393 @section Agenda
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1394 @cindex agenda
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1395
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1396 An agenda can be compiled from one or more org files. The main
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1397 purpose of this command is to act like a planner, in order to show you
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1398 what tasks are up for the current week, similar to a paper agenda.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1399
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1400 The Org-mode files to be processed in order to generate the agenda are
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1401 listed in the variable @code{org-agenda-files}. You can customize
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1402 this variable, but the easiest way to maintain it is through the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1403 following commands
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1404
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1405 @cindex files, adding to agenda list
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1406 @table @kbd
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1407 @kindex C-c [
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1408 @item C-c [
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1409 Add current file to the list of agenda files
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1410 @kindex C-c ]
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1411 @item C-c ]
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1412 Remove current file from the list of agenda files.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1413 @end table
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1414 @noindent
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1415 The Org menu contains the list of all files and can be used to quickly
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1416 visit any of them.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1417
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1418 The global command @command{org-agenda} compiles the agenda from all
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1419 listed files.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1420
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1421 @table @kbd
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1422 @cindex org-agenda, command
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1423 @kindex C-c a
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1424 @item C-c a
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1425 Compile an agenda for the current week from a list of org files. The
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1426 agenda shows the entries for each day. With a @kbd{C-u} prefix (or
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1427 when the variable @code{org-agenda-include-all-todo} is @code{t}), all
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1428 unfinished TODO items (also those without a date) are also listed at
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1429 the beginning of the buffer, before the first date.@*
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1430 The key binding @kbd{C-c a} is only a suggestion - see
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1431 @ref{Installation and Activation}.
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1432 @end table
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1433
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1434 The commands available in the Agenda buffer are listed in
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1435 @ref{Agenda commands}.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1436
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1437 @subsection Categories
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1438
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1439 @cindex category
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1440 In the agenda buffer, each entry is preceded by a @emph{category},
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1441 which is derived from the file name. The category can also be set
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1442 with a special line anywhere in the buffer, looking like this:
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1443 @example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1444 #+CATEGORY: Cheops
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1445 @end example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1446 @noindent
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1447 After changing this line, press @kbd{C-c C-c} with the cursor still in
61923
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1448 the line, to make the changes known to org-mode. Otherwise, the
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1449 change will only be active the next time you visit this file with
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1450 Emacs.
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1451
61923
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
1452 The display in the agenda buffer looks best if the category is not
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1453 longer than 10 characters.
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1454
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1455 @subsection Sorting of agenda items
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1456 @cindex sorting, of agenda items
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1457 @cindex priorities, of agenda items
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1458 The entries for each day are sorted. The default order is to first
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1459 collect all items containing an explicit time-of-day specification.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1460 These entries will be shown at the beginning of the list, as a
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1461 @emph{schedule} for the day. After that, items remain grouped in
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1462 categories, in the sequence given by @code{org-agenda-files}. Within
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1463 each category, items are sorted by priority (@pxref{Priorities}).
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1464
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1465 A time-of-day specification looks like @samp{12:45} or @samp{3pm} and
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1466 must appear in the headline. For example, a timestamp in a headline
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1467 that contains not only a date but also a time will trigger this
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1468 mechanism. Specifications of a time in diary entries are recognized
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1469 as well, so the schedule will be mixed from diary entries and Org-mode
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1470 files.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1471
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1472 The priority is a numerical quantity composed of the base priority
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1473 (2000 for priority @samp{A}, 1000 for @samp{B}, and 0 for @samp{C}),
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1474 plus additional increments for overdue scheduled or deadline items.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1475
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1476 Sorting can be customized using the variable
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1477 @code{org-agenda-sorting-strategy}.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1478
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1479 @node Agenda commands, Calendar/Diary integration, Agenda, Timeline and Agenda
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1480 @section Commands in the agenda buffer
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1481
61136
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1482 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
1483 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
1484 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
1485 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
1486 the agenda buffer. In this way, all information is stored only once,
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1487 and you don't risk that your agenda and note files diverge.
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1488
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1489 Some commands can be executed with mouse clicks on agenda lines. For
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1490 the other commands, the cursor needs to be in the desired line. Most
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1491 commands are available for both timelines and the agenda. The
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1492 exceptions are marked.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1493
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1494 @table @kbd
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1495 @tsubheading{Motion}
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1496 @kindex n
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1497 @item n
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1498 Next line (same as @key{up}).
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1499 @kindex p
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1500 @item p
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1501 Previous line (same as @key{down}).
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1502 @tsubheading{View/GoTo org file}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1503 @kindex mouse-3
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1504 @kindex @key{SPC}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1505 @item mouse-3
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1506 @itemx @key{SPC}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1507 Display the original location of the item in another window.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1508
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1509 @kindex l
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1510 @item l
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1511 Display original location and recenter that window.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1512
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1513 @kindex mouse-2
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1514 @kindex @key{TAB}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1515 @item mouse-2
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1516 @itemx @key{TAB}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1517 Go to the original location of the item in another window.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1518
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1519 @kindex @key{RET}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1520 @itemx @key{RET}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1521 Go to the original location of the item and delete other windows.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1522
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1523 @kindex f
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1524 @item f
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1525 Toggle follow mode. In follow mode, as you move the cursor through
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1526 the agenda buffer, the other window always shows the corresponding
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1527 location in the org file.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1528
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1529 @tsubheading{Change display}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1530 @kindex o
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1531 @item o
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1532 Delete other windows.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1533
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1534 @kindex w
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1535 @item w
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1536 Toggle between weekly and daily view.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1537
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1538 @kindex d
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1539 @item d
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1540 Toggle the inclusion of diary entries. See @ref{Calendar/Diary integration}.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1541
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1542 @kindex r
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1543 @item r
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1544 Recreate the agenda buffer, for example to reflect the changes
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1545 after modification of the time stamps of items with S-@key{left} and
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1546 S-@key{right}.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1547
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1548 @kindex @key{right}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1549 @item @key{right}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1550 Display the following @code{org-agenda-ndays} days. For example, if
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1551 the display covers a week, switch to the following week. With prefix
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1552 arg, go forward that many times @code{org-agenda-ndays} days. Not
61136
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1553 available in timelines.
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1554
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1555 @kindex @key{left}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1556 @item @key{left}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1557 Display the previous dates. Not available in timelines.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1558
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1559 @kindex .
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1560 @item .
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1561 Goto today.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1562
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1563 @tsubheading{Remote editing}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1564
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1565 @item 0-9
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1566 Digit argument.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1567
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1568 @kindex t
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1569 @item t
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1570 Change the TODO state of the item, both in the agenda and in the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1571 original org file.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1572
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1573 @kindex ,
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1574 @item ,
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1575 Set the priority for the current item. Org-mode prompts for the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1576 priority character. If you reply with @key{SPC}, the priority cookie
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1577 is removed from the entry.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1578
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1579 @kindex P
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1580 @item p
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1581 Display weighted priority of current item.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1582
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1583 @kindex +
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1584 @kindex S-@key{up}
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1585 @item +
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1586 @item S-@key{up}
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1587 Increase the priority of the current item. The priority is changed in
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1588 the original buffer, but the agenda is not resorted. Use the @kbd{r}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1589 key for this.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1590
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1591 @kindex -
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1592 @kindex S-@key{down}
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1593 @item -
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1594 @item S-@key{down}
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1595 Decrease the priority of the current item.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1596
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1597 @kindex S-@key{right}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1598 @item S-@key{right}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1599 Change the time stamp associated with the current line by one day into
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1600 the future. With prefix argument, change it by that many days. For
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1601 example, @kbd{3 6 5 S-@key{right}} will change it by a year. The
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1602 stamp is changed in the original org file, but the change is not
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1603 directly reflected in the agenda buffer. Use the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1604 @kbd{r} key to update the buffer.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1605
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1606 @kindex S-@key{left}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1607 @item S-@key{left}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1608 Change the time stamp associated with the current line by one day
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1609 into the past.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1610
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1611 @kindex >
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1612 @item >
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1613 Change the time stamp associated with the current line to today.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1614 The key @kbd{>} has been chosen, because it is the same as @kbd{S-.}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1615 on my keyboard.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1616
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1617 @cindex diary entries, creating from agenda
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1618 @kindex i
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1619 @item i
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1620 Insert a new entry into the diary. Prompts for the type of entry
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1621 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1622 entry in the diary, just like @kbd{i d} etc. would do in the calendar.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1623 The date is taken from the cursor position.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1624
61136
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1625 @tsubheading{Calendar commands}
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1626 @kindex c
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1627 @item c
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1628 Open the Emacs calendar and move to the date at the agenda cursor.
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1629
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1630 @item c
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1631 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
1632 date at the cursor.
61136
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1633
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1634 @kindex M
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1635 @item M
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1636 Show the phases of the moon for three month around current date.
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1637
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1638 @kindex S
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1639 @item S
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1640 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
1641 with calendar variables, see documentation of the Emacs calendar.
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1642
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1643 @kindex C
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1644 @item C
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1645 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
1646 calendars.
61136
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1647
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1648 @kindex H
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1649 @item H
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1650 Show holidays for three month around the cursor date.
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1651
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1652 @tsubheading{Quit and Exit}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1653 @kindex q
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1654 @item q
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1655 Quit Agenda, remove the agenda buffer.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1656
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1657 @kindex x
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1658 @cindex agenda files, removing buffers
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1659 @item x
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1660 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1661 for the compilation of the agenda. Buffers created by the user to
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1662 visit org files will not be removed.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1663
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1664 @end table
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1665
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1666 @node Calendar/Diary integration, , Agenda commands, Timeline and Agenda
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1667 @section Calendar/Diary integration
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1668 @cindex calendar integration
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1669 @cindex diary integration
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1670
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1671 Emacs contains the calendar and diary by Edward M. Reingold. The
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1672 calendar displays a three-month calendar with holidays from different
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1673 countries and cultures. The diary allows to keep track of
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1674 anniversaries, lunar phases, sunrise/set, recurrent appointments
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1675 (weekly, monthly) and more. In this way, it is quite complementary to
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1676 Org-mode. It can be very useful to combine output from Org-mode with
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1677 the diary.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1678
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1679 The interaction between Org-mode and diary works both ways: You can
61136
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1680 list entries from the diary in the Org-mode agenda, from which many
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1681 calendar and diary commands are directly accessible. Or you can
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1682 display entries from the org agenda in the Emacs diary.
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1683
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1684 @menu
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1685 * Diary to agenda:: Agenda incorporates the diary
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1686 * Agenda to diary:: Diary incorporates the agenda
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1687 @end menu
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1688
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1689 @node Diary to agenda, Agenda to diary, Calendar/Diary integration, Calendar/Diary integration
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1690 @subsection Including the diary into the agenda
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1691 @cindex diary to agenda
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1692
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1693 In order to include entries from the Emacs diary into Org-mode's
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1694 agenda, you only need to customize the variable
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1695
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1696 @lisp
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1697 (setq org-agenda-include-diary t)
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1698 @end lisp
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1699 @noindent
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1700
61136
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1701 @noindent After that, everything will happen automatically. All diary
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1702 entries including holidays, anniversaries etc will be included in the
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1703 agenda buffer created by Org-mode. @key{SPC}, @key{TAB}, and
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1704 @key{RET} can be used from the agenda buffer to jump to the diary
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1705 file, in order to edit existing diary entries. Also the @kbd{i}
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1706 command to insert new entries for the current date works in the agenda
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1707 buffer, as well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to
003dd96023ff updated to org-mode version 3.05
Carsten Dominik <dominik@science.uva.nl>
parents: 59542
diff changeset
1708 display Sunrise/Sunset times, show lunar phases and to convert to
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1709 other calendars, respectively. @kbd{c} can be used to switch back and
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1710 forth between calendar and agenda.
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1711
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1712 @node Agenda to diary, , Diary to agenda, Calendar/Diary integration
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1713 @subsection Including the agenda into the diary
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1714
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1715 If you prefer to use the Emacs diary as your main instrument and if
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1716 you wish to include the Org-mode agenda into it, the following steps
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1717 are necessary: Autoload the function @command{org-diary} as shown
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1718 above under @ref{Installation and Activation}. You also need to use
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
1719 @emph{fancy diary display} by setting in @file{.emacs}:
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1720
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1721 @lisp
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1722 (add-hook 'diary-display-hook 'fancy-diary-display)
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1723 @end lisp
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1724
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1725 Then include the following line into your @file{~/diary} file, in
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1726 order to get the entries from all files listed in the variable
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1727 @code{org-agenda-files}:
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1728
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1729 @example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1730 &%%(org-diary)
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1731 @end example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1732 @noindent
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1733 You may also select specific files with
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1734
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1735 @example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1736 &%%(org-diary) ~/path/to/some/org-file.org
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1737 &%%(org-diary) ~/path/to/another/org-file.org
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1738 @end example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1739
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1740 If you now launch the calendar and press @kbd{d} to display a diary,
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1741 the headlines of entries containing a timestamp, date range, schedule,
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1742 or deadline referring to the selected date will be listed. Just like
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1743 in Org-mode's agenda view, the diary for @emph{today} contains
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1744 additional entries for overdue deadlines and scheduled items. See
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1745 also the documentation of the @command{org-diary} function.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1746
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1747 @node Exporting, Miscellaneous, Timeline and Agenda, Top
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1748 @chapter Exporting
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1749 @cindex exporting
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1750 @cindex ASCII file
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1751 @cindex HTML
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1752
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1753
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1754 @cindex headline levels, for exporting
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1755 For printing and sharing of notes, an Org-mode document can be
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1756 exported as an ASCII file, or as HTML. In the exported version, the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1757 first 3 outline levels will become headlines, defining a general
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1758 document structure. Additional levels will be exported as itemize
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1759 lists. If you want that transition to occur at a different level,
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1760 specify it with a prefix argument. For example,
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1761
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1762 @example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1763 @kbd{M-1 M-x org-export-as-html}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1764 @end example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1765 @noindent
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1766 creates only top level headlines and does the rest as items.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1767
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1768 @menu
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1769 * Export commands:: Commands which export and display
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1770 * HTML formatting:: Interpretation of the buffer content
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1771 * Export options:: How to influence exports
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1772 * Comment lines:: Lines which will not be exported
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1773 @end menu
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1774
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1775 @node Export commands, HTML formatting, Exporting, Exporting
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1776 @section Export commands
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1777
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1778 @cindex region, active
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1779 @cindex active region
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1780 @cindex transient-mark-mode
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1781 @table @kbd
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1782 @kindex C-c C-x a
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1783 @item C-c C-x a
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1784 Export as ASCII file. If there is an active region, only the region
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1785 will be exported. For an org file @file{myfile.org}, the ASCII file
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1786 will be @file{myfile.txt}. The file will be overwritten without
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1787 warning.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1788 @kindex C-c C-x h
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1789 @item C-c C-x h
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1790 Export as HTML file @file{myfile.html}.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1791 @kindex C-c C-x C-h
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1792 @item C-c C-x C-h
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1793 Export as HTML file and open it with a browser.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1794 @kindex C-c C-x t
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1795 @item C-c C-x t
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1796 Insert template with export options, see below.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1797 @kindex C-c :
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1798 @item C-c :
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1799 Toggle fixed-width for line or region, see below.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1800 @end table
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1801
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1802 @node HTML formatting, Export options, Export commands, Exporting
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1803 @section HTML formatting
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1804
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1805 Not all text is transferred literally to the exported HTML file. The
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1806 exporter implements the following interpretation:
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1807
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1808 @itemize @bullet
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1809 @cindex underlined text
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1810 @cindex bold text
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1811 @cindex italic text
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1812 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1813 You can make words @b{*bold*}, @i{/italic/}, and _underlined_
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1814
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1815 @cindex @TeX{} interpretation
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1816 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1817 Simple @TeX{}-like math constructs are interpreted:
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1818
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1819 @itemize @minus
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1820 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1821 @samp{10^22} and @samp{J_n} are super- and subscripts. You can quote
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1822 @samp{^} and @samp{_} with a backslash: @samp{\_} and @samp{\^}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1823 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1824 @samp{\alpha} indicates a Greek letter, @samp{\to} an arrow. You can
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1825 use completion for these macros, just type @samp{\} and maybe a few
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1826 letters, and press @kbd{M-@key{TAB}} to see possible completions.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1827 @end itemize
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1828
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1829 @cindex tables, export to HTML
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1830 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1831 Tables are transformed into HTML tables.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1832
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1833 @cindex fixed width
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1834 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1835 Lines starting with @samp{:} are typeset in a fixed-width font, to
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1836 allow quoting of computer code etc.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1837
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1838 @cindex HTML tags
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1839 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1840 If you want to include HTML tags which should be interpreted as such,
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1841 mark them with a @samp{@@} like in @samp{@@<b>bold text@@</b>}.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1842 Plain @samp{<} and @samp{>} are always transformed to @samp{&lt;} and
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1843 @samp{&gt;} in HTML export.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1844 @end itemize
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1845
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1846 If these conversions conflict with your habits of typing ASCII text,
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1847 they can all be turned off with corresponding variables.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1848
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1849 @node Export options, Comment lines, HTML formatting, Exporting
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1850 @section Export options
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1851 @cindex options, for export
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1852
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1853 The exporter recognizes special lines in the buffer which provide
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1854 additional information. These lines may be put anywhere in the file.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1855 The whole set of lines can be inserted into the buffer with @kbd{C-c
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1856 C-x t}. For individual lines, a good way to make sure the keyword is
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1857 correct it to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1858 (@pxref{Completion}).
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1859
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1860 @example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1861 #+TITLE: the title to be shown (default is the buffer name)
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1862 #+AUTHOR: the author (default taken from @code{user-full-name})
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1863 #+EMAIL: his/her email address (default from @code{user-mail-address})
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1864 #+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language})
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1865 #+TEXT: Some descriptive text to be inserted at the beginning.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1866 #+TEXT: Several lines may be given.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1867 #+OPTIONS: H:2 num:t toc:t \n:nil @:t ::t |:t ^:t *:nil TeX:t
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1868 @end example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1869 @noindent
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1870 The OPTIONS line is a compact form to specify export settings. Here
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1871 you can
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1872 @cindex headline levels
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1873 @cindex section-numbers
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1874 @cindex table of contents
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1875 @cindex linebreak-preservation
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1876 @cindex quoted html tags
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1877 @cindex fixed-width sections
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1878 @cindex tables
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1879 @cindex @TeX{}-like syntax for sub- and superscripts
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1880 @cindex emphasized text
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1881 @cindex @TeX{} macros
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1882 @example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1883 H: @r{set the number of headline levels for export}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1884 num: @r{turn on/off section-numbers}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1885 toc: @r{turn on/off table of contents}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1886 \n: @r{turn on/off linebreak-preservation}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1887 @@: @r{turn on/off quoted html tags}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1888 :: @r{turn on/off fixed-width sections}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1889 |: @r{turn on/off tables}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1890 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts.}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1891 *: @r{turn on/off emphasized text (bold, italic, underlined)}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1892 TeX: @r{turn on/off @TeX{} macros}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1893 @end example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1894
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1895 @node Comment lines, , Export options, Exporting
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1896 @section Comment lines
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1897 @cindex comment lines
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1898 @cindex exporting, not
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1899
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1900 Lines starting with @samp{#} in column zero are treated as comments
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1901 and will never be exported. Also entire subtrees starting with the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1902 word @samp{COMMENT} will never be exported. Finally, any text before
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1903 the first headline will not be exported either.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1904
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1905 @table @kbd
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1906 @kindex C-c ;
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1907 @item C-c ;
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1908 Toggle the COMMENT keyword at the beginning of an entry.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1909 @end table
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1910
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1911 @node Miscellaneous, Index, Exporting, Top
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1912 @chapter Miscellaneous
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1913
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1914 @menu
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1915 * Completion:: M-TAB knows what you need
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1916 * Customization:: Adapting Org-mode to your taste
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1917 * Tips and Tricks:: An author-imposed FAQ, sort of
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1918 * Interaction:: Other Emacs packages
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1919 * Acknowledgments:: These people provided feedback and more
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1920 * Bugs:: Things which do not work perfectly
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1921 @end menu
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1922
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1923 @node Completion, Customization, Miscellaneous, Miscellaneous
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1924 @section Completion
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1925 @cindex complete @TeX{} symbols
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1926 @cindex complete TODO keywords
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1927 @cindex complete dictionary words
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1928 @cindex complete option keywords
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1929
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1930 Org-mode supports in-buffer completion. This type of completion does
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1931 not make use of the minibuffer. You simply type a few letters into
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1932 the buffer and use the key to complete text right there.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1933
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1934 @table @kbd
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1935 @kindex M-@key{TAB}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1936 @item M-@key{TAB}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1937 Complete word at point
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1938 @itemize @bullet
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1939 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1940 At the beginning of a headline, complete TODO keywords.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1941 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1942 After @samp{\}, complete @TeX{} symbols supported by the exporter.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1943 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1944 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1945 @samp{OPTIONS} which set file-specific options for Org-mode. When the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1946 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1947 will insert example settings for this keyword.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1948 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1949 Elsewhere, complete dictionary words using ispell.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1950 @end itemize
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1951 @end table
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1952
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1953 @node Customization, Tips and Tricks, Completion, Miscellaneous
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1954 @section Customization
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1955 @cindex customization
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1956 @cindex options, for customization
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1957 @cindex variables, for customization
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1958
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1959 There is a large number of variables which can be used to customize
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1960 Org-mode. For the sake of compactness of the manual, we are not
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1961 describing the variables here. For an overview of customization
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1962 variables, use @kbd{M-x org-customize}. Or select @code{Browse Org
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1963 Group} from the @code{Org->Customization} menu.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1964
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1965 @node Tips and Tricks, Interaction, Customization, Miscellaneous
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1966 @section Tips and Tricks
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1967
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1968 @itemize @bullet
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1969 @cindex README files
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1970 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1971 I find Org-mode very useful for the many @file{README} files I have
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1972 scattered through my directories. So I turn on @file{org-mode} for
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1973 all @file{README} files with
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1974
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1975 @example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1976 (add-to-list 'auto-mode-alist '("README$" . org-mode))
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1977 @end example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1978
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1979 @ignore
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1980 @cindex files, adding automatically
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1981 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1982 If you would like to add all org files you ever create to the list of
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1983 agenda files@footnote{Think twice. Do you @emph{really} want this?},
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1984 you could do so with
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1985
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1986 @lisp
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1987 (add-hook 'org-mode-hook 'org-add-file)
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1988 @end lisp
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1989
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1990 If you would like to add only a selection, for example everything
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1991 except the @file{README} files, this could be achieved in the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1992 following way:
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1993
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1994 @lisp
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1995 (add-hook 'org-mode-hook
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1996 (lambda ()
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1997 (or (string-match "README\\'" (buffer-file-name))
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1998 (org-add-file))))
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1999 @end lisp
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2000 @end ignore
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2001
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2002 @cindex @code{make-indirect-buffer}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2003 @cindex indirect buffers
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2004 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2005 It can be useful to have two different windows showing the same
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2006 Org-mode file. However, a problem here is that changes to the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2007 visibility in one window immediately affect the other window. On
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2008 Emacs (not on XEmacs because it uses the old outline-mode) a way out
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2009 is the use of @emph{indirect buffers}, which visit the same file, but
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2010 have separate settings, also for outline visibility. See the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2011 documentation on the command @code{make-indirect-buffer}.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2012
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2013 @cindex URL, paste into buffer
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2014 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2015 Paste URLs into Org-mode whenever this seems useful. For example, if
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2016 you are writing notes about a paper which is available on the web, put
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2017 the corresponding URL there and a direct look at the paper is only a
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2018 mouse click away. If you have a local copy of the paper, use a
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2019 file:path link.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2020
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2021 @cindex headline levels, for export
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2022 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2023 If you plan to use ASCII or HTML export, make sure things you want to
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2024 be exported as item lists are level 4 at least, even if that does mean
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2025 there is a level jump. For example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2026
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2027 @example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2028 * Todays top priorities
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2029 **** TODO write a letter to xyz
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2030 **** TODO Finish the paper
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2031 **** Pick up kids at the school
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2032 @end example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2033
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2034 Alternatively, if you need a specific value for the heading/item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2035 transition in a particular file, use the @samp{+OPTIONS} line to
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2036 configure the @samp{H} switch.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2037
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2038 @example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2039 +OPTIONS: H:2; ...
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2040 @end example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2041
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2042 @cindex exporting a subtree
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2043 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2044 If you want to export a subtree, mark the subtree as region and then
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2045 export. Marking can be done with @kbd{C-c @@ C-x C-x}, for example.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2046
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2047 @cindex table, empty template
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2048 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2049 To insert an empty table template, just type @samp{|-} and use
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2050 @key{TAB}.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2051
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2052 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2053 In a table, to add a new column at the end, just type some text
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2054 anywhere after the final @samp{|}. Upon the next re-align, a new
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2055 column will be created.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2056
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2057 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2058 In tables, @key{TAB} creates new rows before horizontal separator lines. If
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2059 the cursor is at @samp{Age} in the following table,
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2060
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2061 @example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2062 | Name | Phone | Age |
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2063 |-------+-------+-----|
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2064 | | | |
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2065 @end example
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2066
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2067 the next @key{TAB} would create a second header line. If you want
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2068 instead to go to the first empty field below the horizontal line,
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2069 press @key{down} (to get on the separator line) and then @key{TAB}.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2070
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2071 @cindex indentation, of tables
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2072 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2073 To change the indentation of a table, just change the first line and
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2074 realign with @key{TAB}.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2075
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2076 @end itemize
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2077
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2078
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2079 @node Interaction, Acknowledgments, Tips and Tricks, Miscellaneous
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2080 @section Interaction with other packages
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2081 @cindex packages, interaction with other
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2082 @cindex @file{planner.el}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2083 @cindex @file{remember.el}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2084 @cindex @file{table.el}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2085 @file{Org.el} can cooperate with the following packages:
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2086
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2087 @table @asis
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2088 @cindex @file{remember.el}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2089 @item @file{remember.el} by John Wiegley
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2090 Org mode cooperates with remember, see @ref{Remember}.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2091 @cindex @file{plannner.el}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2092 @item @file{planner.el} by John Wiegley
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2093 Planner is another tool to plan work and keep track of tasks. Planner
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2094 uses a multi-file approach with project pages and day pages. Is based
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2095 on Emacs-Wiki. It can be useful to display the agenda entries
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2096 resulting from org files in day-pages of the planner. This can be
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2097 done through the diary of the calendar: Integrate org files into the
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2098 diary as described above, and then turn on the diary support of
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2099 planner.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2100 @cindex @file{table.el}
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2101 @item @file{table.el} by Takaaki Ota
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2102 Org mode cooperates with table.el, see @ref{table.el}.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2103 @end table
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2104
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2105 @page @c FIXME
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2106
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2107 @node Acknowledgments, Bugs, Interaction, Miscellaneous
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2108 @section Acknowledgments
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2109 @cindex acknowledgments
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2110
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2111 Org-mode was written by Carsten Dominik, who still maintains it at the
61923
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
2112 Org-mode homepage @uref{http://www.astro.uva.nl/~dominik/Tools/org/}.
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
2113 The following people have helped the development along with ideas,
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
2114 suggestions and patches.
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2115
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2116 @itemize @bullet
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2117 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2118 Matthias Rempe (Oelde) provided ideas and suggestions, a patch
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2119 introducing Windows NT/2000 support, and quality control.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2120 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2121 Kevin Rogers contributed code to access VM files on remote hosts.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2122 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2123 Juergen Vollmer contributed code generating the table of contents
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2124 in HTML output, and other export improvements.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2125 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2126 Christian Egli converted the documentation into TeXInfo format. He
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2127 also showed me his plans for a multifile summary for Org-mode. Some of
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2128 his ideas have found their way into the agenda.
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
2129 @item
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
2130 Philip Rooke created the Org-mode reference card. He also helped with
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
2131 beta testing and contributed a number of very useful ideas.
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2132 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2133 Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2134 @file{organizer-mode.el}.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2135 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2136 Scheduling TODO items was inspired by John Wiegley's @file{planner.el}.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2137 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2138 Sacha Chua, the current maintainer of Planner suggested to take some
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2139 linking code from Planner, which I did (for RMAIL and Wanderlust).
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2140 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2141 Oliver Oppitz sent several useful suggestions.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2142 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2143 Carsten Wimmer suggested some changes and helped fix a bug in linking
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2144 to GNUS.
61923
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
2145 @item
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
2146 Stefan Monnier provided a patch with lots of little fixes to keep the
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
2147 Emacs-Lisp compiler happy.
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2148 @end itemize
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2149
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2150 @node Bugs, , Acknowledgments, Miscellaneous
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2151 @section Bugs
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2152 @cindex bugs
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2153
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2154 Here is a list of things which should work differently, but which I
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2155 have found too hard to fix.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2156
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2157 @itemize @bullet
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2158 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2159 When the application called by @kbd{C-c C-o} to open a file link fails
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2160 (for example because the application does not exits or refuses to open
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2161 the file), it does so silently. No error message is displayed.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2162 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2163 Under XEmacs, if Org-mode entries are included into the diary, it is
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2164 not possible to jump back from the diary to the org file. Apparently,
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2165 the text properties are lost when the fancy-diary-display is used.
61562
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
2166 However, from Org-mode's timeline and agenda buffers (created with
6cd3b18f298e Update to version 3.06
Carsten Dominik <dominik@science.uva.nl>
parents: 61136
diff changeset
2167 @kbd{C-c C-r} and @kbd{C-c a}), things do work correctly.
58792
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2168 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2169 Linux should also have a default viewer application, using mailcap.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2170 Maybe we can use GNUS or VM mime code? Or dired's guessing commands?
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2171 Any hints (or even patches) are appreciated.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2172 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2173 When you write @samp{x = a /b/ c}, b will be exported in italics.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2174 @item
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2175 The exporters work well, but could be made more efficient.
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2176 @end itemize
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2177
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2178 @node Index, Key Index, Miscellaneous, Top
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2179 @chapter Index
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2180
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2181 @printindex cp
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2182
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2183 @node Key Index, , Index, Top
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2184 @chapter Key Index
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2185
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2186 @printindex ky
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2187
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2188 @bye
265139cbc47c New file.
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2189
61923
88492f3ccffa *** empty log message ***
Carsten Dominik <dominik@science.uva.nl>
parents: 61562
diff changeset
2190
58833
d97ebd9e30f6 Changes from arch/CVS synchronization
Miles Bader <miles@gnu.org>
parents: 58792
diff changeset
2191 @ignore
d97ebd9e30f6 Changes from arch/CVS synchronization
Miles Bader <miles@gnu.org>
parents: 58792
diff changeset
2192 arch-tag: 7893d1fe-cc57-4d13-b5e5-f494a1bcc7ac
d97ebd9e30f6 Changes from arch/CVS synchronization
Miles Bader <miles@gnu.org>
parents: 58792
diff changeset
2193 @end ignore