annotate man/org.texi @ 61490:e51a703b6762

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