1 |
\input texinfo |
\input texinfo |
2 |
@c %**start of header |
@c %**start of header |
3 |
|
@c @setfilename org |
4 |
@setfilename ../info/org |
@setfilename ../info/org |
5 |
@settitle Org Mode Manual |
@settitle Org Mode Manual |
6 |
|
|
7 |
@set VERSION 3.06 |
@set VERSION 3.08 |
8 |
@set DATE April 2005 |
@set DATE April 2005 |
9 |
|
|
10 |
@dircategory Emacs |
@dircategory Emacs |
77 |
@menu |
@menu |
78 |
* Introduction:: Getting started |
* Introduction:: Getting started |
79 |
* Document Structure:: A tree works like your brain |
* Document Structure:: A tree works like your brain |
|
* TODO items:: Every tree branch can be a TODO item |
|
80 |
* Tables:: Pure magic for quick formatting |
* Tables:: Pure magic for quick formatting |
81 |
* Hyperlinks:: Notes in context |
* Hyperlinks:: Notes in context |
82 |
|
* TODO items:: Every tree branch can be a TODO item |
83 |
* Timestamps:: Assign date and time to items |
* Timestamps:: Assign date and time to items |
84 |
* Timeline and Agenda:: Use time-stamped items to produce an agenda |
* Timeline and Agenda:: Use time-stamped items to produce an agenda |
85 |
* Exporting:: Sharing and publishing of notes |
* Exporting:: Sharing and publishing of notes |
94 |
|
|
95 |
* Summary:: Brief summary of what Org-mode does |
* Summary:: Brief summary of what Org-mode does |
96 |
* Installation and Activation:: How to install Org-mode |
* Installation and Activation:: How to install Org-mode |
97 |
|
* Feedback:: Bug reportes, ideas, patches etc. |
98 |
|
|
99 |
Document Structure |
Document Structure |
100 |
|
|
105 |
* Structure editing:: Changing sequence and level of headlines |
* Structure editing:: Changing sequence and level of headlines |
106 |
* Sparse trees:: Matches embedded in context |
* Sparse trees:: Matches embedded in context |
107 |
|
|
108 |
|
Tables |
109 |
|
|
110 |
|
* Built-in table editor:: Simple tables |
111 |
|
* table.el:: Complex tables |
112 |
|
* orgtbl-mode:: The table editor as minor mode |
113 |
|
|
114 |
|
Hyperlinks |
115 |
|
|
116 |
|
* Links:: URL-like links to the world |
117 |
|
* Remember:: Org-trees store quick notes |
118 |
|
|
119 |
TODO items |
TODO items |
120 |
|
|
121 |
* TODO basics:: Marking and displaying TODO entries |
* TODO basics:: Marking and displaying TODO entries |
128 |
* TODO types:: I do this, Fred the rest |
* TODO types:: I do this, Fred the rest |
129 |
* Per file keywords:: Different files, different requirements |
* Per file keywords:: Different files, different requirements |
130 |
|
|
|
Tables |
|
|
|
|
|
* Built-in table editor:: Simple tables |
|
|
* table.el:: Complex tables |
|
|
* orgtbl-mode:: The table editor as minor mode |
|
|
|
|
|
Hyperlinks |
|
|
|
|
|
* Links:: URL-like links to the world |
|
|
* Remember:: Org-trees store quick notes |
|
|
|
|
131 |
Timestamps |
Timestamps |
132 |
|
|
133 |
* Time stamps:: Assigning a time to a tree entry |
* Time stamps:: Assigning a time to a tree entry |
171 |
@menu |
@menu |
172 |
* Summary:: Brief summary of what Org-mode does |
* Summary:: Brief summary of what Org-mode does |
173 |
* Installation and Activation:: How to install Org-mode |
* Installation and Activation:: How to install Org-mode |
174 |
|
* Feedback:: Bug reportes, ideas, patches etc. |
175 |
@end menu |
@end menu |
176 |
|
|
177 |
@node Summary, Installation and Activation, Introduction, Introduction |
@node Summary, Installation and Activation, Introduction, Introduction |
217 |
|
|
218 |
@page |
@page |
219 |
|
|
220 |
@node Installation and Activation, , Summary, Introduction |
@node Installation and Activation, Feedback, Summary, Introduction |
221 |
@section Installation and Activation |
@section Installation and Activation |
222 |
@cindex installation |
@cindex installation |
223 |
@cindex autoload |
@cindex autoload |
266 |
the file's name is. See also the variable |
the file's name is. See also the variable |
267 |
@code{org-insert-mode-line-in-empty-file'}. |
@code{org-insert-mode-line-in-empty-file'}. |
268 |
|
|
269 |
@node Document Structure, TODO items, Introduction, Top |
@node Feedback, , Installation and Activation, Introduction |
270 |
|
@section Feedback |
271 |
|
@cindex feedback |
272 |
|
@cindex bug reports |
273 |
|
@cindex maintainer |
274 |
|
@cindex author |
275 |
|
|
276 |
|
If you find problems with Org-mode, or if you have questions, remarks, |
277 |
|
or ideas about it, please contact the maintainer Carsten Dominik at |
278 |
|
@value{MAINTAINEREMAIL}. |
279 |
|
|
280 |
|
For bug reports, please provide as much information as possible, |
281 |
|
including the version information of Emacs (@kbd{C-h v emacs-version |
282 |
|
@key{RET}}) and Org-mode (@kbd{M-x org-version}), as well as the |
283 |
|
Org-mode related setup in @file{.emacs}. If an error occurs, a |
284 |
|
traceback can be very useful. Often a small example file helps, along |
285 |
|
with clear information about: |
286 |
|
@enumerate |
287 |
|
@item What exactly did you do? |
288 |
|
@item What did you expect to happen? |
289 |
|
@item What happened instead? |
290 |
|
@end enumerate |
291 |
|
@noindent Thanks for helping to improve this mode. |
292 |
|
|
293 |
|
|
294 |
|
@node Document Structure, Tables, Introduction, Top |
295 |
@chapter Document Structure |
@chapter Document Structure |
296 |
@cindex document structure |
@cindex document structure |
297 |
@cindex structure of document |
@cindex structure of document |
531 |
the document to another file (extension @file{.txt}) which then can be |
the document to another file (extension @file{.txt}) which then can be |
532 |
printed in any desired way. |
printed in any desired way. |
533 |
|
|
534 |
@node TODO items, Tables, Document Structure, Top |
@node Tables, Hyperlinks, Document Structure, Top |
|
@chapter TODO items |
|
|
@cindex TODO items |
|
|
|
|
|
Org-mode does not maintain TODO lists as a separate document. TODO |
|
|
items are an integral part of the notes file, because TODO items |
|
|
usually come up while taking notes! With Org-mode, you simply mark |
|
|
any entry in a tree as being a TODO item. In this way, the |
|
|
information is not duplicated, and the entire context from which the |
|
|
item emerged is always present when you check. |
|
|
|
|
|
Of course, this technique causes TODO items to be scattered throughout |
|
|
your file. Org-mode provides methods to give you an overview over all |
|
|
things you have to do. |
|
|
|
|
|
@menu |
|
|
* TODO basics:: Marking and displaying TODO entries |
|
|
* TODO extensions:: Workflow and assignments |
|
|
* Priorities:: Some things are more important than others |
|
|
@end menu |
|
|
|
|
|
@node TODO basics, TODO extensions, TODO items, TODO items |
|
|
@section Basic TODO functionality |
|
|
|
|
|
Any headline can become a TODO item by starting it with the word TODO, |
|
|
for example |
|
|
|
|
|
@example |
|
|
*** TODO Write letter to Sam Fortune |
|
|
@end example |
|
|
|
|
|
@noindent |
|
|
The most important commands to work with TODO entries are: |
|
|
|
|
|
@table @kbd |
|
|
@kindex C-c C-t |
|
|
@item C-c C-t |
|
|
Rotate the TODO state of the current item between |
|
|
@example |
|
|
,-> (unmarked) -> TODO -> DONE --. |
|
|
'--------------------------------' |
|
|
@end example |
|
|
The same rotation can also be done ``remotely'' from the timeline and |
|
|
agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}). |
|
|
@kindex C-c C-v |
|
|
@cindex sparse tree, for TODO |
|
|
@item C-c C-v |
|
|
View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds |
|
|
the entire buffer, but shows all TODO items and the headings hierarchy |
|
|
above them. With prefix arg, show also the DONE entries. |
|
|
@item C-u C-c a |
|
|
A @kbd{C-u} argument to the @code{org-agenda command} (@pxref{Agenda}) |
|
|
collects all unfinished TODO items into a single place. |
|
|
@end table |
|
|
|
|
|
@node TODO extensions, Priorities, TODO basics, TODO items |
|
|
@section Extended use of TODO keywords |
|
|
@cindex extended TODO keywords |
|
|
|
|
|
The default implementation of TODO entries is just two states: TODO |
|
|
and DONE. You can, however, use the TODO feature for more |
|
|
complicated things by configuring the variables |
|
|
@code{org-todo-keywords} and @code{org-todo-interpretation}. Using |
|
|
special setup, you can even use TODO keywords in different ways in |
|
|
different org files. |
|
|
|
|
|
@menu |
|
|
* Workflow states:: From TODO to DONE in steps |
|
|
* TODO types:: I do this, Fred the rest |
|
|
* Per file keywords:: Different files, different requirements |
|
|
@end menu |
|
|
|
|
|
@node Workflow states, TODO types, TODO extensions, TODO extensions |
|
|
@subsection TODO keywords as workflow states |
|
|
@cindex TODO workflow |
|
|
@cindex workflow states as TODO keywords |
|
|
|
|
|
You can use TODO keywords to indicate different states in the process |
|
|
of working on an item, for example |
|
|
|
|
|
@lisp |
|
|
(setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE") |
|
|
org-todo-interpretation 'sequence) |
|
|
@end lisp |
|
|
|
|
|
With this setup, the command @kbd{C-c C-t} will cycle an entry from |
|
|
TODO to FEEDBACK, then to VERIFY, and finally too DONE. You may also |
|
|
use a prefix argument to quickly select a specific state. For example |
|
|
@kbd{C-3 C-c C-t} will change the state immediately to VERIFY. |
|
|
If you define many keywords, you can use in-buffer completion (see |
|
|
@ref{Completion}) to insert these words into the buffer. |
|
|
|
|
|
@node TODO types, Per file keywords, Workflow states, TODO extensions |
|
|
@subsection TODO keywords as types |
|
|
@cindex TODO types |
|
|
@cindex names as TODO keywords |
|
|
@cindex types as TODO keywords |
|
|
|
|
|
The second possibility is to use TODO keywords to indicate different |
|
|
types of action items. For example, you might want to indicate that |
|
|
items are for ``work'' or ``home''. Or, when you work with several |
|
|
people on a single project, you might want to assign action items |
|
|
directly to persons, by using their names as TODO keywords. This |
|
|
would be set up like this: |
|
|
|
|
|
@lisp |
|
|
(setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE") |
|
|
org-todo-interpretation 'type) |
|
|
@end lisp |
|
|
|
|
|
In this case, different keywords do not indicate a sequence, but |
|
|
rather different types. So it is normally not useful to change from |
|
|
one type to another. Therefore, in this case the the behavior of the |
|
|
command @kbd{C-c C-t} is changed slightly@footnote{This is also true |
|
|
for the @kbd{t} command in the timeline and agenda buffers}. When |
|
|
used several times in succession, it will still cycle through all |
|
|
names. But when when you return to the item after some time and |
|
|
execute @kbd{C-c C-t} again, it will switch from each name directly to |
|
|
DONE. Use prefix arguments or completion to quickly select a specific |
|
|
name. |
|
|
|
|
|
@node Per file keywords, , TODO types, TODO extensions |
|
|
@subsection Setting up TODO keywords for individual files |
|
|
@cindex keyword options |
|
|
@cindex per file keywords |
|
|
|
|
|
It can be very useful to use different aspects of the TODO mechanism |
|
|
in different files, which is not possible with the global settings |
|
|
described above. For file-local settings, you need to add special |
|
|
lines to the file which set the keywords and interpretation for that |
|
|
file only. For example, to set one of the two examples discussed |
|
|
above, you need one of the following lines, starting in column zero |
|
|
anywhere in the file: |
|
|
|
|
|
@example |
|
|
#+SEQ_TODO: TODO FEEDBACK VERIFY DONE |
|
|
#+TYP_TODO: Fred Sara Lucy Mike DONE |
|
|
@end example |
|
|
|
|
|
@cindex Completing option keywords |
|
|
@kindex M-@key{TAB} |
|
|
@noindent To make sure you are using the correct keyword, type |
|
|
@samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion. |
|
|
|
|
|
@cindex DONE, final TODO keyword |
|
|
Remember that the last keyword must always mean that the item is DONE |
|
|
(you may use a different word, though). Also note that in each file, |
|
|
only one of the two aspects of TODO keywords can be used. After |
|
|
changing one of these lines, use @kbd{C-c C-c} with the cursor still |
|
|
in the line to make the changes known to Org-mode@footnote{Org-mode |
|
|
parses these lines only when Org-mode is activated after visiting a |
|
|
file. @kbd{C-c C-c} with the cursor in a line starting with @samp{#-} |
|
|
is simply restarting Org-mode, making sure that these changes will be |
|
|
respected.}. |
|
|
|
|
|
If you want to use very many keywords, for example when working with a |
|
|
large group of people, you may split the names over several lines: |
|
|
|
|
|
@example |
|
|
#+TYP_TODO: Fred Sara Lucy Mike |
|
|
#+TYP_TODO: Luis George Jules Jessica |
|
|
#+TYP_TODO: Kim Arnold Peter |
|
|
#+TYP_TODO: DONE |
|
|
@end example |
|
|
|
|
|
@node Priorities, , TODO extensions, TODO items |
|
|
@section Priorities |
|
|
@cindex priorities |
|
|
|
|
|
If you use Org-mode extensively to organize your work, you may end up |
|
|
with a number of TODO entries so large that you'd like to prioritize |
|
|
them. This can be done by placing a @emph{priority cookie} into the |
|
|
headline, like this |
|
|
|
|
|
@example |
|
|
*** TODO [#A] Write letter to Sam Fortune |
|
|
@end example |
|
|
|
|
|
@noindent |
|
|
With its standard setup, Org-mode supports priorities @samp{A}, |
|
|
@samp{B}, and @samp{C}. @samp{A} is the highest priority. An entry |
|
|
without a cookie is treated as priority @samp{B}. Priorities make a |
|
|
difference only in the agenda (@pxref{Agenda}). |
|
|
|
|
|
@table @kbd |
|
|
@kindex @kbd{C-c ,} |
|
|
@item @kbd{C-c ,} |
|
|
Set the priority of the current item. The command prompts for a |
|
|
priority character @samp{A}, @samp{B} or @samp{C}. When you press |
|
|
@key{SPC} instead, the priority cookie is removed from the headline. |
|
|
The priorities can also be changed ``remotely'' from the timeline and |
|
|
agenda buffer with the @kbd{,} command (@pxref{Agenda commands}). |
|
|
|
|
|
@kindex S-@key{up} |
|
|
@kindex S-@key{down} |
|
|
@item S-@key{up} |
|
|
@itemx S-@key{down} |
|
|
Increase/decrease priority of current item. Note that these keys are |
|
|
also used to modify time stamps (@pxref{Creating timestamps}). |
|
|
@end table |
|
|
|
|
|
|
|
|
@node Tables, Hyperlinks, TODO items, Top |
|
535 |
@chapter Tables |
@chapter Tables |
536 |
@cindex tables |
@cindex tables |
537 |
|
|
777 |
|
|
778 |
If you like the intuitive way the Org-mode table editor works, you |
If you like the intuitive way the Org-mode table editor works, you |
779 |
might want to use it also in other modes like text-mode or mail-mode. |
might want to use it also in other modes like text-mode or mail-mode. |
780 |
The minor mode Orgtbl-mode make this possible. You can always toggle |
The minor mode Orgtbl-mode makes this possible. You can always toggle |
781 |
the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for |
the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for |
782 |
example in mail mode, use |
example in mail mode, use |
783 |
@lisp |
@lisp |
784 |
(add-hook 'mail-mode-hook 'turn-on-orgtbl) |
(add-hook 'mail-mode-hook 'turn-on-orgtbl) |
785 |
@end lisp |
@end lisp |
786 |
|
|
787 |
@node Hyperlinks, Timestamps, Tables, Top |
@node Hyperlinks, TODO items, Tables, Top |
788 |
@chapter Hyperlinks |
@chapter Hyperlinks |
789 |
@cindex hyperlinks |
@cindex hyperlinks |
790 |
|
|
832 |
@end example |
@end example |
833 |
|
|
834 |
A link may contain space characters and is terminated by the end of |
A link may contain space characters and is terminated by the end of |
835 |
the line. Therefore, there can be only one link per line (but see the |
the line or, in tables, by the end of the table field. Therefore, |
836 |
|
outside of tables there can be only one link per line (but see the |
837 |
variable @code{org-allow-space-in-links}). |
variable @code{org-allow-space-in-links}). |
838 |
|
|
839 |
@cindex storing links |
@cindex storing links |
942 |
non-nil, the entire text is also indented so that it starts in the |
non-nil, the entire text is also indented so that it starts in the |
943 |
same column as the headline (after the asterisks). |
same column as the headline (after the asterisks). |
944 |
|
|
945 |
@node Timestamps, Timeline and Agenda, Hyperlinks, Top |
@node TODO items, Timestamps, Hyperlinks, Top |
946 |
|
@chapter TODO items |
947 |
|
@cindex TODO items |
948 |
|
|
949 |
|
Org-mode does not maintain TODO lists as a separate document. TODO |
950 |
|
items are an integral part of the notes file, because TODO items |
951 |
|
usually come up while taking notes! With Org-mode, you simply mark |
952 |
|
any entry in a tree as being a TODO item. In this way, the |
953 |
|
information is not duplicated, and the entire context from which the |
954 |
|
item emerged is always present when you check. |
955 |
|
|
956 |
|
Of course, this technique causes TODO items to be scattered throughout |
957 |
|
your file. Org-mode provides methods to give you an overview over all |
958 |
|
things you have to do. |
959 |
|
|
960 |
|
@menu |
961 |
|
* TODO basics:: Marking and displaying TODO entries |
962 |
|
* TODO extensions:: Workflow and assignments |
963 |
|
* Priorities:: Some things are more important than others |
964 |
|
@end menu |
965 |
|
|
966 |
|
@node TODO basics, TODO extensions, TODO items, TODO items |
967 |
|
@section Basic TODO functionality |
968 |
|
|
969 |
|
Any headline can become a TODO item by starting it with the word TODO, |
970 |
|
for example |
971 |
|
|
972 |
|
@example |
973 |
|
*** TODO Write letter to Sam Fortune |
974 |
|
@end example |
975 |
|
|
976 |
|
@noindent |
977 |
|
The most important commands to work with TODO entries are: |
978 |
|
|
979 |
|
@table @kbd |
980 |
|
@kindex C-c C-t |
981 |
|
@item C-c C-t |
982 |
|
Rotate the TODO state of the current item between |
983 |
|
@example |
984 |
|
,-> (unmarked) -> TODO -> DONE --. |
985 |
|
'--------------------------------' |
986 |
|
@end example |
987 |
|
The same rotation can also be done ``remotely'' from the timeline and |
988 |
|
agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}). |
989 |
|
@kindex C-c C-v |
990 |
|
@cindex sparse tree, for TODO |
991 |
|
@item C-c C-v |
992 |
|
View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds |
993 |
|
the entire buffer, but shows all TODO items and the headings hierarchy |
994 |
|
above them. With prefix arg, show also the DONE entries. |
995 |
|
@item C-u C-c a |
996 |
|
A @kbd{C-u} argument to the @code{org-agenda command} (@pxref{Agenda}) |
997 |
|
collects all unfinished TODO items into a single place. |
998 |
|
@end table |
999 |
|
|
1000 |
|
@node TODO extensions, Priorities, TODO basics, TODO items |
1001 |
|
@section Extended use of TODO keywords |
1002 |
|
@cindex extended TODO keywords |
1003 |
|
|
1004 |
|
The default implementation of TODO entries is just two states: TODO |
1005 |
|
and DONE. You can, however, use the TODO feature for more |
1006 |
|
complicated things by configuring the variables |
1007 |
|
@code{org-todo-keywords} and @code{org-todo-interpretation}. Using |
1008 |
|
special setup, you can even use TODO keywords in different ways in |
1009 |
|
different org files. |
1010 |
|
|
1011 |
|
@menu |
1012 |
|
* Workflow states:: From TODO to DONE in steps |
1013 |
|
* TODO types:: I do this, Fred the rest |
1014 |
|
* Per file keywords:: Different files, different requirements |
1015 |
|
@end menu |
1016 |
|
|
1017 |
|
@node Workflow states, TODO types, TODO extensions, TODO extensions |
1018 |
|
@subsection TODO keywords as workflow states |
1019 |
|
@cindex TODO workflow |
1020 |
|
@cindex workflow states as TODO keywords |
1021 |
|
|
1022 |
|
You can use TODO keywords to indicate different states in the process |
1023 |
|
of working on an item, for example |
1024 |
|
|
1025 |
|
@lisp |
1026 |
|
(setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE") |
1027 |
|
org-todo-interpretation 'sequence) |
1028 |
|
@end lisp |
1029 |
|
|
1030 |
|
With this setup, the command @kbd{C-c C-t} will cycle an entry from |
1031 |
|
TODO to FEEDBACK, then to VERIFY, and finally too DONE. You may also |
1032 |
|
use a prefix argument to quickly select a specific state. For example |
1033 |
|
@kbd{C-3 C-c C-t} will change the state immediately to VERIFY. |
1034 |
|
If you define many keywords, you can use in-buffer completion (see |
1035 |
|
@ref{Completion}) to insert these words into the buffer. |
1036 |
|
|
1037 |
|
@node TODO types, Per file keywords, Workflow states, TODO extensions |
1038 |
|
@subsection TODO keywords as types |
1039 |
|
@cindex TODO types |
1040 |
|
@cindex names as TODO keywords |
1041 |
|
@cindex types as TODO keywords |
1042 |
|
|
1043 |
|
The second possibility is to use TODO keywords to indicate different |
1044 |
|
types of action items. For example, you might want to indicate that |
1045 |
|
items are for ``work'' or ``home''. Or, when you work with several |
1046 |
|
people on a single project, you might want to assign action items |
1047 |
|
directly to persons, by using their names as TODO keywords. This |
1048 |
|
would be set up like this: |
1049 |
|
|
1050 |
|
@lisp |
1051 |
|
(setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE") |
1052 |
|
org-todo-interpretation 'type) |
1053 |
|
@end lisp |
1054 |
|
|
1055 |
|
In this case, different keywords do not indicate a sequence, but |
1056 |
|
rather different types. So it is normally not useful to change from |
1057 |
|
one type to another. Therefore, in this case the the behavior of the |
1058 |
|
command @kbd{C-c C-t} is changed slightly@footnote{This is also true |
1059 |
|
for the @kbd{t} command in the timeline and agenda buffers}. When |
1060 |
|
used several times in succession, it will still cycle through all |
1061 |
|
names. But when when you return to the item after some time and |
1062 |
|
execute @kbd{C-c C-t} again, it will switch from each name directly to |
1063 |
|
DONE. Use prefix arguments or completion to quickly select a specific |
1064 |
|
name. |
1065 |
|
|
1066 |
|
@node Per file keywords, , TODO types, TODO extensions |
1067 |
|
@subsection Setting up TODO keywords for individual files |
1068 |
|
@cindex keyword options |
1069 |
|
@cindex per file keywords |
1070 |
|
|
1071 |
|
It can be very useful to use different aspects of the TODO mechanism |
1072 |
|
in different files, which is not possible with the global settings |
1073 |
|
described above. For file-local settings, you need to add special |
1074 |
|
lines to the file which set the keywords and interpretation for that |
1075 |
|
file only. For example, to set one of the two examples discussed |
1076 |
|
above, you need one of the following lines, starting in column zero |
1077 |
|
anywhere in the file: |
1078 |
|
|
1079 |
|
@example |
1080 |
|
#+SEQ_TODO: TODO FEEDBACK VERIFY DONE |
1081 |
|
#+TYP_TODO: Fred Sara Lucy Mike DONE |
1082 |
|
@end example |
1083 |
|
|
1084 |
|
@cindex Completing option keywords |
1085 |
|
@kindex M-@key{TAB} |
1086 |
|
@noindent To make sure you are using the correct keyword, type |
1087 |
|
@samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion. |
1088 |
|
|
1089 |
|
@cindex DONE, final TODO keyword |
1090 |
|
Remember that the last keyword must always mean that the item is DONE |
1091 |
|
(you may use a different word, though). Also note that in each file, |
1092 |
|
only one of the two aspects of TODO keywords can be used. After |
1093 |
|
changing one of these lines, use @kbd{C-c C-c} with the cursor still |
1094 |
|
in the line to make the changes known to Org-mode@footnote{Org-mode |
1095 |
|
parses these lines only when Org-mode is activated after visiting a |
1096 |
|
file. @kbd{C-c C-c} with the cursor in a line starting with @samp{#-} |
1097 |
|
is simply restarting Org-mode, making sure that these changes will be |
1098 |
|
respected.}. |
1099 |
|
|
1100 |
|
If you want to use very many keywords, for example when working with a |
1101 |
|
large group of people, you may split the names over several lines: |
1102 |
|
|
1103 |
|
@example |
1104 |
|
#+TYP_TODO: Fred Sara Lucy Mike |
1105 |
|
#+TYP_TODO: Luis George Jules Jessica |
1106 |
|
#+TYP_TODO: Kim Arnold Peter |
1107 |
|
#+TYP_TODO: DONE |
1108 |
|
@end example |
1109 |
|
|
1110 |
|
@node Priorities, , TODO extensions, TODO items |
1111 |
|
@section Priorities |
1112 |
|
@cindex priorities |
1113 |
|
|
1114 |
|
If you use Org-mode extensively to organize your work, you may end up |
1115 |
|
with a number of TODO entries so large that you'd like to prioritize |
1116 |
|
them. This can be done by placing a @emph{priority cookie} into the |
1117 |
|
headline, like this |
1118 |
|
|
1119 |
|
@example |
1120 |
|
*** TODO [#A] Write letter to Sam Fortune |
1121 |
|
@end example |
1122 |
|
|
1123 |
|
@noindent |
1124 |
|
With its standard setup, Org-mode supports priorities @samp{A}, |
1125 |
|
@samp{B}, and @samp{C}. @samp{A} is the highest priority. An entry |
1126 |
|
without a cookie is treated as priority @samp{B}. Priorities make a |
1127 |
|
difference only in the agenda (@pxref{Agenda}). |
1128 |
|
|
1129 |
|
@table @kbd |
1130 |
|
@kindex @kbd{C-c ,} |
1131 |
|
@item @kbd{C-c ,} |
1132 |
|
Set the priority of the current item. The command prompts for a |
1133 |
|
priority character @samp{A}, @samp{B} or @samp{C}. When you press |
1134 |
|
@key{SPC} instead, the priority cookie is removed from the headline. |
1135 |
|
The priorities can also be changed ``remotely'' from the timeline and |
1136 |
|
agenda buffer with the @kbd{,} command (@pxref{Agenda commands}). |
1137 |
|
|
1138 |
|
@kindex S-@key{up} |
1139 |
|
@kindex S-@key{down} |
1140 |
|
@item S-@key{up} |
1141 |
|
@itemx S-@key{down} |
1142 |
|
Increase/decrease priority of current item. Note that these keys are |
1143 |
|
also used to modify time stamps (@pxref{Creating timestamps}). |
1144 |
|
@end table |
1145 |
|
|
1146 |
|
|
1147 |
|
|
1148 |
|
@node Timestamps, Timeline and Agenda, TODO items, Top |
1149 |
@chapter Timestamps |
@chapter Timestamps |
1150 |
|
|
1151 |
Items can be labeled with timestamps to make them useful for project |
Items can be labeled with timestamps to make them useful for project |
1445 |
@end example |
@end example |
1446 |
@noindent |
@noindent |
1447 |
After changing this line, press @kbd{C-c C-c} with the cursor still in |
After changing this line, press @kbd{C-c C-c} with the cursor still in |
1448 |
the line, to make the changes know to org-mode. Otherwise, the change |
the line, to make the changes known to org-mode. Otherwise, the |
1449 |
will only be active the next time you visit this file with Emacs. |
change will only be active the next time you visit this file with |
1450 |
|
Emacs. |
1451 |
|
|
1452 |
The display in the agenda buffer looks best if the category is no |
The display in the agenda buffer looks best if the category is not |
1453 |
longer than 10 characters. |
longer than 10 characters. |
1454 |
|
|
1455 |
@subsection Sorting of agenda items |
@subsection Sorting of agenda items |
2109 |
@cindex acknowledgments |
@cindex acknowledgments |
2110 |
|
|
2111 |
Org-mode was written by Carsten Dominik, who still maintains it at the |
Org-mode was written by Carsten Dominik, who still maintains it at the |
2112 |
Org-mode homepage |
Org-mode homepage @uref{http://www.astro.uva.nl/~dominik/Tools/org/}. |
2113 |
@uref{http://www.astro.uva.nl/~dominik/Tools/org/}. The following |
The following people have helped the development along with ideas, |
2114 |
people have helped the development along with ideas, suggestions and |
suggestions and patches. |
|
patches. |
|
2115 |
|
|
2116 |
@itemize @bullet |
@itemize @bullet |
2117 |
@item |
@item |
2142 |
@item |
@item |
2143 |
Carsten Wimmer suggested some changes and helped fix a bug in linking |
Carsten Wimmer suggested some changes and helped fix a bug in linking |
2144 |
to GNUS. |
to GNUS. |
2145 |
|
@item |
2146 |
|
Stefan Monnier provided a patch with lots of little fixes to keep the |
2147 |
|
Emacs-Lisp compiler happy. |
2148 |
@end itemize |
@end itemize |
2149 |
|
|
2150 |
@node Bugs, , Acknowledgments, Miscellaneous |
@node Bugs, , Acknowledgments, Miscellaneous |
2187 |
|
|
2188 |
@bye |
@bye |
2189 |
|
|
2190 |
|
|
2191 |
@ignore |
@ignore |
2192 |
arch-tag: 7893d1fe-cc57-4d13-b5e5-f494a1bcc7ac |
arch-tag: 7893d1fe-cc57-4d13-b5e5-f494a1bcc7ac |
2193 |
@end ignore |
@end ignore |