annotate man/org.texi @ 61098:e7392bee6373

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